Get Payment Instrument

GET 
/v2/customers/:customerId/instruments/:instrumentType/:instrumentId

Returns single instrument with specific type and identifier.

Request

Path Parameters

instrumentId stringrequired

The id of the instrument

instrumentType InstrumentTyperequired

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

Instrument type.

customerId stringrequired

Responses

200

OK

application/json

Schema

Schema

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

any

SEPA_BANK_ACCOUNT

any

UK_BANK_ACCOUNT

any

US_BANK_ACCOUNT

any

CCI_BANK_ACCOUNT

any

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_INSTRUMENT

{
  "id": "2323213",
  "customerId": "500001",
  "instrumentType": "UK_BANK_ACCOUNT",
  "accountHolderName": "John Doe",
  "accountNumber": "77xxxxx464",
  "sortCode": "RABO",
  "status": "VERIFIED"
}

Loading...