Card Object

The Card object represents the card attached to an external Financial Account, such as a debit card or credit card.

Attributes

firstName

string, max length: 40, min length: 1

First name of the Customer or Recipient, as it appears on the card.

middleName

string, max length: 40, min length: 1

Middle name of the Customer or Recipient, as it appears on the card.

lastName

string, max length: 40, min length: 1

Last name of the Customer or Recipient, as it appears on the card.

cardNumberTail

string, max length: 4

Last 4 digits of the card number.

expiry

string, required format: YYYY-MM

Expiry date for the card.

billingAddress

object

Billing address for the card.

addressLine1

string, max length: 50, min length: 1

Address line 1.

addressLine2

string, max length: 50, min length: 1

Address line 2.

addressLine3

string, max length: 50, min length: 1

Address line 3.

city

string, max length: 25, min length: 1

City.

stateCode

string, max length: 3, min length: 2

State, province, or territory. Required if country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO and Ontario is ON.

countryCode

string, max length: 3, min length: 3

Country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

postalCode

string, max length: 10, min length: 1

ZIP code or postal code. For US addresses, must be a valid value of 5 digits (example: 63368) or 5 digits-4 digits (example: 63368-5555). Can be alphanumeric for other countries.

Card Object

				
					{
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "cardNumberTail": "4242",
    "expiry": "2027-12",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "stateCode": "BC",
      "countryCode": "CAN",
      "postalCode": "V5K 0A1"
    }
  }
}