Praxis Wiki logo

Get Customer Cards API {get-customer-cards}


API call for merchants to get the list of saved credit cards to provide an ability to render the list on merchant's side.

{danger.fa-exclamation} The method was extended with mit_transactions object, so from now on if you use MIT, within the response you'll fetch the list of successful MIT initial transactions (mit_reference_id) per specific customer.

Endpoints

Name URL
Sandbox https://pci-gw-test.praxispay.com/agent/get-customer-cards
Live https://gw.praxisgate.com/agent/get-customer-cards

Request Parameters

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable Type Description
merchant_id varchar(50) Merchant API client account identifier
application_key varchar(32) Identifier of your application (website)
cid varchar(50) Unique customer id in your system
version varchar(3) API version
timestamp int(11) Request time (unix timestamp, seconds)

Response Parameters

Variable Type Description
status int API communication status - for transaction processing status please refer to transaction.transaction.status
- 0 if the request was successful
- Negative integer if internal server/network error occurs
- Positive integer if application/logical error occurs
description varchar(256) Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
customer_cards <Object> Customers cards list
version varchar(3) API version
timestamp int(11) Response time (unix timestamp, seconds)

Signature

The full signature generation algorithm can be found in the Authentication section.

Request signature parameters

  1. merchant_id
  2. application_key
  3. timestamp
  4. cid

Response signature parameters

  1. status
  2. timestamp

Customer Cards List Response Example

{
    "customer_cards" : [
        {
            "card_token": "af7d1b07c48fbeff116b2bb3e84fb4c9",
            "card_number": "491694******1514",
            "card_holder": "John Doe",
            "card_exp": "12/2022",
            "card_type": "VISA",
            "card_issuer_name": "Random Bank, London",
            "card_issuer_country": "GB",
            "is_default": 0,
            "mit_transactions": [
                {
                    "expired_at": 16823433429,
                    "trace_id": 10034325235,
                    "gateway": "feBn6ooVgTwEjT4zTdq-5zQZZ18ThFoE",
                    "transaction_type": "authorization"
                }
            ]
        },
        {
            "card_token": "c7f9a2c6f4288e8c40f2a6602a64b6742",
            "card_number": "512124******5468",
            "card_holder": "Jane Doe",
            "card_exp": "05/2025",
            "card_type": "MasterCard",
            "card_issuer_name": "Central Bank, Cyprus",
            "card_issuer_country": "CY",
            "is_default": 1,
            "mit_transactions": [
                {
                    "expired_at": 16823432423,
                    "trace_id": 10089231233,
                    "gateway": "87cfb23a8f1e68e162c276b754d9c061",
                    "transaction_type": "sale"
                }
            ]
        }
    ]
}