Skip to main content

Card Payment Instrument

Card Payment Instrument.

idstring

The instrument id

customerIdstring

The customer to which this instrument belongs.

Example: 5435323362
instrumentTypeInstrumentType (string)required

Represents the type of the instrument.

ValueDescription
SEPA_BANK_ACCOUNTSEPA Bank account
UK_BANK_ACCOUNTUK Bank account
US_BANK_ACCOUNTUS Bank account
CCI_BANK_ACCOUNTCCI Bank account
CARDCard

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

Example: CARD
externallyVerifiedboolean

Is the instrument externally verified.

Default value: false
statusstring

The instrument status.

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

creationTimestring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
panstringrequired

Card number.

cardHolderNamestring

Card holder name.

Possible values: <= 160 characters

bankNamestring

The bank name.

expiryDate objectrequired

Card expiry date.

yearintegerrequired
monthintegerrequired
cardSchemeCardScheme (string)

Card scheme information.

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

Possible values: [VISA, MC]

descriptionstring

Name to be associated with the card.

Possible values: <= 20 characters

Card Payment Instrument
{
  "id": "string",
  "customerId": "5435323362",
  "instrumentType": "CARD",
  "externallyVerified": false,
  "status": "VERIFIED",
  "creationTime": "2021-07-15T17:54:12Z",
  "pan": "string",
  "cardHolderName": "string",
  "bankName": "string",
  "expiryDate": {
    "year": 0,
    "month": 0
  },
  "cardScheme": "VISA",
  "description": "string"
}