Get Click to Pay Data

The Get Click to Pay Data endpoint enables you to return the outcome of a Click to Pay registration, reflecting the latest status returned from the Click to Pay service.

You can get Click to Pay Data by making a GET request to the Get Click to Pay Data endpoint, including the customer reference number in the URL. For example:

https://uat-api.thredd.com/ctp/api/v1/consumerinformation/{customerReferenceId}

If successful, a 200 response is returned with details of the Click to Pay registration. For example:

{
  "intent": {
    "type": "PRODUCT_CODE",
    "value": "CLICK_TO_PAY"
  },
  "paymentInstruments": [
    {
      "type": "CARD",
      "cardType": null,
      "issuerName": "Bank A",
      "nameOnCard": "John Doe",
      "accountNumber": "123456789",
      "billingAddress": {
        "city": "San Francisco",
        "state": "CA",
        "country": "USA",
        "postalCode": "94105",
        "addressLine1": "1000 Market Street",
        "addressLine2": "Building 56",
        "addressLine3": "Suite 101"
      },
      "expirationDate": "2030-01"
    }
  ],
  "consumerInformation": {
    "emails": [
      "[email protected]",
      "[email protected]"
    ],
    "locale": "en_Us",
    "phones": [
      "+442071234567"
    ],
    "status": "ACTIVE",
    "consent": {
      "version": "1.0",
      "presenter": "Bank A",
      "timeOfConsent": "2025-08-01T11:01:12.9440000Z"
    },
    "lastName": "Doe",
    "firstName": "John",
    "middleName": "Michael",
    "countryCode": "USA",
    "nationalIdentifiers": [
      {
        "type": "PASSPORT",
        "value": "A123456"
      }
    ],
    "externalConsumerID": "63421837-d597-4f0f-89e4-930c1a7b9e85",
    "externalConsumerIDOwnerBID": "10098765"
  }
}

📘
More Information

To view this endpoint in the API Explorer, see Get Click to Pay Data.

To view field descriptions for this endpoint, see Get Click to Pay Data - Field Descriptions.

Updated about 24 hours ago

Did this page help you?