Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Visa Click2Pay Enrol and Manage

Enrol a Cardholder and a Card in C2P

Send a request to this endpoint to enrol a cardholder in Click to Pay and add a card to the account. You may override the cardholder’s email address and phone number, by using the field overrides. If you provide cardOverrides, the billing address fields present in cardOverrides override the corresponding values sent to Visa for this request. Any billing address fields omitted from cardOverrides fall back to the existing stored cardholder data. If cardOverrides is omitted entirely, the existing stored cardholder data is used for all billing address fields. If the request is successful, Visa returns a unique request ID (requestTraceId).

Please note that this endpoint submits data to Visa Click to Pay and some fields, especially the card billing address, are validated according to Visa requirements. These validations may be stricter than Enfuce API validations. For example, billing address lines must not exceed 64 characters, and certain special characters are not allowed. Enfuce does not automatically modify address data before submitting it to Visa, so requests may fail if the provided billing address does not meet Visa’s requirements.

Billing address restrictions

For Click to Pay enrolment, Visa applies the following restrictions to billing address fields:

  • addressLine1-addressLine3: maximum 64 characters each
  • city: maximum 32 characters
  • postalCode: maximum 9 characters
  • country: 3-character ISO 3166 alpha-3 code when provided
  • The following characters are not allowed: [, ], {, }, :, &, $, ^, !, =, ;, *, #, backtick, <, >, ", ”
  • The @ character is not allowed in billing address fields.
post/v1/click2pay/VISA/enroll/customer/{customerId}

Path parameters

customerIdstring biginteger required

Unique identifier of the customer. You have received this via the Customer API.

Query parameters

auditUserstring required

The audit user to log the request

Request body

cardIdstring[] required

Unique identifier of the card type you want to enrol in C2P. You have received this via the Card API. Note: If you send multiple card IDs, the request fails and returns an error.

customerBIDstring required

Unique identifier assigned to each issuer. Note: If you are using our BIN sponsorship, we provide you the customerBID; else, Visa provides you the customerBID.

Example request

{
  "cardId": [
    "123456789"
  ],
  "customerBID": "123456",
  "overrides": {
    "emails": [
      "alex123@hotmail.com"
    ],
    "phones": [
      "16504005555"
    ]
  },
  "cardOverrides": {
    "addressLine1": "1000 Market Street",
    "addressLine2": "Building 56",
    "city": "San Francisco",
    "postalCode": "94105",
    "country": "USA"
  }
}

Response

Accepted

requestTraceIdstring uuid required

Unique identifier of the request

Example response

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