Customer Enquiry

The Customer Enquiry endpoint enables you to return a list of cards associated with a customer.

📘
Note
The Customer Enquiry endpoint does not return the details of archived cards associated with the customer name.

You can get the details for a customer by making a POST request to the Customer Enquiry endpoint. For example:

{{base-url}}/ws/api/v1/WS_Customer_Enquiry

The request body must include one of the following fields in the request to identify the customer you want to view the details for.

PAN where you know the 16-digit PAN of the card.
PublicToken where you know the 9-digit public token for the card.
CustAccount where you know the cardholder account number or reference number.

See the following example of a Customer Enquiry request where the public token is included in the request, along with IssCode, and ItemSrc, which are required fields.

{
  
"IssCode":"PMT",
"PublicToken": "120398473",
"ItemSrc": 0
  
}

If successful, a 200 response is returned. See the below example:

{
    "IssCode": "PMT",
    "TxnCode": "4",
    "PublicToken": "120398473",
    "CustAccount": "Mode 4 token",
    "CurCode": "GBP",
    "ActionCode": "000",
    "Primary": null,
    "Cards": {
        "CardList2": [
            {
                "PAN": "9999999894639225",
                "ExpDate": "2026-03-04",
                "CurCode": "GBP",
                "StatCode": "02",
                "CrdProduct": "MCRD",
                "Program": "PMTCGP",
                "DesignRef": "PMTCGP",
                "EmbossName": "Mr John Bloggs",
                "AvlBal": "100.00",
                "BlkAmt": "10.00",
                "FirstName": "John",
                "LastName": "Bloggs",
                "CustType": null,
                "PublicToken": "120398473",
                "Primary": "Y",
                "IsLive": 0,
                "Scheme": "GPS SCHEME TEST",
                "Product": "Test UK",
                "MCCGroup": null,
                "LimitGroup": "PMT-VL-003",
                "PERMSGroup": "PMT-CU-003",
                "FeeGroup": null,
                "SchedFeeGroup": null,
                "WsFeeGroup": null,
                "LinkageGroup": null,
                "PrimaryToken": "120398473",
                "MaskedPAN": "9999999894639225",
                "ProductID": "10006",
                "ProductRef": "PMTCGP",
                "AuthCalendarGroup": null,
                "FXGroup": "GPS-FX-001",
                "PaymentTokenUsageGroup": "20-GPS Dummy",
                "StartDate": "03/25",
                "EndDate": "02/35"
            }
        ]
    }
}

Updated 7 days ago

📘Note

📘
Note