POST Download Report
The POST Download Report method allows you to download an AndDone authorization, settlement, refund or chargeback report in CSV format.
This method accepts the ReportId and the ReportGenerationLogId. Optionally, if the ReportGenerationLogID is not available, the EventDateTime from the Report webhook payload can be passed in the date parameter. This method returns the report data as a CSV formatted string.
API Versions:
- Version 2.1: Allows the you to download a report in CSV format
- Version 2.2: Adds system report
- Version 2.3: Is the same as version 2.2
| API Endpoint |
| https://api.uat.anddone.com/secure/reports/downloads |
| API Data | Details |
| URI | secure/reports/downloads |
| Method | POST |
| Authorization | API Key Authorization |
| Authorization | |
| x-api-key | API key {env_merchantAccessKey} |
| Request Headers | |
| x-app-key | Merchant ID or App Key {env_merchantId} |
| x-version | API version (e.g., 2.1). If no version is specified, the call will default to version 2.0 of the API. |
| Origin | URL or IP address provided to AndDone as an allowed origin. |
| Content-Type | application/json |
API Version 2.1
Request Parameters
| Field Name | Data Type | Mandatory | Field Length | Description |
|---|---|---|---|---|
| reportId | string | Yes | N/A | Unique identifier of the report definition to download. |
| date | string | Yes | N/A | Report date to download (e.g., MM-DD-YYYY). |
| reportGenerationLogId | string | No | N/A | Specific generation run ID; if omitted, the latest run for the given date is used. |
| fileCompress | boolean | No | N/A | If true, the CSV is returned as a compressed archive. |
Body Request Example (JSON)
{
"reportId": "autho",
"date": "04-04-2022",
"reportGenerationLogId": "",
"fileCompress": true
}
Response Example
Body Response Example (CSV)
MerchantId,TransactionId,TransactionType,MerchantReference,TraceNumber,PaymentMethod,Brand,CreatedOn,Currency,TimeZone,SubTotal,TotalAmount,TechnologyFee,
NetSettlementAmount,IPFSSettlement,SettlementDate,ShopperName,MetaAccount,
MetaPolicyNumber,MetaInvoiceNumber,MetaOther,PayingOnBehalfOf,QuoteId,
BillingAddressLine1,BillingAddressLine2,BillingCountry,BillingState,BillingCity,BillingPostalCode,
FullAccountNumber,eZdmqkdQ,"7c583a8e-157c-498d-a6e7-89bf05391511",Payment,
"7c583a8e-157c-498d-a6e7-89bf05391511","DXDB35GLMS3JC8V5",CARD,DISCOVER,7/9/2024 2:56:29 PM,USD,Eastern,200.99,200.99,0,200.99," ",7/9/2024 3:59:59 PM,"TEST TEST","","45645","","","TEST","TEST","434 ","",USA,AK,Seward,34345-3553,"",
API Version 2.2
Version 2.2 of POST Download Report adds support for the system report.
Request Parameters (v2.2)
| Field Name | Data Type | Mandatory | Field Length | Description |
|---|---|---|---|---|
| reportId | string | Yes | N/A | Unique identifier of the report definition to download. |
| date | string | Yes | N/A | Report date to download (e.g., MM-DD-YYYY). |
| reportGenerationLogId | string | No | N/A | Specific generation run ID; if omitted, the latest run for the given date is used. |
| fileCompress | boolean | No | N/A | If true, the CSV is returned as a compressed archive. |
Response Example (v2.2)
Body Response Example (CSV)
MerchantId,TransactionId,TransactionType,MerchantReference,TraceNumber,PaymentMethod,Brand,CreatedOn,Currency,TimeZone,SubTotal,TotalAmount,TechnologyFee,
NetSettlementAmount,IPFSSettlement,SettlementDate,ShopperName,MetaAccount,
MetaPolicyNumber,MetaInvoiceNumber,MetaOther,PayingOnBehalfOf,QuoteId,
BillingAddressLine1,BillingAddressLine2,BillingCountry,BillingState,BillingCity,BillingPostalCode,
FullAccountNumber,eZdmqkdQ,"7c583a8e-157c-498d-a6e7-89bf05391511",Payment,
"7c583a8e-157c-498d-a6e7-89bf05391511","DXDB35GLMS3JC8V5",CARD,DISCOVER,7/9/2024 2:56:29 PM,USD,Eastern,200.99,200.99,0,200.99," ",7/9/2024 3:59:59 PM,"TEST TEST","","45645","","","TEST","TEST","434 ","",USA,AK,Seward,34345-3553,"",
API Version 2.3
Version 2.3 of POST Download Report adds support for the system report.
Request Parameters (v2.3)
| Field Name | Data Type | Mandatory | Field Length | Description |
|---|---|---|---|---|
| reportId | string | Yes | N/A | Unique identifier of the report definition to download. |
| date | string | Yes | N/A | Report date to download (e.g., MM-DD-YYYY). |
| reportGenerationLogId | string | No | N/A | Specific generation run ID; if omitted, the latest run for the given date is used. |
| fileCompress | boolean | No | N/A | If true, the CSV is returned as a compressed archive. |
Response Example (v2.3)
Body Response Example (CSV)
MerchantId,TransactionId,TransactionType,MerchantReference,TraceNumber,PaymentMethod,Brand,CreatedOn,Currency,TimeZone,SubTotal,TotalAmount,TechnologyFee,
NetSettlementAmount,IPFSSettlement,SettlementDate,ShopperName,MetaAccount,
MetaPolicyNumber,MetaInvoiceNumber,MetaOther,PayingOnBehalfOf,QuoteId,
BillingAddressLine1,BillingAddressLine2,BillingCountry,BillingState,BillingCity,BillingPostalCode,
FullAccountNumber,eZdmqkdQ,"7c583a8e-157c-498d-a6e7-89bf05391511",Payment,
"7c583a8e-157c-498d-a6e7-89bf05391511","DXDB35GLMS3JC8V5",CARD,DISCOVER,7/9/2024 2:56:29 PM,USD,Eastern,200.99,200.99,0,200.99," ",7/9/2024 3:59:59 PM,"TEST TEST","","45645","","","TEST","TEST","434 ","",USA,AK,Seward,34345-3553,"",