Visa Click to Pay

Merchants and Payment Service Providers

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

Tutorials and Guides

High-Level Implementation and Requirements Guide

Onboarding Sandbox Integration Certification Testing Going Live
1. Open Project:

Open a Click to Pay Project. You must agree to both:

  • Visa Developer Center Terms of Use
  • Visa Click to Pay Product Terms

You can optionally enter your Business Entity (listed at Requirement 3) when opening the project, before Sandbox testing.

Work on Requirements 3, 4, and 5 in parallel with Requirement 2 to avoid delays.

2. Complete Tests:

Implement and complete test cases in the VDC Sandbox for each API you want to certify.

3. Valid Business Entity:

If not already completed, enter a Business Entity in the project and pass the compliance checks.

Certification Request:

Request to start Certification and complete the Click to Pay Solution-Description Intake Form.

Start working on Requirements 7-11 as early as possible during your implementation project, even during phase 1 for Requirement 7, to avoid delays.

 

5. Open Project in Partner Portal:

Open a Click to Pay project in the Visa Partner Portal.

6. Submit Test Results: Complete and submit mandatory and conditional test cases for the APIs requiring certification.

7. PCI DSS Attestation: Complete and submit the PCI DSS Attestation of Compliance (AOC).

8. Submit Architecture Design: Submit a network diagram/ topology and architecture overview including the protocols used

9. Sign VDCP Agreement: Submit Signed Visa Digital Commerce Program (VDCP) Agreement.

10. Submit evidence of your CX implementation: Submit end to end journey video and screenshots demonstrating branding requirements are met. .

11: Submit Solution Design:Submit Solution Design Document (required only if your solution deviates from any requirements in this document).

12. Submit Certification Checklist: Submit Completed "Visa Click to Pay Solution Certification Checklist"

 After you are promoted to the Production environment, Visa highly recommends validating with real API requests before mass rollout or commercial launch.

Onboarding to Sandbox

Project Management: Starting a Click to Pay Project

