Common Responses for the object.
Response Parameters
Property | Description |
---|---|
ID | Unique identifier of the record. |
card_number_ending | Typically the last four digits of the long card number. |
card_type | The card association for the card. Visa, Amex, etc. |
created_at | Datetime formatted as ISO8601. |
custom_referance | Custom reference set on the record. |
customer_id | ID of the parent customer record. |
expiry_date | Expiry date of the card - 10 digit date in the format of “YYYY-MM-DD” (last day of month). |
gateway_payment_description | A description of payment that is passed onto the gateway and may be shared with the customer. |
internal_payment_description | A description of payment that is only for 'office use' and not shared with a customer. |
metadata | Returns optional, custom, metadata, if set |
name_on_card | The name of the person who owns the card. |
payment_gateway | The name of the payment gateway used to register the card. |
status | Status of the Record. |
transaction_type | What type of transaction took place. For example: Ecommerce or MOTO. |
Response Sample
{ "cards": [ { "ID": "20477d89-9fe4-4b25-ae57-c24f461bb391", "card_number_ending": "0014", "card_type": "Visa", "created_at": "2022-05-16T16:54:13Z", "custom_referance": "", "customer_id": "FTBCUST00035740", "expiry_date": "2022-02-28", "gateway_payment_description": "", "internal_payment_description": "", "name_on_card": "", "payment_gateway": "OpayoPi", "status": "successful", "transaction_type": "MOTO", "metadata":"" }, { "ID": "bdc9ca6c-c01c-4d43-b8af-fa3fa990e417", "card_number_ending": "5559", "card_type": "Visa", "created_at": "2022-05-17T11:48:20Z", "custom_referance": "", "customer_id": "FTBCUST00035740", "expiry_date": "2012-01-31", "gateway_payment_description": "", "internal_payment_description": "", "name_on_card": "", "payment_gateway": "OpayoPi", "status": "successful", "transaction_type": "MOTO", "metadata":"" } ] }