API Reference

Attributes

id string(36)
Unique identifier for the object.


code string(36)
Unique identifier for the object in your system.


firstSixDigits string(6)
The first six digits of the credit card.


lastFourDigits string(4)
The last four digits of the credit card.


holderName string(64)
The holderName field represents the name of the credit card owner as it appears on the card.


brand string(16)
The brand field indicates the credit card network or provider, such as Visa, Mastercard, or American Express.


expMonth number
The expMonth field represents the expiration month of the credit card, formatted as a two-digit number (e.g., “01” for January).


expYear number
The expYear field represents the expiration year of the credit card, formatted as a two-digit number (e.g., “24”).


metadata Metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Example

{
   "id":"de9672dc-4e97-40cc-aea5-11ed43bb80a1",
   "code": "c046b9a5-b7cf-449a-9bc8-121b500b4dfc",
   "firstSixDigits":"488662",
   "lastFourDigits":"6261",
   "holderName":"BRUCE WAYNE",
   "brand":"VISA",
   "expMonth":8,
   "expYear":29,
   "metadata": [
      {
        "name": "CUSTOM_FIELD_NAME", 
        "value": "CUSTOM_FIELD_VALUE"
      }
    ]
}