Use Cases Supported: The VAU Merchant Search API supports the following use cases. For more information, please refer to the information on VDC portal or test cases examples.
Use Case |
Description |
Active Merchant |
When the API call is made with appropriate segment and merchant id, the API returns when merchant(s) are successfully enrolled and is/are in "Active” status in VAU. |
Inactive Merchant |
When the API call is made with appropriate segment and merchant id, the API returns when merchant(s) are successfully enrolled and is/are “Inactive” status in VAU |
Declined |
When the API call is made with appropriate segment and merchant id, the API returns when the merchant is not eligible to be enrolled. |
In-Progress |
When the API call is made with appropriate segment and merchant id, the API returns when additional research is required. |
Not Found |
When the API call is made with appropriate segment and merchant id, the API returns when merchants are not present in VAU. |
Reject |
When the API call is made with appropriate segment and merchant id, the API returns returned when a merchant ID is not found, or other fields do not meet the validation. |
Sample Code snippets: The following code snippet shows an example of a search for multiple merchants. The response includes detailed information about the merchants along with their status - Active, Inactive and NotFound.
Request Payload:
{
"acquirerSegmentId": 2,
"merchants": [
{
"merchantId": "WRUYTWPMO8CM"
},
{
"merchantId": "QP2XA7CCQ2Z7"
},
{
"merchantId": "NJVRRSQ6GVBO"
},
{
"merchantId": "MJNWXPMO8CM1"
}
]
}
Response Payload:
{
"acquirerSegmentId": 2,
"merchants": [
{
"merchantId": "WRUYTWPMO8CM",
"merchantName": "Hay Retreats",
"merchantDescriptor": "hayretreats.com",
"merchantCategoryCode": "7011",
"cardAcceptorId": "70358083",
"merchantAcquiringIdentifiers": [
"420847"
],
"parentCompany": "Hay Retreats",
"internetAddress": "https://hayretreats.com/",
"streetAddress1": "1200 G Street NW",
"streetAddress2": "Suite 520",
"city": "Washington",
"postalCode": "20005",
"countryCode": "840",
"contactName": "Steve Felgate",
"contactEmail": "[email protected]",
"merchantLineBusiness": "sole_prop, small_business",
"merchantStatus": "Inactive"
},
{
"merchantId": "QP2XA7CCQ2Z7",
"merchantName": "www.playfiveaside.com",
"merchantDescriptor": "www.playfiveaside.com",
"merchantCategoryCode": "8999",
"cardAcceptorId": "57404323",
"merchantAcquiringIdentifiers": [
"420847"
],
"parentCompany": "Hay Retreats",
"internetAddress": "http://www.playfiveaside.com",
"streetAddress1": "141 West Jackson Street",
"streetAddress2": "suite 1400 A",
"city": "Chicago",
"postalCode": "60604",
"countryCode": "840",
"contactName": "Nilesh Pandit",
"contactEmail": "[email protected]",
"merchantLineBusiness": "corporation, small_business",
"merchantStatus": "Active"
},
{
"merchantId": "NJVRRSQ6GVBO",
"merchantName": "Farewill",
"merchantDescriptor": "farewill.com",
"merchantCategoryCode": "7299",
"cardAcceptorId": "123456",
"merchantAcquiringIdentifiers": [
"420847"
],
"parentCompany": "Hay Retreats",
"internetAddress": "https://farewill.com/",
"streetAddress1": "1 EQUITY WAY",
"streetAddress2": "Suite 165",
"city": "WESTLAKE",
"postalCode": "44145",
"countryCode": "840",
"contactName": "Daniel Garrett",
"contactEmail": "[email protected]",
"merchantLineBusiness": "corporation, startup",
"merchantStatus": "Active"
},
{
"merchantId": "MJNWXPMO8CM1",
"merchantStatus": "NotFound"
}
]
}
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