Get Payment Instrument Information

📘
Important
The Get Payment Instrument Information is for Mastercard only.

The Get Payment Instrument Information endpoint enables you to return information on a payment instrument for a card enrolled onto Click to Pay. A payment instrument refers to the method or device through which a consumer can make a payment using the Click to Pay service.

You can return payment instrument information by making a GET request to the Get Payment Instrument Information endpoint, including the customerReferenceId and publicToken. For example:

{{base-url}}/ctp/api/v1/paymentinstrument/{customerReferenceId}/{publicToken}

If successful, a 200 response is returned with details of the payment instrument. For example,

{
  "intent": {
    "type": "PRODUCT_CODE",
    "value": "CLICK_TO_PAY"
  },
  "paymentInstrument": {
    "type": "CARD",
    "cardType": "CREDIT",
    "status": "ACTIVE",
    "issuerName": "Bank A",
    "nameOnCard": "John Doe",
    "accountNumber": "4111111145551140",
    "tokenDetails": {
      "tokenReferenceId": "DM4MMC1US0000000a8513863213e4f1b99e4d016b4f61624"
    },
    "billingAddress": {
      "city": "San Francisco",
      "state": "CA",
      "country": "USA",
      "postalCode": "94105",
      "addressLine1": "1000 Market Street",
      "addressLine2": "Building 56",
      "addressLine3": "Suite 101"
    },
    "expirationDate": "2030-01",
    "paymentAccountReference": "5001DW4DS6FRSHVXVBC7HVP6JYAS6"
  }
}

📘
Information

To view this endpoint in the API Explorer, see Get Payment Instrument Data.

To view information on the fields for this endpoint, see Get Payment Instrument Information - Field Descriptions.

Updated 9 days ago