Enrol Payment Instruments

The Enroll Payment Instruments endpoint enables you to add more details to a card to use Click to Pay.

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

{{base-url}}/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"
}

👍

More Information

• For information on the fields in the request and response, see Enroll Payment Instruments - Field Descriptions.
• To view the endpoint in the API Explorer, see Enroll Payment Instruments.