Visa Click to Pay

Issuers

Start a Project Start a Project API Overview API Overview API Reference API Reference
Navigate to...
keyboard_arrow_down

Implementation Steps

Introduction

The following section provides a step-by-step guide to get you started.

Step 1 - Access to APIs

Please contact your Visa representative. They will set up your credentials and notify you upon completion.

Step 2 - API Implementation

You are required to implement the APIs listed below. These are documented in the How to Enroll and Manage Customer Data' section, with usage guidance provided in the 'Issuer Use Cases' section.

  1. Enroll Data (POST /v1/enrollData)
  2. Enroll Payment Instruments (POST /v1/enrollPaymentInstruments)
  3. Manage Consumer Information (PUT /v1/manageConsumerInformation)
  4. Manage Payment Instrument Data (PUT /v1/managePaymentInstruments)
  5. Get Data (POST /v1/getData)
  6. Delete Consumer Information (POST /v1/deleteConsumerInformation)
  7. Delete Payment Instrument Data (POST /v1/deletePaymentInstruments)
  8. Request Status by Request Trace ID (GET /v1/requestStatus/{requestTraceId})
  9. Click to Pay Enrollment Attempt Notifications (POST / {Issuer Endpoint}/vtis/v1/tokenRequestors/{tokenRequestorID}/cardEnrollment/notification?eventType=CTP_ENROLLMENT_ATTEMPT)

For more information on the usage of each of the APIs, please refer to the ‘Available Endpoints section’ in the How to Enroll and Manage Customer Data section.

Authentication and Encryption

Authentication

It is required to either use X-Pay-Token or Mutual Authentication (Two-Way SSL) for the APIs listed above. 

Contact your visa representatives for an understanding of how to obtain credentials and work with X-Pay-Token. 

For a quick understanding of how to obtain credentials to commence building with Two-Way SSL, please refer to our Two-Way SSL tutorial.

Encryption

For most of the APIs listed above, Visa necessitates Message Level Encryption (MLE). For an in-depth understanding of MLE, kindly refer to our Message Level Encryption guide.

The Click to Pay Enrollment Attempt Notification API uses JSON Web Encryption and Object Signing (JWE/JWS). Please refer to the Visa Token Service – Issuer API Specifications (JSON) on Visa Assist for further information or contact your Visa representative.

Disclaimer: This page is provided on an “as is, where is” basis, “with all faults” known and unknown. This page could include technical inaccuracies or typographical errors. Changes are periodically added to the information herein: these changes will be incorporated in new editions of the document. VISA may make improvements and/or changes in the product(s) and/or the program(s) described in this document at any time. Where potential future functionality is highlighted, visa does not provide any warranty on whether such functionality will be available or if it will be delivered in any particular time. To the maximum extent permitted by applicable law, visa explicitly disclaims all warranties, express or implied, regarding the information contained herein, including any implied warranty of merchantability, fitness for a particular purpose, and non-infringement.

If you have technical questions or questions regarding a Visa service or questions about this document, please contact your Visa representative.