Use Cases Supported: The VAU Merchant Enrollment API supports the following use cases. For more information, please refer to the information on VDC portal or test cases examples.
Use Case |
Description |
Enroll a Single Merchant |
Returns Succes, In-Progress or Reject |
Enroll Multiple Merchants (up to 100) |
Returns Success, In-Progress or Reject on merchants that were successfully enrolled or require additional research or rejected |
Start a Project
API Overview
Sample Code snippets: The following code snippet shows an example of a request payload with two merchants.
The response includes different outcomes including 'Success', 'In-Progress' and 'Reject'.
For more details, please visit Visa Development Center and select VAU Merchant Enrollment API.
Request Payload:
{
"acquirerSegmentId": 2,
"merchants": [
{
"merchantId": "000523446789",
"merchantName": "GS PERFORMANCE, LLC",
"parentCompany": "GS PERFORMANCE, LLC",
"internetAddress": "www.glockstor.com",
"merchantCategoryCode": "5735",
"merchantDescriptor": "GS PERFORMANCE, LLC",
"merchantAcquiringIdentifiers": [
"312345",
"312344"
],
"cardAcceptorId": "312344",
"contactName": "john",
"contactEmail": "[email protected]",
"phone": "898989898",
"streetAddress1": "8144 Walnut Hill Lane",
"streetAddress2": "",
"city": "Dallas",
"state": "TX",
"postalCode": "75231",
"merchantLineBusiness": "Online Service",
"countryCode": "840"
},
{
"merchantName": "ALLDATA CANADA SERVICS",
"parentCompany": "ALLDATA CANADA SERVICS",
"internetAddress": "http://www.alldata.com",
"merchantCategoryCode": "5734",
"merchantDescriptor": "ALLDATA CANADA SERVICS",
"merchantAcquiringIdentifiers": [
"312345",
"312344"
],
"cardAcceptorId": "31234443345",
"contactName": "kite",
"contactEmail": "[email protected]",
"phone": "898989898",
"streetAddress1": "19-180 Parsons Rd",
"streetAddress2": "",
"city": "Alliston",
"state": "ON",
"postalCode": "L9R 1E8",
"merchantLineBusiness": "Online Service",
"countryCode": "124"
}
]
}
Response Payload:
{
"acquirerSegmentId": 2,
"merchants": [
{
"merchantId": "000523446789",
"merchantName": "GS PERFORMANCE, LLC",
"enrollStatus": "Success"
},
{
"merchantName": "ALLDATA CANADA SERVICS",
"enrollStatus": "Reject",
"reject": {
"rejectCode": "R",
"rejectMessage": "Mandatory Field Merchant ID missing or invalid"
}
}
]
}
The following are the implementation steps for the following types of clients:
Please reach out to the VAU client services team if you have any questions.
1. Steps for an existing VAU client who would like to use the API:
1 |
Register as a user on the Visa Developer Center (VDC) portal, if necessary. |
2 |
Start with creating a project on VDC Portal in sandbox environment For more information, please click on this link:Create a Project. If you have already created a project using VAU acquirer APIs, then, skip this step. |
3 |
Download your VDC user ID and password, project key and certificate, and Message Level Encryption (MLE) key and certificate to access the VDC sandbox. |
4 |
Add VAU Merchant Enrollment API in the project created in above step or to the existing project. |
5 |
Download the test cases from the project Dashboard under 'Assets' and 'Sample Code'. |
6 |
Develop and test code in sandbox environment. |
7 |
When ready to move to production, contact the Client Support team in your region (project manager for EU) to inform your decision. |
8 |
The Client Support team/project manager will update the VAU admin application to add API functionality. |
9 |
Initiate the Going Live process on the VDC portal by selecting your project and selecting Going Live from the Dashboard. For more info on ‘Going Live’, click on Going Live |
10 |
You will receive a notification from your VDC admin/project manager with confirmation that the Going Live request has been accepted. |
11 |
Select authentication method: either X-Pay Token, Two-Way SSL, both. If Two-Way SSL is selected, you will be prompted to upload a certificate signing request (CSR). |
12 |
Submit the CSR for MLE if using Two-Way SSL. |
| 13 | The VDC admin generates certificates and informs the client to download and add new project certificates to a keystore. |
| 14 | Sign a VDC contract specific to the VAU Merchant Enrollment API. Contract must be approved by VDC admin. |
| 15 | The VDC admin will perform project registration and approve the project to deploy in production environment. |
| 16 | Receive notification from VDC via mail with instructions to download production project key/certificate, user ID and password, and MLE Key/certificate. |
| 17 | Update the production configuration parameters in your code with the information from Step 16 to begin using the VAU Merchant Enrollment API in production. |
| 18 | Perform production validation by sending production VAU API requests and sharing with the project manager the X-Correlation-ID, date, and time of requests. |
As a new user to VAU, please first contact your Visa representative. Review VAU terms of use, and other documentation with legal, technical, operational, and customer proposition teams. Submit a completed VAU enrollment form and enroll merchants and receive VAU Segment ID.
2. Steps for a new VAU client who would like to use the API:
1 |
Register as a user on the Visa Developer Center (VDC) portal, if necessary. |
2 |
Start with creating a project on VDC Portal in sandbox environment For more information, please click on this link: Create a Project |
3 |
Download your VDC user ID and password, project key and certificate, and Message Level Encryption (MLE) key and certificate to access the VDC sandbox. |
4 |
Add VAU Merchant Enrollment API in the project created in above step. |
5 |
Download the test cases from the project Dashboard under 'Assets' and 'Sample Code'. |
6 |
Develop and test code in sandbox environment. |
7 |
As a new acquirer/processor to VAU, contact your Visa representative to inform your interest in using the API. |
8 |
Your Visa representative or Client Services team will send the VAU Acquirer and Merchant enrollment forms. Review the Visa Account Updater Terms of Use and other documentation with legal, technical, operational teams. |
9 |
Submit a completed VAU Acquirer and Merchant enrollment form for your region. |
10 |
When ready to move to production, contact the Client Support team (project manager for EU) in your region to inform your decision and request a VAU acquirer segment. |
11 |
The Client Support team/project manager will enroll the acquirer in VAU admin application along with merchant information specific to the acquirer. |
12 |
The Client Support team/project manager will share the newly created VAU Segment ID via email to be used in the VAU Merchant Enrollment API. |
13 |
To add additional merchants, please complete the merchant enrollment form and send to the customer support team in your region. |
14 |
When satisfied with testing and ready to go live, initiate the Going Live process on the VDC portal by selecting your project and selecting Going Live from the Dashboard. For more info on ‘Going Live’, click on Going Live |
| 15 | You will receive a notification from your VDC admin/project manager with confirmation that the Going Live request has been accepted. |
| 16 | Select authentication method: either X-Pay Token, Two-Way SSL, both. If Two-Way SSL is selected, you will be prompted to upload a certificate signing request (CSR). |
| 17 | Submit the CSR for MLE if using Two-Way SSL. |
| 18 | The VDC admin generates certificates and informs the client to download and add new project certificates to a keystore. |
| 19 | Sign the VDC contract specific to the VAU Merchant Enrollment API. Contract must be approved by VDC admin. |
| 20 | The VDC admin will perform project registration and approve the project to deploy in production environment. |
| 21 | Receive notification from VDC via mail with instructions to download production project key/certificate, user ID and password, and MLE Key/certificate. |
| 22 | Update the production configuration parameters in your code with the information from Step 16 to begin using the VAU Merchant Enrollment API in production. |
| 23 | Perform production validation by sending production VAU API requests and sharing with the project manager the X-Correlation-ID, date, and time of requests. |
Since you are already using VAU Acquirer API, it is easier to add new APIs to the project. The following checklist shows the steps. As always, please contact your regional client services team if you have any questions. Review VAU terms of use, and other documentation with legal, technical, operational, and customer proposition teams. You need to be enrolled in VAU as an acquirer to use these APIs.
3. Steps for an existing VAU Acquirer API client and interested in adding the VAU Merchant Enrollment APIs
1 |
Add VAU Merchant Enrollment and search API in the existing Acquirer API project in Sandbox environment |
2 |
Download the test cases from the project Dashboard under 'Assets' and 'Sample Code'. |
3 |
Develop and test code in sandbox environment. |
4 |
When satisfied with testing and ready to go live, contact the Client Support team (project manager for EU) in your region to inform your decision. |
5 |
Initiate the Going Live process on the VDC portal by selecting your project and selecting Going Live from the Dashboard. For more info on ‘Going Live’, click on Going Live |
| 6 | You will receive a notification from your VDC admin/project manager with confirmation that the Going Live request has been accepted. |
| 7 | As this is an existing VDP production project, you don't need to download and configure the certificate again. |
| 8 | Perform production validation by sending production VAU API requests and sharing with the project manager the X-Correlation-ID, date, and time of requests. |