Click to Pay

Click to Pay functionality is only available for Visa customers.

Click to Pay is a service that Issuers can register their cardholders for so they can have a frictionless online experience during checkout. Cards that are enrolled for Click to Pay can then use this at the checkout of an online retailer, where the merchant uses the cardholder's name and email/phone number to display cardholders registered cards. Thredd approves all Click to Pay tokenisation requests if Click to Pay is selected on your PSF.

Click to Pay uses the token instead of the card PAN at checkout, and avoids manual card entry for the cardholder. It also means there is a lower security risk, as the merchant never sees the cardholder's card details.

Figure 17: Flow diagram displaying how Click to Pay works

You can enrol cardholders onto Click to Pay using the Enrol Data endpoint. This endpoint enables Thredd to register the new cardholder, phone number, email, and card linked to their token. If you want to add additional details to a previously enrolled card, you can use the Enrol Payment Instruments endpoint. Note you must register the cardholder using the Enrol Data endpoint before you can use the Enrol Payment Instruments endpoint.

Enrol Data

The Enrol Data endpoint enables you to register a cardholder to use Click to Pay by making a POST request to the Enrol Data endpoint. For example:

{{base-url}}/ctp/api/v1/enrolldata

The POST body should include the details of the customer and their publicToken. The below is an example of what the body should look like:

{
  "customers": [
    {
      "customerDetails": {
        "billingAddress": {
          "city": "San Francisco",
          "state": "CA",
          "country": "USA",
          "postalCode": "94105",
          "addressLine1": "1000 Market Street",
          "addressLine2": "Building 56",
          "addressLine3": "Suite 101"
        },
        "customerReferenceId": "ImACustomer",
        "email": "jbloggs@email.com",
        "phone": "16504005555",
        "firstName": "John",
        "middleName": "Robert",
        "lastName": "Bloggs",
        "nationalIdentifiers": [
          {
            "type": "PASSPORT",
            "value": "A123456"
          }
        ]
      },
      "pubTokens": [
        {
          "value": "123456789"
        }
      ]
    }
  ]
}

If successful, a 202 response is returned with the unique requestTraceId. See the following example of a successful response.

{
  "requestTraceId": "351562ba-83cf-11ee-b962-0242ac120002"
}

For more information on the Enrol Data endpoint, see Enrol Data and Enrol Data - Field Descriptions.

Enrol Payment Instruments

The Enrol Payment Instruments endpoint enables you to add more Click to Pay details to a card, such as the billing address and your unique customer reference identifier.

You can add more Click to Pay details to a card by making a POST request to the Enrol Payment Instruments endpoint. For example:

{{base-url}}/ctp/api/v1/enrollpaymentinstruments

The POST body should include the details of the customer, their publicToken and their billing address. The below is an example of what the body should look like.

{
  "billingAddress": {
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "postalCode": "94105",
    "addressLine1": "1000 Market Street",
    "addressLine2": "Building 56",
    "addressLine3": "Suite 101"
  },
  "customerReferenceId": "ImACustomer",
  "pubTokens": [
    {
      "value": "123456789"
    }
  ]
}

If successful, a 202 response is returned with the unique requestTraceId. See the following example of a successful response.

{
  "requestTraceId": "351562ba-83cf-11ee-b962-0242ac120002"
}

For more information on the Enrol Payment Instruments endpoint, see Enrol Payment Instruments and Enrol Payment Instruments - Field Descriptions.