Use Cases Supported: The VAU Acquirer API supports the following use cases. For more information, please refer to the information on VDC portal or test cases examples.
Use Case |
Description |
New PAN and Expiration Date |
Returns New Account and Expiration Date with service identifier ‘A’ when available in VAU database |
New Expiration Date |
Returns only Expiration Date with service identifier ‘E’ signifying no change to PAN when available in VAU database |
Account Closed |
Returns service identifier ‘C’ signifying the account as closed when available in VAU database |
Opt-Out |
Returns service identifier ‘O’ signifying the card holder has opted out sharing credential information with the merchants when available in VAU database |
Contact Cardholder |
Returns service identifier ‘Q’ signifying that the cardholder has opted out and the merchant needs to contact cardholder for information when available in VAU database |
No Changes to PAN/Expiration Date |
Returns service identifier ‘V’ meaning Validation and signifies that the PAN and expiration date the merchant provided is current when available in VAU database |
No Update available |
Returns service identifier ‘P’ meaning that the BIN is participating in VAU but there is no match when available in VAU database |
Sample Code snippets: The following code snippet shows an example of an (inquiry) request payload with multiple PANs for some of the above use cases and the response includes new PAN and expiration date, new expiration date, closed account, contact cardholder and validation (no changes to PAN/expiration date). For more details, please visit Visa Development Center and select VAU Acquirer API.
Request Payload:
{
"acquirerSegmentId": 2,
"subMerchantName": "",
"acquirerOrMerchantProprietaryInfo": "",
"merchantId": "00000067625P",
"inquiries": [
{
"cardholderAccountNumber": "4aaaaaaaaaa55737",
"expirationDate": "2210"
},
{
"cardholderAccountNumber": "4bbbbbbbbb254355",
"expirationDate": "2609"
},
{
"cardholderAccountNumber": "4ccccccccc99386",
"expirationDate": "2608"
},
{
"cardholderAccountNumber": "4ddddddddd915103",
"expirationDate": "2501"
},
{
"cardholderAccountNumber": "4eeeeeeeee522668",
"expirationDate": "2610"
}
]
}
Response Payload:
{
"acquirerSegmentId": 2,
"merchantId": "00000067625P",
"subMerchantName": "",
"acquirerOrMerchantProprietaryInfo": "",
"responses": [
{
"oldCardholderAccountNumber": "4aaaaaaaaa355737",
"oldExpirationDate": "2210",
"newCardholderAccountNumber": "4zzzzzzzzzz54355",
"newExpirationDate": "2609",
"serviceIdentifier": "A",
"previouslySentFlag": "Y"
},
{
"oldCardholderAccountNumber": "4bbbbbbbbb099386",
"oldExpirationDate": "2608",
"newCardholderAccountNumber": "4bbbbbbbbb099386",
"newExpirationDate": "2609",
"serviceIdentifier": "E",
"previouslySentFlag": "N"
},
{
"oldCardholderAccountNumber": "4ccccccccc254355",
"oldExpirationDate": "2609",
"newCardholderAccountNumber": "",
"newExpirationDate": "",
"serviceIdentifier": "C",
"previouslySentFlag": "N"
},
{
"oldCardholderAccountNumber": "4ddddddddd915103",
"oldExpirationDate": "2501",
"newCardholderAccountNumber": "",
"newExpirationDate": "",
"serviceIdentifier": "Q",
"previouslySentFlag": "N"
},
{
"oldCardholderAccountNumber": "4eeeeeeeee22668",
"oldExpirationDate": "2610",
"newCardholderAccountNumber": "4eeeeeeeee522668",
"newExpirationDate": "2610",
"serviceIdentifier": "V",
"previouslySentFlag": "N"
},
],
"rejects": []
}
1 |
Start with creating a project on VDC Portal in sandbox environment (https://developer.visa.com/pages/working-with-visa-apis/create-project). |
2 |
Download VDC user id & password, project key & certificate, MLE key & certificate to access VDC sandbox. |
3 |
Add VAU Acquirer API in the project created in above step. |
4 |
Download the test cases from VDC portal. |
5 |
Develop and test code in sandbox environment. |
6 |
When ready to move to production, contact the Client Support team in your region to inform your decision. |
7 |
The Client Support team will update the VAU admin application. |
8 |
Promote the project to production on VDC portal (https://developer.visa.com/pages/going-live) |
9 |
Sign VDC contract specific to VAU Acquirer API and needs to be approved by VDC admin. |
10 |
VDC admin will perform project registration and approve the project to deploy in production environment. |
11 |
Receive notification from VDC via mail with instructions to download production project key/certificate, user id & password and MLE Key/certificate. |
12 |
Update the production configuration parameters from the above step in your code to begin using the VAU Acquirer API in production. |
1 |
Start with creating a project on VDC Portal in sandbox environment (https://developer.visa.com/pages/working-with-visa-apis/create-project). |
2 |
Download VDC user id & password, project key & certificate, MLE key & certificate to access VDC sandbox. |
3 |
Add VAU Acquirer API in the project created in above step. |
4 |
Download the test cases from VDC portal. |
5 |
Develop and test code in sandbox environment. |
6 |
When ready to move to production, contact the Client Support team in your region to inform your decision. |
7 |
The Client Support team will enroll the acquirer in VAU admin application along with merchant information specific to the acquirer. |
8 |
The Client Support team will share the newly created VAU Segment ID via email to be used in the VAU Acquirer API. |
9 |
To add additional merchants, please complete the merchant enrollment form and send to the customer support team in your region. |
10 |
Promote the project to production on VDC portal (https://developer.visa.com/pages/going-live) |
11 |
Sign VDC contract specific to VAU Acquirer API and needs to be approved by VDC admin. |
12 |
VDC admin will perform project registration and approve the project to deploy in production environment. |
13 |
Receive notification from VDC via mail with instructions to download production project key/certificate, user id & password and MLE Key/certificate. |
14 |
Update the production configuration parameters from the above step in your code to begin using the VAU Acquirer API in production. |
You can find the technical specification for each alias operation on the API reference tab, and download the latest batch file processing technical specification.
Note: This service is available only in selected countries, please contact your Visa Representative for more information.
Start a Project
API Overview
API Reference