Visa Business Data Solutions API Reference
Visa Business Data Solutions
Search API Reference
- Getting Started
- Authentication Method
- How to Use Visa Business Data Solutions
- Error Codes
- Product Terms
- Request & Response Codes
Authorization Data API
Data API will provide the APIs to expose the commercial data (i.e. card financial, invoice data) and authorization data through RESTful Services. The idea is to create an Enterprise Service with Restful architecture, which is robust, secured, scalable and high performance API. Data API provides functionality to fetch commercial data and authorization data through following API. 1: Transaction API, 2: Enhanced Data API, 3: Starter Data API, 4: Authorization Data (Authorization Data API is an on-demand web service which delivers the authorization details (approved/declined) to the end consumer for registered card accounts (PAN).)
Get Authorization Data v1 - Latest
Get Authorization Data
Request
header Parameters
| clientId required |
string clientId |
Request Body schema: application/json
| authEndDateTime required |
string Transaction Auth time in GMT. Sample value --> 2022-09-01T01:40:00 |
| authStartDateTime required |
string Transaction Auth time in GMT. Sample value --> 2022-09-01T01:40:00 |
| companyId required |
string [ 1 .. 25 ] characters ^[0-9]+$ companyId associated with the account |
| issuerId required |
string [ 1 .. 15 ] characters ^[0-9]+$ issuerId/bankId associated with the account |
| processorId required |
string [ 1 .. 10 ] characters ^[0-9]+$ processorId associated with the account |
| regionId required |
string [ 1 .. 5 ] characters ^[0-9]+$ regionId associated with the account |
| accountList | Array of strings A list of account numbers |
| filters | Array of objects |
| Array |
| filterBy | string filter by clause. Supported values are authCatgCd and msgType |
| filterValues | Array of strings An array of the Auth Data objects. |
| pageNum | integer page Number associated with API call. |
| pageSize | integer page Size associated with API call. |
Responses
200 ok
Response Schema: application/json
| authTransactions | Array of objects |
| Array |
| acctNum | any Account Number |
| authCatgCd | string Auth Category Code from VisaNet |
| authCatgDesc | string Auth Category Description from VisaNet |
| authDt | string Authorization Date |
| authIdResp | string Authorization Identification Response |
| authRsnDesc | string Auth Status/Reason Description from VisaNet |
| authStatusCode | string Auth Status/Reason Code from VisaNet |
| authTime | string Authorization Time in format hh:mm:ss |
| company | string Company |
| crdAcptrId | string Card Acceptor Id |
| crdhBillAmt | string Card Holder Billing Amount |
| crdhBillAmtUsd | string Card Holder Billing Amount in USD |
| crdhBillCurrCd | string Card Holder Currency Code |
| crdTypCd | string Card Type Code |
| isoTranAmt | string Transaction Amount |
| isoTranCurrCd | string Transaction Currency Code |
| issuer | string Issuer |
| mrchCatgCd | string Merchant Category Code |
| mrchCity | string Merchant City |
| mrchCtryCd | string Merchant Country Code |
| mrchNm | string Merchant Name |
| mrchStatePrvCd | string Merchant State Province Code |
| mrchZipCd | string Merchant Zip Code |
| msgType | string Message Type Code Indicator to state which type of transaction |
| msgTypeDesc | string Message Type Description to state which type of transaction |
| partialAuthAmt | string Partial Auth Amount |
| preAuth | string Pre Auth Indicator with Yes/No |
| processor | string Processor |
| region | string Region |
| stipAdvcCd | string Stand In Processing Advance Code |
| stipSwtchRsnCd | string Stand In Processing Switch Reason Code |
| stipSwtchRsnDesc | string Stand In Processing Switch Reason Description |
| tokenIndicator | string Token Indicator |
| tokenNumber | string Token Number |
| tranId | string Transaction Id |
| tranProcCd | string Transaction Processing Code |
| trgrSvcDesc | string Description Accociated with Trigger ServiceType |
| trgrSvcType | any Trigger Service Type |
| uniqSeqId | string Field set by VisaNet to identify each leg of an authorization lifecycle. |
| vpcActTknCd | string VPC Action Taken Code |
| vpcPropActnCd | string VPC Proposed Action Code |
| metaData | object |
| --- | --- |
| pageNum | integer |
| totalMatchedRecords | integer |
201 Created
400 One or more fields were in incorrect format
Response Schema: application/json
| errors | Array of objects |
| Array |
| message | string |
401 Unauthorized
403 Forbidden
404 Not Found
500 Something went wrong. Please try again later
Response Schema: application/json
| errors | Array of objects |
| Array |
| message | string |
post/vbs/dapi/v1/transactions/auth
Sandbox server
https://sandbox.api.visa.com/vbs/dapi/v1/transactions/auth
Copy
Request samples
- Payload
application/json
{"authEndDateTime": "2022-09-30T01:40:00",
"issuerId": "4444",
"companyId": "90001",
"processorId": "2",
"regionId": "1",
"accountList": [ ],
"pageSize": 25,
"filters": [{"filterValues": [99],
"filterBy": "authCatgCd"},
{"filterValues": ["0100"],
"filterBy": "msgType"}],
"pageNum": "1",
"authStartDateTime": "2022-09-01T01:40:00"}
Response samples
- 200
- 400
- 500
application/json
{"metaData": {"totalMatchedRecords": 2,
"pageNum": 1},
"authTransactions": [{"tranId": "973839033642644",
"mrchCatgCd": "9399",
"stipAdvcCd": "5",
"msgType": "0100",
"isoTranAmt": "100.04",
"vpcPropActnCd": " ",
"crdhBillAmt": "100.04",
"authTime": "12:11:22",
"stipSwtchRsnCd": " ",
"tokenIndicator": "0",
"issuer": "4444",
"trgrSvcDesc": "Airline merchants restriction",
"trgrSvcType": "AIR",
"uniqSeqId": "5464545355453454",
"vpcActTknCd": " ",
"authCatgCd": "99",
"authCatgDesc": "PROCESSING ERROR",
"company": "90001",
"partialAuthAmt": "100.04",
"preAuth": "Yes",
"mrchNm": "Amazon",
"tranProcCd": " ",
"mrchStatePrvCd": " ",
"crdTypCd": "4",
"isoTranCurrCd": "840",
"authStatusCode": "80",
"mrchCtryCd": "COLUMBIA",
"msgTypeDesc": "AUTHORIZATION REQUEST",
"acctNum": "4000000000000003",
"crdAcptrId": " ",
"authRsnDesc": "NO FINANCIAL IMPACT",
"crdhBillCurrCd": "840",
"processor": "2",
"crdhBillAmtUsd": "100.04",
"authDt": "20220901",
"mrchZipCd": "29201",
"authIdResp": " ",
"tokenNumber": " ",
"stipSwtchRsnDesc": "Not Applicable",
"mrchCity": "San Jose",
"region": "1"},
{"tranId": "973492303180772",
"mrchCatgCd": "9399",
"stipAdvcCd": "5",
"msgType": "0100",
"isoTranAmt": "100.04",
"vpcPropActnCd": " ",
"crdhBillAmt": "100.04",
"authTime": "12:11:22",
"stipSwtchRsnCd": " ",
"tokenIndicator": "0",
"issuer": "4444",
"trgrSvcDesc": "Airline merchants restriction",
"trgrSvcType": "AIR",
"uniqSeqId": "43454543534545",
"vpcActTknCd": " ",
"authCatgCd": "99",
"authCatgDesc": "PROCESSING ERROR",
"company": "90001",
"partialAuthAmt": "100.04",
"preAuth": "Yes",
"mrchNm": "Amazon",
"tranProcCd": " ",
"mrchStatePrvCd": " ",
"crdTypCd": "4",
"isoTranCurrCd": "840",
"authStatusCode": "56",
"mrchCtryCd": "COLUMBIA",
"msgTypeDesc": "AUTHORIZATION REQUEST",
"acctNum": "4000000000000014",
"crdAcptrId": " ",
"authRsnDesc": "UNABLE TO LOCATE RECORD",
"crdhBillCurrCd": "840",
"processor": "2",
"crdhBillAmtUsd": "100.04",
"authDt": "20220901",
"mrchZipCd": "29201",
"authIdResp": " ",
"tokenNumber": " ",
"stipSwtchRsnDesc": "Not Applicable",
"mrchCity": "San Jose",
"region": "1"}]
}