Get Payment Instruments

GET 
/v2/customers/:customerId/instruments

Retrieve list of active instruments for the customer.

It returns one of the following instrument objects:

• SEPA Bank Account
• UK Bank Account
• US Bank Account
• Card

You can filter out the response by instrument type or payment option.

For cards, the PAN will be returned masked in the format 5xxxxxxxxxxx2922. For bank accounts, the IBAN will be returned masked in the format NL94xxxxxxxxxxx464 and the bank account number will be returned masked in the format 77xxxxx464. Supported instrument types are dependent on the customer country and enabled payment options.

The instruments can be used for Deposit and Withdrawal operations. Only VERIFIED instruments can be used for withdrawal.

Instrument verification can be done by the following means:

• Bank wire (SEPA, Faster Payments) deposit using the instrument
• Manual, by submitting bank statement to Paysafe team
• Paysafe instrument verification flow via third party provider. For more details see Start Instrument Verification

All this instrument verification flows confirm, that the owner of the instrument and the wallet is the same.

Request

Path Parameters

customerId stringrequired

Query Parameters

instrumentType InstrumentType

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Instrument type filter.

paymentOption PaymentOptionType

Possible values: [RAPID_TRANSFER, BANK_TRANSFER, OFFLINE_BANK_TRANSFER, CARD, PAYSAFECASH, PAGO_EFECTIVO]

Payment option filter.

Responses

200

OK

application/json

Schema

Schema

• Array [

id string

The instrument id

customerId string

Customer to which this instrument belongs.

instrumentType

string

required

Possible values: [CARD, SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

Instrument type.

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

pan stringrequired

Card Number

cardHolderName string

Possible values: <= 160 characters

Card holder name.

bankName string

Bank name.

expiryDate

object

required

Card expiry date.

year integerrequired

month integerrequired

cardScheme CardScheme (string)

Possible values: [VISA, MC]

Card scheme information.

• VISA - VISA
• MC - Mastercard The scheme is derived from the card PAN.

description string

Possible values: <= 20 characters

Name to be associated with the card.

SEPA_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

iban stringrequired

The International Bank Account Number (IBAN) of the account.

bic stringrequired

The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

bankName string

Bank name.

UK_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

accountNumber stringrequired

A bank account number.

sortCode stringrequired

Use our sort code checker to easily find and check UK sort codes.

bankName string

Bank name.

US_BANK_ACCOUNT

accountHolderName string

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.

accountNumber stringrequired

Possible values: >= 4 characters and <= 17 characters

This is the bank account number.

routingNumber stringrequired

Possible values: >= 9 characters and <= 9 characters

For USD accounts, this is the 9-digit routing number of the bank.

bankName string

Bank name.

accountType string

Possible values: [SAVINGS, CHECKING, LOAN]

CCI_BANK_ACCOUNT

accountNumber stringrequired

Possible values: >= 20 characters and <= 20 characters

A bank account number (Código de Cuenta Interbancario), has 20 digits

externallyVerified booleandeprecated

Is the instrument externally verified. The property is not returned by the API anymore.

status string

Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

Instrument status.

creationTime date-time

Represents RFC 3339, section 5.6 date-time.

• ]

Example (from schema)

[
  {
    "id": "string",
    "customerId": "5435323362",
    "instrumentType": "CARD",
    "status": "VERIFIED",
    "creationTime": "2021-07-15T17:54:12Z"
  }
]

GET_PAYMENT_INSTRUMENTS

[
  {
    "id": "1100000000000006",
    "customerId": "5000001",
    "instrumentType": "UK_BANK_ACCOUNT",
    "accountHolderName": "John Doe",
    "accountNumber": "77xxxxx464",
    "sortCode": "RABO",
    "status": "VERIFIED"
  },
  {
    "id": "1100000000000007",
    "customerId": "5000001",
    "instrumentType": "SEPA_BANK_ACCOUNT",
    "accountHolderName": "John Doe",
    "iban": "NL94xxxxxxxxxxx464",
    "bic": "RABONL2U",
    "status": "VERIFIED"
  },
  {
    "id": "1100000000000009",
    "customerId": "5000001",
    "instrumentType": "CARD",
    "cardHolderName": "John Doe",
    "pan": "5xxxxxxxxxxx1012",
    "expiryDate": {
      "year": 2023,
      "month": 10
    },
    "status": "UNVERIFIED"
  }
]

GET_US_BANK_ACCOUNTS

[
  {
    "id": "3453",
    "customerId": "string",
    "instrumentType": "US_BANK_ACCOUNT",
    "accountNumber": "12xxx287",
    "routingNumber": "217336444",
    "status": "VERIFIED"
  }
]

Loading...