Enrol Data

The Enrol Data endpoint enables you to register a cardholder to use Click to Pay.

You can register a cardholder to Click to Pay by making a POST request to the Enroll Data endpoint. For example:

{{base-url}}/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": "[email protected]",
        "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"
}

👍
More Information

For information on the fields in the request and response, see Enrol Data - Field Descriptions.

To view the endpoint in the API Explorer, see Enrol Data.

👍More Information

👍
More Information