Add payment instrument to a wallet
POST/customers/:customerId/instruments
Add Payment Instrument. This operation has the following limitations:
- Works only for Legal Entities. Regular customers can not add instuments
- Supports UkBankAccount and SepaBankAccount
- The instrument is created in status
UNVERIFIED
and can not be used for deposit or withdrawal until proper bank statement is submitted. - When the required bank statement are submitted through
PATCH /customer-legal-entities/{customerId}
and verified by Paysafe team, the instrument will be approved.
Request
Path Parameters
Id of the customer to fetch instruments for
- application/json
Body
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
- VISA - VISA
- MC - Mastercard The scheme is derived from the card PAN.
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
Represents the type of the instrument.
Value | Description |
---|---|
SEPA_BANK_ACCOUNT | SEPA Bank account |
UK_BANK_ACCOUNT | UK Bank account |
US_BANK_ACCOUNT | US Bank account |
CCI_BANK_ACCOUNT | CCI Bank account |
CARD | Card |
Card number.
Possible values: <= 160 characters
Card holder name.
The bank name.
expiryDate
object
required
Card expiry date.
Possible values: [VISA
, MC
]
Card scheme information.
Possible values: <= 20 characters
Name to be associated with the card.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
The bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The bank account number.
Use our sort code checker to easily find and check UK sort codes.
The bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account. As per regulations, the Wallet holder and bank account holder must be the same.
Possible values: >= 4 characters
and <= 17 characters
The bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
The bank name.
Possible values: [SAVINGS
, CHECKING
, LOAN
]
The account type.
Possible values: >= 20 characters
and <= 20 characters
The bank account number (Código de Cuenta Interbancario), has 20 digits.
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
The instrument status.
Represents RFC 3339, section 5.6 date-time.
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- ADD_PAYMENT_INSTRUMENT_RESPONSE
Schema
- CARD
- SEPA_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- US_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
- VISA - VISA
- MC - Mastercard The scheme is derived from the card PAN.
The instrument id
The customer to which this instrument belongs.
instrumentType
string
required
Possible values: [CARD
, SEPA_BANK_ACCOUNT
, UK_BANK_ACCOUNT
, US_BANK_ACCOUNT
, CCI_BANK_ACCOUNT
]
Represents the type of the instrument.
Value | Description |
---|---|
SEPA_BANK_ACCOUNT | SEPA Bank account |
UK_BANK_ACCOUNT | UK Bank account |
US_BANK_ACCOUNT | US Bank account |
CCI_BANK_ACCOUNT | CCI Bank account |
CARD | Card |
Card number.
Possible values: <= 160 characters
Card holder name.
The bank name.
expiryDate
object
required
Card expiry date.
Possible values: [VISA
, MC
]
Card scheme information.
Possible values: <= 20 characters
Name to be associated with the card.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The International Bank Account Number (IBAN) of the account.
The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.
The bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account.
The bank account number.
Use our sort code checker to easily find and check UK sort codes.
The bank name.
Possible values: <= 100 characters
This is the name of the customer or company that owns the bank account. As per regulations, the Wallet holder and bank account holder must be the same.
Possible values: >= 4 characters
and <= 17 characters
The bank account number.
Possible values: >= 9 characters
and <= 9 characters
For USD accounts, this is the 9-digit routing number of the bank.
The bank name.
Possible values: [SAVINGS
, CHECKING
, LOAN
]
The account type.
Possible values: >= 20 characters
and <= 20 characters
The bank account number (Código de Cuenta Interbancario), has 20 digits.
Is the instrument externally verified. The property is not returned by the API anymore.
Possible values: [VERIFIED
, UNVERIFIED
, VERIFICATION_REQUIRED
, REJECTED
]
The instrument status.
Represents RFC 3339, section 5.6 date-time.
{
"id": "string",
"customerId": "5435323362",
"instrumentType": "CARD",
"status": "VERIFIED",
"creationTime": "2021-07-15T17:54:12Z"
}
{
"id": "2323213",
"customerId": "5435323362",
"instrumentType": "SEPA_BANK_ACCOUNT",
"accountHolderName": "John Doe",
"iban": "NL94RABO7762494464",
"bic": "RABONL2U",
"status": "UNVERIFIED"
}