Get wallet payment instruments

GET 
/instruments

deprecated

Retrieve list of active instruments for the customer.

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.

This API is deprecated! Use the alternative /customers/{customerId}/instruments instead.

Request

Query Parameters

customerId stringrequired

Id of the customer to fetch instruments for

Responses

200

OK

application/json

Schema

Schema

• Array [

id string

The instrument id

customerId string

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

pan stringrequired

Card number.

cardHolderName string

Possible values: <= 160 characters

Card holder name.

bankName string

The 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

The 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

The bank account number.

sortCode stringrequired

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

bankName string

The 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

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

The bank name.

accountType string

Possible values: [SAVINGS, CHECKING, LOAN]

The account type.

CCI_BANK_ACCOUNT

accountNumber stringrequired

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

The 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]

The 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",
    "description": "My MC card"
  }
]

Loading...