This section covers the initial setup steps that project managers need to complete to establish a Click to Pay project in the Visa Developer Center.

  1. Review the Quick Start Guide for Business Users

    Familiarize yourself with the overall process by visiting the Quick Start Guide for Business Users.

  2. Create a Visa Developer Account

    If you don't already have one, create a Visa Developer account. If you already have an account, skip to the next step.

  3. Create a Click to Pay Project

    Log in to your developer account. In the Dashboard page of your account, create a Click to Pay project by clicking Add New Project on the right side. If you've never created a project with Visa before, the right side button will read: Create your first project Give your project a name and write a short project description. Take note of the project name as you'll need to share it with your development team later. For example, you can input the following information:

    • Project Name: Integration to Visa Click to Pay
    • Project Description: Certification of Secure Remote Commerce solution for Visa Click to Pay. (Feel free to add a short description of whether you are integrating to be a Payment SRCi, Non-Payment SRCi, both, or an enabler for one or both.)
  4. Select Business Entity

    If your account is already associated with at least one Business Entity, you will see the Add Business Entity section when creating a project and will be asked to select the Business Entity name from the drop-down list.

    Entering a value to access Sandbox testing is entirely optional at this stage, so you can skip this step and return later if you're unsure of the value to use.

    If your account isn't yet associated with a Business Entity, you won't have the option to enter a Business Entity now (the Business Entity section won't be visible). You'll have the option to add the Business Entity information in your project dashboard after you finish creating the project.

    The business entity name is required before you can move to the Certification Environment and requires approval, so enter it as early as possible in the process to avoid delays. When ready, refer to step one in Project Management: Administrative Preparation Before Certification for how to add the Business Entity to the project.

    • If your organization has several BID values, check with your Account Manager to determine which one to use for this project before entering it.
    • If your organization doesn't have a BID, contact your Visa representative, Implementation Manager, or [email protected] to learn how to get one.
    • After being entered, the BID must be approved by a Visa representative before a move to Certification is permitted.
    • Entering this value will trigger appropriate sanction (OFAC) checks when required and PCI DSS assessment. Make sure you enter a value as early as possible in the process to avoid delays in moving to Certification and Production.
  5. Add Click to Pay Product

    In the Add Product section of the Dashboard, click on the drop-down list in the Select Product section, select Click to Pay, and click Submit.

    6. Project Confirmation
        You'll receive confirmation that your project is now live in the Sandbox environment.
    7. Access Sandbox APIs
  • Go to the Sandbox section of the Dashboard in the left side menu.
  • Once in Sandbox, expand Click to Pay to see available APIs and their URLs. You can click on API Reference to view the available APIs.
 
  • Add all developers who need access to the project using their email addresses by going to the Users section of the Sandbox.

     8. Notify Development Team
         Advise your developers that they can now access the project to create required credentials and keys and start implementing and testing in Sandbox. Let them know the project name. You can return to this section of the Dashboard at any time to add new users.

 

Sandbox Integration

Development: Sandbox Implementation and Testing

Once a Click to Pay project is open in the Visa Developer Center, you can begin implementation and testing.

  1. Review Developer Resources

    Start by reviewing the Visa Developer Quick Start for Developers to understand the overall development process.

  2. Access Your Developer Account

    1. If you don't have a Visa Developer Account, create one by clicking here.
    2. Log in to your developer account.
    3. On the Dashboard page, select the your Click to Pay project that your project manager created.

  3. Get Your APIs

    Navigate to Sandbox in the left menu of the Dashboard. In Sandbox, expand Click to Pay to view available APIs and their URLs. Click API References to view the available APIs.

    [Developer view of Sandbox section with Click to Pay APIs expanded]

  4. Set up Your Sandbox Credentials

    Go to the Credentials section to create your authentication credentials.

    The Visa Click to Pay API requires X-Pay Token authentication. You cannot select Two-Way SSL for this API, as shown in the onboarding dashboard. Refer to the X-Pay Token documentation for setup details.

    Some Click to Pay APIs require Field Level Encryption and certificate signing for decryption. Find the required keys in the Asset section in the left menu. In Sandbox, these keys are the same for all clients.

  5. Sandbox Implementation and Testing

    Before testing, refer to the relevant section of this guide to implement the required Click to Pay APIs using your Project (API) Keys. After your initial implementation is complete, use the sandbox environment to validate your integration.

    Visa Click to Pay test cases and test data for the sandbox are located in the Asset section of the left menu. These test cases correspond to scenarios you'll need to complete successfully in the Certification environment to obtain solution approval. Use Sandbox to confirm that your implementation behaves as expected and that you're prepared for Certification.

    General details on testing in Sandbox are located in the Project Testing and Production Validation section of the Visa Developer Quick Start Guide.

    For each test case, you must conform to the listed preconditions and use the exact test data provided in the Asset section. Any other data used in API requests will result in the Sandbox returning an error message. For example:
    • If you use a specific ID token, it must correspond to the correct identity. Any mismatch (using an ID token for one identity with a different consumer identity) will generate an error message.
    • You must respect the structure of field values provided in the test data. If an input field or value is required, it must be filled.

    When you are satisfied that the implementation is ready for official certification, discuss with your project manager about accessing the Certification environment. Plan ahead, as access to this environment may take around 3-5 business days.

    For a complete testing how-to, see Calling Your First API.

Project Management: Administrative Preparation Before Certification

While developers implement and test implementation and testing in Sandbox is in progress, plan ahead by reviewing all requirements you must meet before accessing the Certification environment. This includes entering a Business Entity and progressing your PCI DSS assessment if not already completed.

When you are confident that your organization is ready to move forward with Certification Testing for the required APIs, you can start with the Going Live steps of the Quick Start guide. Remember the information provided on pricing provided in the Quick Start Guide for Business Users.

Administrative Steps

The steps below include specific considerations.

1. Request Access to Certification Environment

Add the Business Entity. If you have not yet entered a Business Entity, you will have to do so at this point by clicking Start in the Business Entity section. A Visa staff member will need to approve this Business Entity.
 

If the approved business entity doesn't have a primary contact, then you may need to fill out a Business Entity Contact form, which will appear in the project dashboard below the approved Business Entity Information form.


If the approved business entity already has a primary contact, then the Business Entity Contact form will appear auto-populated and auto-approved.

Go to the Request to Start the Next Environment section of your project Dashboard. Press Start to the right of Project Information and fill out the required information and submit. Note: This section is hidden until your business entity is approved. If you recently submitted the information, wait for the approval email before proceeding.

2. Key Documentation Review

The Implementation manager will contact you to set up a kick-off call and share a Solution Description intake form that you will have to fill out and return prior to the call.

During the call the implementation manager may ask questions to fully understand your solution and will share and go over the documentation that will be required at the end of the certification phase before final solution approval. You (and your developers as appropriate) should review these to be familiar with all requirements the solution will have to meet to avoid later delays in solution approval.

  • The Visa Digital Commerce Program Agreement if none were previously signed by your organization. There may be different versions to sign depending on the regions where you plan to deploy your solution for business. Signature will be required for solution approval.
  • The Visa Digital Commerce Program – Role Requirements: Ensure the solution is designed in a way to meet all the requirements for the role you play indicated in this document.
  • The Visa Click to Pay Certification Checklist containing all required attestations you will need to provide before solution approval.

3. Step Up Project in the Visa Partner Portal

Some documents will need to be uploaded to the Visa Partner portal when ready for solution approval. To be ready for this, you need to set up a project in this Portal. Your Implementation Manager will advise during the kick-off call what is required for this.

Certification Testing

Once the Certification environment is available and your back-end development is ready for testing, you can begin certification testing (see Preparing for Certification on how to request access to the Certification environment). . Start by creating credentials for the Certification environment.

  1. Create Certification Credentials

    In your VDP project, go to the Credential section, complete a one-time passcode verification before the credentials appear. Follow the on-screen steps to complete this process.

    If you see the message "Check back in a couple of days," the Implementation manager hasn't finished setting up the credentials on Visa's side yet.

    Once the credentials are available, follow the same process you used in the Sandbox to set up the X-Pay token. Refer to the X-Pay Token documentation for detailed setup instructions.

  2. Access Test Cases and Test Cards

    Find the required certification test cases in the Asset section of your project. The test cards for Certification testing are also located in the Asset  section.

  3. Complete Certification Testing

    Test using the DPA onboarding API first (the API required to onboard merchants). Using this API onboards the test merchant that is needed for all other tests.

    Once you have completed this step, proceed with all other required and conditional certification test cases. For any issues during certification testing, email [email protected] or speak with your Visa implementation manager if you have their personal contact information.

    For each completed test case, fill out results in the Certification test case asset form. When completed, provide this form to your organization's project manager for submission into the Visa Partner portal. In addition to the completed certification test cases asset form, you need to provide:

    • A video of the end-to-end journey you support
    • Screenshots of all places where the following are displayed:
      • Any Visa logo or card art
      • Click to Pay text
      • EMVco SRC icon

    Refer to branding guidelines for associated requirements. Wait for confirmation from your organization project manager or Visa project manager that certification is completed and the Production environment is available.

Project Management: Documentation Upload

Before requesting to move to Production, upload all the following documents to the Visa Partner portal for final solution approval. To prevent delays in the approval process, upload these documents as they become available during certification. Email your Visa implementation manager whenever you upload a document to speed up the process.

  • PCI DSS AOC
  • Signed Visa Digital Commerce Program (VDCP) agreement for each region you will operate the solution in (if none previously in place)
  • Network diagram, topology, and architecture overview including the protocols used
  • CX documentation:
    1. A video of the end-to-end journey you support
    2. Screenshots of all places where the following are displayed:
      1. Any Visa logo or card art
      2. Click to Pay text
      3. EMVco SRC icon
  • Solution Design (only if your solution deviates from the Implementation Guide requirements)
  • Certification Test Case Results for each API being certified

After completing all the above requirements, complete and upload the Visa Click to Pay Certification Checklist provided by your appointed Visa Implementation Manager.

Going Live

Project Management: Preparing for the Production Environment

After you upload all required documents to the Visa Ready portal, you're ready to request access to the Production (live) environment. Follow the same steps you used for the Certification environment.

Visa will review all documentation and evaluate your solution for final approval. Once approved:

  • You will receive a Solution Approval letter.
  • Advise your developers to configure the API credentials in the Production section of the project, just as they did for the previous environment, and to complete validation in the production environment.
  • Complete the Solution Information form in Visa Partner to add your solution to the Visa Partner portal and finalize the VISA Ready Program process. This form appears in the Get Your Solution in the Partner Directory section only after your solution receives approval Solution Information form for Partner Directory after solution approval
  • After your developers have completed validation in the production environment, ask them to provide you with the results of what they performed in the same format as they submitted the certification test cases for you to upload to the Visa Partner portal and inform your Implementation Manager.
  • Your Visa Implementation Manager will close your implementation project and send the appropriate invoice.

Development: Validation in the Production Environment

Once the Production environment is live (as shown in the project dashboard), Visa strongly recommends validating that your implementation works as expected in production before any mass rollout.

To validate your implementation:

  • Send API requests using each API
  • Use the received payload to send information for authorization, completing a full end-to-end validation

You must perform this validation with real cards and usernames. Visa doesn't provide test data for production validation, so we recommend using staff cards.

For any issues during Production validation testing, email [email protected] or speak with your Visa implementation manager.

When completed, input the results of the validation performed in the validation in Production Asset Form, and submit to Visa via your project manager or the Visa Partner Portal.