RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Card Object

The Card object represents the card attached to a card-based Financial Account, such as a Mastercard or Visa debit card.

Attributes

firstName

string, max length: 40, min length: 1

Recipient’s first name as it appears on the card.

middleName

string, max length: 40, min length: 1

Recipient’s middle name as it appears on the card.

lastName

string, max length: 40, min length: 1

Recipient’s last name as it appears on the card.

type  

string enum, values: DEBIT

Type of card.

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.

state  

string, max length: 3, min length: 2

State, province, or territory. Required if country is USD or CA. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO.

country

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.

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.

cardNumber  

string, max length: 19, min length: 11, pattern: [\d]{11,19}

Card number.

The Card Object

				
					{
  "card": {
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": "2027-12",
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumber": "84563876999"
  }
}