getCustomReport

HTTP method: GET

Use the getCustomReport method to retrieve a CSV file with a custom report. You can find the id under Finances > Transaction Reports in the Merchant Interface, if you have API credentials.

To enable custom reports, contact us.

* datetime can be specified only for the report "Transactions with acquirer reconciliation id and funding data"
For information about the available custom reports, see Custom reports.
Test URL https://testgateway.altapaysecure.com/merchant/API/<method>
Production URL https://<YourShopName>.altapaysecure.com/merchant/API/<method>
Parameter Description Type Mandatory
id The ID of the custom report.

You can see the ID in the URL of the custom report in the Merchant Interface, under Finances > Transaction Reports. For example https://testgateway.altapaysecure.com/merchant/reports/customReport/b6192aba-ee48-453f-b908-1c8c4507ff7f

For more information about the Merchant Information Interface, see Using the MII.

 string(100) X
from_date The from date, e.g. 2017-11-08 date | datetime*  
to_date The to date, e.g. 2017-11-18 date | datetime*  
parent_state all|capture|refund|preauth|release|card_verify|... string  
conversion_state all|declined|error string  
update   string  

GET call

https://<YourShopName>.altapaysecure.com/merchant/API/getCustomReport?id=eef152be-8e0f-4c35-9cd5-138a80edb653&from_date=2020-02-04&to_date=2020-02-17&parent_state=all&conversion_state=all&update=Update

CSV response

"Order ID";"Payment ID";"Terminal title";"Transaction Date";Amount;Currency;Acquirer
orderid;7;"AltaPay Soap Test Terminal";"2020-11-20 15:37:36";12.00;EUR;SoapTestAcquirer