PayFac Reporting API Documentation
Authentication
To access the payfac reporting API you must have an API key. Keys are generated by the administrators and are tied to an IP address.
Only IP addresses saved in the system can access the API.
Keys are included as a url parameter for any GET calls. Example: https://reporting.vantagepay.io/api/...?key=xxxx-xxxx-xxxx-xxxx-xxxx
Transactions
ALL calls to transaction endpoints are GET calls. Below is a breakdown of the transaction endpoints
https://reporting.vantagepay.io/api/txreports/v1/CTDR/12345/2016-11-14/2016-11-14?key=xxx&txtypes=+CC,-CC
\________________________________/ \______/ \/ \__/ \___/ \_________/ \________/ \_____/ \_____________/
| | | | | | | | |
API's Base URL Service | | | Start Date End Date | Transaction Types
| | Affiliate Api Key
| Report
API Version
ACH Return Detail Report (GET) https://reporting.vantagepay.io/api/txreports/v1/ARDR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "ARDR",
"ReportName": "ACH Return Detail Report",
"AffiliateId": "[AFFILIATE_ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "3",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "7",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:31",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.04",
"NetAmount": "-1.04",
"FundDate": "2016-11-09 15:26:31",
"ReturnCode": "R03",
"ReturnCodeDescription": "No Account/Unable to Locate Account",
"PayerName": "dave test",
"PayerEmail": "company11@askvantage.com",
"PayerLast4": "1623",
"ReportDate": "2016-11-10"
},
{
"id": "4",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "252",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.88",
"NetAmount": "-1.88",
"FundDate": "2016-11-09 15:26:30",
"ReturnCode": "R03",
"ReturnCodeDescription": "No Account/Unable to Locate Account",
"PayerName": "dave test",
"PayerEmail": "vantage@askvantage.com",
"PayerLast4": "1623",
"ReportDate": "2016-11-10"
},
{
"id": "5",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "102",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.88",
"NetAmount": "-1.88",
"FundDate": "2016-11-09 15:26:30",
"ReturnCode": "R01",
"ReturnCodeDescription": "Non Sufficient Funds",
"PayerName": "dave test",
"PayerEmail": "company11@askvantage.com",
"PayerLast4": "1623",
"ReportDate": "2016-11-10"
}
]
}
| ACH Return Detail Report | When processing ACH payments there is always a posibility that the payment could be returned from the bank. This report will show you details for each return. Please note that an ACH return can also be recived on a debit or credit to the merchant's bank account and not just on ACH payments that the merchant is processing to collect from their customer. It is important to monitor this report even if your merchants aren't processing ACH payments. |
| id | Internal data source ID.� |
| GatewayId | Internal data source ID.� |
| MerchantId | The merchant ID that has been assigned to the account during boarding.� |
| ExternalID | This field is reserved for future use. |
| InvoiceNumber | This is the invoice number that was passed with the original transaction. |
| TransactionID | This is the transaction ID assigned by ProPay. The transaction ID of the ACH return will match the transaction ID of the original transaction. |
| TransactionInfoID | This number is unique to the transaction. |
| ParentTransactionID | This number matches the transactionId of the original transaction that has been returned. |
| TransactionDate | Date of the return. |
| TransactionDescription | The type of transaction. Most common are: ACH Payment Return (a return on an ACH payment collected from your customer) and� -CK return (a return on a deposit to your merchant's bank account). |
| GrossAmount | The amount of the return. |
| NetAmount | The amount of the return. |
| FundDate | Date that the transaction would be included in a sweep. |
| ReturnCode | This code will tell you the reason for the return. These are the standard ACH NACHA return codes. ** add a link to codes |
| ReturnCodeDescription | This is a breif description of what the return code means. This text is passed directly from the bank who has issued the return. Most of the time they are standard and will match our list of return codes/ reasons. Sometimes the bank will add custom text. |
| PayerName | The payer's name that was passed with the original transaction. |
| PayerEmail | The payer's email that was passed with the original transaction. |
| PayerLast4 | The last 4 digits of the payer's bank account number (also known as the DDA). |
| TraceNumber | This number can be used to trace the transaction at the bank. Sometimes account holders will want this number in order to have their bank further research the reason for the return. |
| ReportDate | Date of the report. |
ACH Return Detail Report V2 (GET) https://reporting.vantagepay.io/api/txreports/v2/ARDR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Added TraceNumber
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "ARDR",
"ReportName": "ACH Return Detail Report",
"AffiliateId": "[AFFILIATE_ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "3",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "7",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:31",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.04",
"NetAmount": "-1.04",
"FundDate": "2016-11-09 15:26:31",
"ReturnCode": "R03",
"ReturnCodeDescription": "No Account/Unable to Locate Account",
"PayerName": "dave test",
"PayerEmail": "company11@askvantage.com",
"PayerLast4": "1623",
"TraceNumber": "123000011039861,
"ReportDate": "2016-11-10"
},
{
"id": "4",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "252",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.88",
"NetAmount": "-1.88",
"FundDate": "2016-11-09 15:26:30",
"ReturnCode": "R03",
"ReturnCodeDescription": "No Account/Unable to Locate Account",
"PayerName": "dave test",
"PayerEmail": "vantage1@askvantage.com",
"PayerLast4": "1623",
"TraceNumber": "123000011039865,
"ReportDate": "2016-11-10"
},
{
"id": "5",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"ExternalID": " ",
"InvoiceNumber": "",
"TransactionId": "102",
"ParentTransactionId": "",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionDescription": "ACH Payment Return",
"GrossAmount": "-1.88",
"NetAmount": "-1.88",
"FundDate": "2016-11-09 15:26:30",
"ReturnCode": "R01",
"ReturnCodeDescription": "Non Sufficient Funds",
"PayerName": "dave test",
"PayerEmail": "company11@askvantage.com",
"PayerLast4": "1623",
"TraceNumber": "123000011039869,
"ReportDate": "2016-11-10"
}
]
}
| ACH Return Detail Report | When processing ACH payments there is always a posibility that the payment could be returned from the bank. This report will show you details for each return. Please note that an ACH return can also be recived on a debit or credit to the merchant's bank account and not just on ACH payments that the merchant is processing to collect from their customer. It is important to monitor this report even if your merchants aren't processing ACH payments. |
| id | Internal data source ID.� |
| GatewayId | Internal data source ID.� |
| MerchantId | The merchant ID that has been assigned to the account during boarding.� |
| ExternalID | This field is reserved for future use. |
| InvoiceNumber | This is the invoice number that was passed with the original transaction. |
| TransactionID | This is the transaction ID assigned by ProPay. The transaction ID of the ACH return will match the transaction ID of the original transaction. |
| TransactionInfoID | This number is unique to the transaction. |
| ParentTransactionID | This number matches the transactionId of the original transaction that has been returned. |
| TransactionDate | Date of the return. |
| TransactionDescription | The type of transaction. Most common are: ACH Payment Return (a return on an ACH payment collected from your customer) and� -CK return (a return on a deposit to your merchant's bank account). |
| GrossAmount | The amount of the return. |
| NetAmount | The amount of the return. |
| FundDate | Date that the transaction would be included in a sweep. |
| ReturnCode | This code will tell you the reason for the return. These are the standard ACH NACHA return codes. ** add a link to codes |
| ReturnCodeDescription | This is a breif description of what the return code means. This text is passed directly from the bank who has issued the return. Most of the time they are standard and will match our list of return codes/ reasons. Sometimes the bank will add custom text. |
| PayerName | The payer's name that was passed with the original transaction. |
| PayerEmail | The payer's email that was passed with the original transaction. |
| PayerLast4 | The last 4 digits of the payer's bank account number (also known as the DDA). |
| TraceNumber | This number can be used to trace the transaction at the bank. Sometimes account holders will want this number in order to have their bank further research the reason for the return. |
| ReportDate | Date of the report. |
Comprehensive Risk Chargeback Report (GET) https://reporting.vantagepay.io/api/txreports/v1/CRCR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "CRCR",
"ReportName": "Comprehensive Risk Chargeback Report",
"AffiliateId": "[AFFILIATE_ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "29",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "4",
"ParentTransactionId": "",
"TransactionAmount": "1.03",
"PayeeName": "Ron Robinson",
"CardBrand": "V",
"CardNumber": "407714xxxxxx0188",
"RepresentmentDate": null,
"RepresentmentStatus": "",
"DaysToRepresent": "7",
"ChargebackDate": "2016-10-13 18:00:25",
"ChargebackAmount": "1.03",
"ChargeBackCode": "53",
"ChargeBackDescription": "Merchandise/service not as described",
"Result": "",
"ReportDate": "2016-11-10"
}
]
}
Comprehensive Risk Retrieval Report (GET) https://reporting.vantagepay.io/api/txreports/v1/CRRR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "CRRR",
"ReportName": "Comprehensive Risk Retrieval Report",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "15",
"GatewayId": "1",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "6",
"ParentTransactionId": "",
"TransactionAmount": "1.01",
"TransactionDate": "2016-10-06 00:00:00",
"PayeeName": "Bob Robinson",
"CardBrand": "V",
"CardNumber": "407714xxxxxx0188",
"RequestDate": "2016-10-14 00:00:00",
"ResponseDate": null,
"ReasonCode": "75",
"ReasonDescription": "The cardholder does not recognize this transaction. Please provide support and itemization. In addition, if the charge relates to shipped goods, please include proof of delivery with the full delivery address. If this documentation is not available, pleas",
"DaysToRespond": "0",
"Status": "Unanswered",
"ReportDate": "2016-11-10"
}
]
}
Comprehensive Transaction Detail Report (GET) https://reporting.vantagepay.io/api/txreports/v1/CTDR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "CTDR",
"ReportName": "Comprehensive Transaction Detail Report",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "209",
"GatewayId": "1",
"SweepId": "63903042",
"BatchId": "404179",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Add Funds",
"TransactionId": "10",
"TransactionInfoId": "233943869",
"TransactionDate": "2016-11-09 01:00:24",
"TransactionType": "+CK",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...2082",
"TransactionDetailName": "Test Customer",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "1.04",
"AuthCurrencyCode": "USD",
"GrossAmount": "1.04",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "1.04",
"FundDate": "2016-11-09 01:00:24",
"SettleDate": "2016-11-09 13:40:16",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": " ",
"UserName": "",
"FirstName": "Test",
"LastName": "Customer",
"Email": "company11@askvantage.com",
"BusinessLegalName": "",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "REGIONS BANK",
"BankAddress1": "P.O. BOX 681",
"BankAddress2": "",
"BankCity": "BIRMINGHAM",
"BankStateProvince": "AL",
"BankPostalCode": "35201-0000",
"BankTelephone": "+1 800 734 4667",
"ReportDate": "2016-11-10"
},
{
"id": "210",
"GatewayId": "1",
"SweepId": "63903043",
"BatchId": "404179",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Withdraw Funds",
"TransactionId": "11",
"TransactionInfoId": "233943871",
"TransactionDate": "2016-11-09 01:00:24",
"TransactionType": "-CK",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...2082",
"TransactionDetailName": "Test Customer",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.04",
"AuthCurrencyCode": "USD",
"GrossAmount": "-1.04",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "-1.04",
"FundDate": "2016-11-09 01:00:24",
"SettleDate": "2016-11-09 13:40:16",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": " ",
"UserName": "",
"FirstName": "Test",
"LastName": "Customer",
"Email": "company11@askvantage.com",
"BusinessLegalName": "",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "REGIONS BANK",
"BankAddress1": "P.O. BOX 681",
"BankAddress2": "",
"BankCity": "BIRMINGHAM",
"BankStateProvince": "AL",
"BankPostalCode": "35201-0000",
"BankTelephone": "+1 800 734 4667",
"ReportDate": "2016-11-10"
},
{
"id": "211",
"GatewayId": "1",
"SweepId": "63903044",
"BatchId": "404179",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Add Funds",
"TransactionId": "258",
"TransactionInfoId": "233943872",
"TransactionDate": "2016-11-09 01:00:24",
"TransactionType": "+CK",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "18...1623",
"TransactionDetailName": "Vantage Card Services",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "1.61",
"AuthCurrencyCode": "USD",
"GrossAmount": "1.61",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "1.61",
"FundDate": "2016-11-09 01:00:24",
"SettleDate": "2016-11-09 13:40:16",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": " ",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "FIRST CITIZENS BANK & TRUST COMPANY",
"BankAddress1": "DAC 28",
"BankAddress2": "",
"BankCity": "RALEIGH",
"BankStateProvince": "NC",
"BankPostalCode": "27603-0000",
"BankTelephone": "+1 888 323 4732",
"ReportDate": "2016-11-10"
},
{
"id": "212",
"GatewayId": "1",
"SweepId": "63903045",
"BatchId": "404179",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Withdraw Funds",
"TransactionId": "259",
"TransactionInfoId": "233943873",
"TransactionDate": "2016-11-09 01:00:24",
"TransactionType": "-CK",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "18...1623",
"TransactionDetailName": "Vantage Card Services",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.27",
"AuthCurrencyCode": "USD",
"GrossAmount": "-1.27",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "-1.27",
"FundDate": "2016-11-09 01:00:24",
"SettleDate": "2016-11-09 13:40:16",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": " ",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "FIRST CITIZENS BANK & TRUST COMPANY",
"BankAddress1": "DAC 28",
"BankAddress2": "",
"BankCity": "RALEIGH",
"BankStateProvince": "NC",
"BankPostalCode": "27603-0000",
"BankTelephone": "+1 888 323 4732",
"ReportDate": "2016-11-10"
},
{
"id": "213",
"GatewayId": "1",
"SweepId": "63907629",
"BatchId": "404174",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "260",
"TransactionInfoId": "233943980",
"TransactionDate": "2016-11-09 01:01:01",
"TransactionType": "+ACH Payment",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "06...2345",
"TransactionDetailName": "test test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "1.00",
"AuthCurrencyCode": "USD",
"GrossAmount": "1.00",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "1.00",
"FundDate": "2016-11-09 09:27:03",
"SettleDate": "2016-11-09 13:25:13",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "214",
"GatewayId": "1",
"SweepId": "63907629",
"BatchId": "404174",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "261",
"TransactionInfoId": "233943982",
"TransactionDate": "2016-11-09 01:01:01",
"TransactionType": "+ACH Payment",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "06...2345",
"TransactionDetailName": "test test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "0.10",
"AuthCurrencyCode": "USD",
"GrossAmount": "0.10",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "0.10",
"FundDate": "2016-11-09 09:27:03",
"SettleDate": "2016-11-09 13:25:13",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "215",
"GatewayId": "1",
"SweepId": "63907629",
"BatchId": "404202",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "262",
"TransactionInfoId": "233998632",
"TransactionDate": "2016-11-09 13:37:43",
"TransactionType": "+ACH Payment",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "06...2345",
"TransactionDetailName": "test test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "1.00",
"AuthCurrencyCode": "USD",
"GrossAmount": "1.00",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "1.00",
"FundDate": "2016-11-09 16:00:41",
"SettleDate": "2016-11-09 18:18:12",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "216",
"GatewayId": "1",
"SweepId": "63907629",
"BatchId": "404202",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "263",
"TransactionInfoId": "233998633",
"TransactionDate": "2016-11-09 13:37:43",
"TransactionType": "+ACH Payment",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "06...2345",
"TransactionDetailName": "test test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "0.10",
"AuthCurrencyCode": "USD",
"GrossAmount": "0.10",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "0.10",
"FundDate": "2016-11-09 16:00:41",
"SettleDate": "2016-11-09 18:18:12",
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "217",
"GatewayId": "1",
"SweepId": "63907628",
"BatchId": "0",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "252",
"TransactionInfoId": "234006980",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionType": "ACH Payment Return",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...1623",
"TransactionDetailName": "dave test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.88",
"AuthCurrencyCode": "USD",
"GrossAmount": "-1.88",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "-1.88",
"FundDate": "2016-11-09 15:26:30",
"SettleDate": null,
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "218",
"GatewayId": "1",
"SweepId": "63907628",
"BatchId": "0",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "252",
"TransactionInfoId": "234006981",
"TransactionDate": "2016-11-09 15:26:30",
"TransactionType": "+ACH Payment - Rejected Fee",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...1623",
"TransactionDetailName": "dave test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.88",
"AuthCurrencyCode": "USD",
"GrossAmount": "0.00",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "0.00",
"FundDate": "2016-11-09 15:26:30",
"SettleDate": null,
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Vantage Card",
"LastName": "Services",
"Email": "vantage@askvantage.com",
"BusinessLegalName": "Vantage Card Services",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "219",
"GatewayId": "1",
"SweepId": "63907626",
"BatchId": "0",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "7",
"TransactionInfoId": "234006982",
"TransactionDate": "2016-11-09 15:26:31",
"TransactionType": "ACH Payment Return",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...1623",
"TransactionDetailName": "dave test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.04",
"AuthCurrencyCode": "USD",
"GrossAmount": "-1.04",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "-1.04",
"FundDate": "2016-11-09 15:26:31",
"SettleDate": null,
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Test",
"LastName": "Customer",
"Email": "company11@askvantage.com",
"BusinessLegalName": "",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
},
{
"id": "220",
"GatewayId": "1",
"SweepId": "63907626",
"BatchId": "0",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionId": "7",
"TransactionInfoId": "234006983",
"TransactionDate": "2016-11-09 15:26:31",
"TransactionType": "+ACH Payment - Rejected Fee",
"TransactionDetailType": "Checking",
"TransactionDetailAccount": "00...1623",
"TransactionDetailName": "dave test",
"TransactionDetailEmail": "",
"CardPresent": "False",
"CardNumber": "",
"ExpDate": "",
"HasCVV2": "False",
"CVV2Resp": "",
"AuthAmount": "-1.04",
"AuthCurrencyCode": "USD",
"GrossAmount": "0.00",
"AuthCode": "",
"DiscFee": "0.00",
"PerTransFee": "0.00",
"Credit": "0.00",
"NetAmount": "0.00",
"FundDate": "2016-11-09 15:26:31",
"SettleDate": null,
"Comment1": "",
"Comment2": "",
"AVSCode": "",
"AVSCodeDescription": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"BillingAddress1": "",
"BillingAddress2": "",
"BillingAddress3": "",
"BillingCity": "",
"BillingState": "",
"BillingPostalCode": "",
"BillingCountry": "",
"ShippingAddress1": "",
"ShippingAddress2": "",
"ShippingCity": "",
"ShippingState": "",
"ShippingPostalCode": "",
"ShippingName": "",
"SendingPayerName": "",
"SendingPayerEmail": "",
"SendingAccountNum": "",
"OwnerFirstName": "",
"OwnerLastName": "",
"OwnerAddress1": "",
"OwnerAddress2": "",
"OwnerAddress3": "",
"OwnerCity": "",
"OwnerState": "",
"OwnerPostalCode": "",
"OwnerCountryCode": "",
"UserName": "",
"FirstName": "Test",
"LastName": "Customer",
"Email": "company11@askvantage.com",
"BusinessLegalName": "",
"DoingBusinessAs": "Vantage Test Company",
"ReceivingPayerName": "",
"ReceivingPayerEmail": "",
"ReceivingAccountNum": "",
"BankName": "",
"BankAddress1": "",
"BankAddress2": "",
"BankCity": "",
"BankStateProvince": "",
"BankPostalCode": "",
"BankTelephone": "",
"ReportDate": "2016-11-10"
}
]
}
Deposit Detail Report (GET) https://reporting.vantagepay.io/api/txreports/v1/DDR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "DDR",
"ReportName": "Deposit Detail Report",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "203",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "233943980",
"TransactionId": "260",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment",
"TransactionDate": "2016-11-09 01:01:01",
"FundDate": "2016-11-09 09:27:03",
"NameAndEmail": "test test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0661..2345",
"AccountAndType": "Checking",
"AuthorizationAmount": "1.00",
"GrossAmount": "1.00",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "1.00",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "203",
"ReportDate": "2016-11-10"
},
{
"id": "204",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "233943982",
"TransactionId": "261",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment",
"TransactionDate": "2016-11-09 01:01:01",
"FundDate": "2016-11-09 09:27:03",
"NameAndEmail": "test test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0661..2345",
"AccountAndType": "Checking",
"AuthorizationAmount": "0.10",
"GrossAmount": "0.10",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "0.10",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "204",
"ReportDate": "2016-11-10"
},
{
"id": "205",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "233998632",
"TransactionId": "262",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment",
"TransactionDate": "2016-11-09 13:37:43",
"FundDate": "2016-11-09 16:00:41",
"NameAndEmail": "test test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0661..2345",
"AccountAndType": "Checking",
"AuthorizationAmount": "1.00",
"GrossAmount": "1.00",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "1.00",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "205",
"ReportDate": "2016-11-10"
},
{
"id": "206",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "233998633",
"TransactionId": "263",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment",
"TransactionDate": "2016-11-09 13:37:43",
"FundDate": "2016-11-09 16:00:41",
"NameAndEmail": "test test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0661..2345",
"AccountAndType": "Checking",
"AuthorizationAmount": "0.10",
"GrossAmount": "0.10",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "0.10",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "206",
"ReportDate": "2016-11-10"
},
{
"id": "207",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "234006980",
"TransactionId": "252",
"ParentTransactionId": "",
"TransactionType": "ACH Payment Return",
"TransactionDate": "2016-11-09 15:26:30",
"FundDate": "2016-11-09 15:26:30",
"NameAndEmail": "dave test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0017..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "-1.88",
"GrossAmount": "-1.88",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "-1.88",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "207",
"ReportDate": "2016-11-10"
},
{
"id": "208",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "234006981",
"TransactionId": "252",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment - Rejected Fee",
"TransactionDate": "2016-11-09 15:26:30",
"FundDate": "2016-11-09 15:26:30",
"NameAndEmail": "dave test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0017..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "-1.88",
"GrossAmount": "0.00",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "0.00",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "208",
"ReportDate": "2016-11-10"
},
{
"id": "209",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "234006982",
"TransactionId": "7",
"ParentTransactionId": "",
"TransactionType": "ACH Payment Return",
"TransactionDate": "2016-11-09 15:26:31",
"FundDate": "2016-11-09 15:26:31",
"NameAndEmail": "dave test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0017..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "-1.04",
"GrossAmount": "-1.04",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "-1.04",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "209",
"ReportDate": "2016-11-10"
},
{
"id": "210",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "234006983",
"TransactionId": "7",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment - Rejected Fee",
"TransactionDate": "2016-11-09 15:26:31",
"FundDate": "2016-11-09 15:26:31",
"NameAndEmail": "dave test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0017..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "-1.04",
"GrossAmount": "0.00",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "0.00",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "R03",
"ResponseCodeDescription": "No Account/Unable to Locate Account",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "210",
"ReportDate": "2016-11-10"
},
{
"id": "211",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Add Funds",
"TransactionInfoId": "234048367",
"TransactionId": "12",
"ParentTransactionId": "",
"TransactionType": "+CK Pending",
"TransactionDate": "2016-11-10 01:00:32",
"FundDate": "2016-11-10 01:00:32",
"NameAndEmail": "Test Customer",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0017..2082",
"AccountAndType": "Checking",
"AuthorizationAmount": "1.04",
"GrossAmount": "1.04",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "1.04",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "211",
"ReportDate": "2016-11-10"
},
{
"id": "212",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Add Funds",
"TransactionInfoId": "234048369",
"TransactionId": "264",
"ParentTransactionId": "",
"TransactionType": "+CK Pending",
"TransactionDate": "2016-11-10 01:00:32",
"FundDate": "2016-11-10 01:00:32",
"NameAndEmail": "Vantage Card Services",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "1848..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "1.88",
"GrossAmount": "1.88",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "1.88",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "212",
"ReportDate": "2016-11-10"
},
{
"id": "213",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "Withdraw Funds",
"TransactionInfoId": "234048371",
"TransactionId": "265",
"ParentTransactionId": "",
"TransactionType": "-CK Pending",
"TransactionDate": "2016-11-10 01:00:33",
"FundDate": "2016-11-10 01:00:33",
"NameAndEmail": "Vantage Card Services",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "1848..1623",
"AccountAndType": "Checking",
"AuthorizationAmount": "-2.20",
"GrossAmount": "-2.20",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "-2.20",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"RawSourceId": "213",
"ReportDate": "2016-11-10"
}
]
}
Deposit Detail Report Version 2 (GET) https://reporting.vantagepay.io/api/txreports/v2/DDR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "DDR",
"ReportName": "Deposit Detail Report",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2016-11-10",
"EndDate": "2016-11-10",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "203",
"GatewayId": "1",
"SweepBatchId": "2069473",
"AffiliateId": "[AFFILIATE ID]",
"MerchantId": "[MERCHANT ID]",
"InvoiceNumber": "",
"TransactionInfoId": "233943980",
"TransactionId": "260",
"ParentTransactionId": "",
"TransactionType": "+ACH Payment",
"TransactionDate": "2016-11-09 01:01:01",
"FundDate": "2016-11-09 09:27:03",
"NameAndEmail": "test test",
"TransactionDetailEmail": "",
"TransactionDetailAccount": "0661..2345",
"AccountAndType": "Checking",
"AuthorizationAmount": "1.00",
"GrossAmount": "1.00",
"DiscountFee": "0.00",
"PerTransactionFee": "0.00",
"Credit": "0.00",
"Fee": "0.00",
"NetAmount": "1.00",
"UserName": "",
"Comment1": "Test Comment1",
"Comment2": "",
"ExpDate": "",
"ResponseCode": "",
"ResponseCodeDescription": "",
"AVSCode": "",
"AVSCodeDescription": "",
"AuthCode": "",
"AuthCurrencyCode": "USD",
"TransactionNumCount": "11",
"GrossAmountSum": "0.00",
"DiscountFeesSum": "0.00",
"PerTransactionFeesSum": "0.00",
"ProcessingCreditsSum": "0.00",
"FeesSum": "0.00",
"NetAmountSum": "0.00",
"SweepID": "700000",
"CardPresent": "",
"NachaEffectiveEntryDate": "2016-11-09",
"TraceNumber": "091000018066237",
"RawSourceId": "203",
"ReportDate": "2016-11-10"
}
]
}
Gross Billing Invoice Report (GET) https://reporting.vantagepay.io/api/txreports/v1/GBI/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "GBI",
"ReportName": "Gross Billing Invoice",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2017-03-08",
"EndDate": "2017-03-08",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"GatewayId": "[GATEWAY ID]",
"AffiliateId": "[AFFILIATE ID]",
"AffiliateName": "[AFFILIATE NAME]",
"AccountNum": "00000000",
"MerchantName": "[MERCHANT NAME]",
"PropayInvoicenumber": "000000",
"InvoiceDate": "2017-03-05 05:15:00",
"PaymentDate": "2017-03-05 05:15:00",
"PaymentAmount": "0",
"InvNum": "Withdraw Funds",
"TransDescription": "=-CK",
"TransactionDate": "2017-03-03 16:30:00",
"GrossAmount": "3.63",
"NetAmount": "3.63",
"InvoiceAmount": "0",
"GrossAmountSum": "3.63",
"NetAmountSum": "3.63",
"InvoiceAmountSum": "0",
"TransactionInfoId": "000000",
"ReportDate": "2017-03-08"
}
]
}
Gross Billing Invoice Report V2 (GET) https://reporting.vantagepay.io/api/txreports/v2/GBI/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Removed the 'Sum' fields
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "GBI",
"ReportName": "Gross Billing Invoice",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2017-03-08",
"EndDate": "2017-03-08",
"OtherParams": {
"key": "[KEY]"
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"GatewayId": "[GATEWAY ID]",
"AffiliateId": "[AFFILIATE ID]",
"AffiliateName": "[AFFILIATE NAME]",
"AccountNum": "00000000",
"MerchantName": "[MERCHANT NAME]",
"PropayInvoicenumber": "000000",
"InvoiceDate": "2017-03-05 05:15:00",
"PaymentDate": "2017-03-05 05:15:00",
"PaymentAmount": "0",
"InvNum": "Withdraw Funds",
"TransDescription": "=-CK",
"TransactionDate": "2017-03-03 16:30:00",
"GrossAmount": "3.63",
"NetAmount": "3.63",
"InvoiceAmount": "0",
"TransactionInfoId": "000000",
"ReportDate": "2017-03-08"
}
]
}
Submitted Interchange Qualification Report (GET) https://reporting.vantagepay.io/api/txreports/v1/SIQR/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams":{
"ReportType":"SIQR",
"ReportName":"Submitted Interchange Qualification Report",
"AffiliateId":"[AFFILIATE ID]",
"StartDate":"2017-07-09",
"EndDate":"2017-07-010",
"OtherParams":{
"key":"[KEY]"
}
},
"RequestResults":{
"ResultCode":200,
"ResultValue":"SUCCESS",
"ResultMessage":""
},
"Transactions":[
{
"GatewayId":"[GATEWAY ID]",
"AffiliateId":"[AFFILIATE ID]",
"Affiliation":"[AFFILIATE NAME]",
"MerchantId":"[MERCHANT ID]",
"MCC":"[MCC]",
"InvoiceNumber":"[INVOICE NUMBER]",
"TransactionInfoId":"[TRANSACTION INFO ID]",
"TransactionId":"[TRANSACTION ID]",
"ParentTransactionId":"",
"TransactionDate":"2017-06-29 00:00:00",
"CardType":"Amex",
"DebitCredit":"Credit",
"ProductId":"",
"ProductDescription":"",
"QualificationDescription":"AMERICAN EXPRESS",
"Amount":"10.10",
"PerTranRev":"0.00",
"DiscRev":"0.30",
"DiscRate":"0.0000000",
"PerTranRate":"0.00",
"Discount":"0.000000000",
"Interchange":"0.000000000",
"Diff":"0.300000000",
"ParentTransactionInfoId":"",
"SettlementDate":"2017-06-29",
"ReportDate":"2017-07-10"
},
{
"GatewayId":"[GATEWAY ID]",
"AffiliateId":"[AFFILIATE ID]",
"Affiliation":"[AFFILIATE NAME]",
"MerchantId":"[AFFILIATE ID]",
"MCC":"[MCC]",
"InvoiceNumber":"[INVOICE NUMBER]",
"TransactionInfoId":"[TRANSACTION INFO ID]",
"TransactionId":"[TRANSACTION ID]",
"ParentTransactionId":"",
"TransactionDate":"2017-06-29 00:00:00",
"CardType":"Amex",
"DebitCredit":"Credit",
"ProductId":"",
"ProductDescription":"",
"QualificationDescription":"AMERICAN EXPRESS",
"Amount":"5.10",
"PerTranRev":"0.00",
"DiscRev":"0.15",
"DiscRate":"0.0000000",
"PerTranRate":"0.00",
"Discount":"0.000000000",
"Interchange":"0.000000000",
"Diff":"0.150000000",
"ParentTransactionInfoId":"",
"SettlementDate":"2017-06-29",
"ReportDate":"2017-07-10"
}
]
}
Affiliate Merchant Details Report (GET) https://reporting.vantagepay.io/api/txreports/v1/AMD/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]&filter=[OPTIONAL FILTER]
Optional Parameters
&filter=alert
returns only merchants that are currently unable to process payments.
Response Class (Status 200)
OK
{
"RequestParams":{
"ReportType":"AffiliateMerchantDetails",
"ReportName":"Affiliate Merchant Detail Report",
"AffiliateId":"[AFFILIATE ID]",
"StartDate":"2017-07-09",
"EndDate":"2017-07-010",
"OtherParams":{
"key":"[KEY]",
"filter":"alerts"
}
},
"RequestResults":{
"ResultCode":200,
"ResultValue":"SUCCESS",
"ResultMessage":""
},
"Transactions":[
{
"GatewayId": "[GATEWAY ID]",
"AffiliateId": "[AFFILIATE ID]",
"AccountNumber":"[ACCOUNT NUMBER]",
"TargetId": "[Aptexx Target ID - ONLY FOR 4 DIGIT SUB AFFILIATES}",
"DoingBusinessAs":"[BUSINESS NAME]",
"Tier":"Tier1",
"Email":"[EMAIL]",
"ExternalId":" ",
"FirstName":"John",
"LastName":"Smith",
"HomeAddress":"Street name",
"ApartmentNumber":"",
"City":"City",
"StateProvince":"CA",
"PostalCode":"ZIP",
"Country":"USA",
"Phone":"XXXXXXXXXX",
"ApplicationDate":"7/1/2017 12:00:00 AM",
"ExpirationDate":"7/1/2018 12:00:00 AM",
"NonExpiring":"1",
"AccountStatus":"Ready To Process ",
"SweepCanACHOut":"0",
"SweepCanACHIn":"1",
"SweepCanProPayOut":"1",
"SweepBankAccountValidated":"1",
"SweepInTransactionLimit":"$ 7,500.00",
"SweepInMonthlyLimit":"$ 15,000.00",
"SweepInMonthlyVolume":"$ 0.00",
"CCAllowed":"1",
"CCTransactionLimit":"$ 5,000.00",
"CCMonthlyLimit":"25000",
"CCMonthlyVolume":"375",
"CCFundingHoldDays":"0",
"CCRefundLineOfCredit":"$ 5,000.00",
"CCCreditTransactionLimit":"$ 0.00",
"CCCreditMonthlyLimit":"$ 0.00",
"CCCreditMonthlyVolume":"$ 0.00",
"CCCardPesentRates":"False",
"CCCPRateVisaPerTran":"$ 0.00",
"CCCPRateVisaDiscount":"0.000000",
"CCCPRateMCPerTran":"$ 0.00",
"CCCPRateMCDiscount":"0.000000",
"CCCPRateAmexPerTran":"$ 0.00",
"CCCPRateAmexDiscount":"0.000000",
"CCCPRateDiscPerTran":"$ 0.00",
"CCCPRateDiscDiscount":"0.000000",
"CCCPRateRefundPerTran":"$ 0.00",
"CCCPChargebackFee":"$ 20.00",
"CCCNPRateVisaPerTran":"$ 0.00",
"CCCNPRateVisaDiscount":"3.00000",
"CCCNPRateMCPerTran":"$ 0.00",
"CCCNPRateMCDiscount":"3.00000",
"CCCNPRateAmexPerTran":"$ 0.00",
"CCCNPRateAmexDiscount":"3.00000",
"CCCNPRateDiscPerTran":"$ 0.00",
"CCCNPRateDiscDiscount":"3.00000",
"CCCNPRateRefundPerTran":"$ 0.00",
"CCCNPChargebackFee":"$ 20.00",
"ACHPaymentsAllowed":"1",
"ACHPaymentsFundingHoldHours":"0",
"ACHPaymentsTransactionLimit":"$ 5,000.00",
"ACHPaymentsMonthlyLimit":"15000",
"ACHPaymentsMonthlyVolume":"0",
"ACHPaymentsRatePerTran":"$ 0.00",
"ACHPaymentsRateDiscount":"0.000000",
"ACHPaymentsReturnFee":"$ 5.00",
"ACHPaymentNOCFee":"$ 0.00",
"GrossSettleAccount":"True",
"MerchantDescriptor":"DBA",
"VoidCaptured":"True",
"MCC":"XXXX",
"AffiliateName":"Vantage - Abacus",
"DepositRoutingNumber":"XXXXXXXX",
"DepositAccountNumber":"XXXXXXXXXX",
"DepositAccountType":"Savings",
"WithdrawalRoutingNumber":"XXXXXXXXX",
"WithdrawalAccountNumber":"XXXXXXXXXX",
"WithdrawalAccountType":"Savings",
"TaxId":"XXXXXXXXX",
"ReportDate":"2017-08-11"
}
]
}
Ensure Billing Report (GET) https://reporting.vantagepay.io/api/txreports/v1/ESB/[Affiliate Id]/[Start Date]/[End Date]?key=[Api Key]
Response Class (Status 200)
OK
{
{
"RequestParams": {
"ReportType": "ESB",
"ReportName": "Ensure Billing Reports",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "2018-08-07",
"EndDate": "2018-08-07",
"OtherParams": {
"key": [KEY]
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"id": "81",
"GatewayId": "1",
"AffiliateId": "[AffiliateID]",
"Token": "[GUID]",
"PayerId": "8338491159501486",
"OldCardCardNumber": "512345******9876",
"OldCardExpDate": "1119",
"NewCardCardNumber": "512345******9876",
"NewCardExpDate": "1119",
"ResponseCode": "1",
"ResponseCodeDescription": "Success",
"ResponseDate": "8/6/2018 1:01:40 PM",
"ReportDate": "2018-08-07"
}
]
}
Sweep Alerts (GET) https://reporting.vantagepay.io/api/txreports/v1/Sweep/[Affiliate Id]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "SWEEP",
"ReportName": "Sweeps Alerts",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "1980-01-01",
"EndDate": "2100-12-31",
"OtherParams": {
"key": [KEY]
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"AffiliateId": "16000",
"AffiliateName": "Vantage-Test Affiliate",
"MerchantID": "30000000",
"DoingBusinessAs": "Test Merchant",
"Tier": "Tier1SSN",
"DaysSweepsOff": "5",
"HeldBalance": "5800.0000",
"Reason": "CK Out Reject.",
"ReturnResponse": "R02",
"ReturnDescription": "Account Closed",
"Recommendations": "We need an updated bank account."
},
{
"AffiliateId": "16000",
"AffiliateName": "Vantage-Test Affiliate",
"MerchantID": "30000000",
"DoingBusinessAs": "Test Merchant",
"Tier": "Tier0",
"DaysSweepsOff": "3",
"HeldBalance": "1300.0000",
"Reason": "ACH Limits.",
"ReturnResponse": "",
"ReturnDescription": "",
"Recommendations": "Review Limits/Adjust Tier."
}
]
}
Sweeps at Risk Report (All report other than LP should be available by 8 AM EST. LP Reports should be available by 9 AM EST) (GET) https://reporting.vantagepay.io/api/txreports/v1/SweepsRisk/[Affiliate Id]?key=[Api Key]
Response Class (Status 200)
OK
{
"RequestParams": {
"ReportType": "SWEEPRISK",
"ReportName": "SweepsAtRisk",
"AffiliateId": "[AFFILIATE ID]",
"StartDate": "1980-01-01",
"EndDate": "2100-12-31",
"OtherParams": {
"key": [KEY]
}
},
"RequestResults": {
"ResultCode": 200,
"ResultValue": "SUCCESS",
"ResultMessage": ""
},
"Transactions": [
{
"AffiliateId": "16000",
"AffiliateName": "Vantage-Test Affiliate",
"MerchantID": "30000000",
"DoingBusinessAs": "Test Merchant",
"Tier": "Tier0",
"CCMonthlyVolume": "0",
"CCMonthlyLimit": "2500",
"ACHMonthlyVolume": "2500",
"ACHMonthlyLimit": "2500",
"CCPercentage": "0.00",
"ACHPercentage": "100.00"
}
]
}