Overview
This report allows you to reconcile transactions, fees charged by acquirers and Solidgate, as well as acquirers’ exchange rates.
Moreover, the report offers the flexibility to analyze financial data based on various parameters such as issuing country, payment method, card brand, and more. This makes it a valuable tool for gaining insights into your payments’ financial performance.
Run a report
In summary, to run a report, you need to make an API request, get the report URL in the response, and then download the report using the URL and correct authorization credentials.
Step 1Make a request to generate the report by providing the necessary parameters, such as using the appropriate API endpoint in two ways:
- Financial entries by date range API ( date_from , date_to )
-
Financial entries by settlement
API
(
settlement_id
)
Upon successful submission, the API will respond with a
report_url
where the generated report can be downloaded in CSV format.
Download the report
API
using the
report_url
. It is crucial to use the same
Guide
Learn to authenticate API requests and fix validation errors effectively.
authorization credentials
(
publicKey
+
secretKey
) used to make the API request for downloading the report.
Since the report is prepared asynchronously, it may take some time before it is ready for download. If the report is not yet ready, the API Reference will return the corresponding status code.
Report structure
| Parameter | Description | Value sample |
|---|---|---|
id |
Financial record ID. | ft_1mc2209090000_fKJScPc |
order_id |
Order ID generated by the merchant. | mvbcdj1335d |
external_psp_order_id |
Order ID generated by Solidgate. | 2343253452323412sd12ds |
created_at |
The timestamp of when the record was created by Solidgate’s financial system. Format: YYYY-MM-DD HH:MM:SS | 2021-07-23 17:39:50 |
transaction_datetime_provider |
The date on which the transaction or fee occurred. Dates in the timezone of the provider. | 2021-07-23 17:39:50 |
transaction_datetime_utc |
The date on which the transaction or fee occurred. Dates in UTC. | 2023-07-23 17:39:50 |
accounting_date |
Determines which settlement or invoice the record will be included in. Only populated for provider = ‘Solidgate’. Format: YYYY-MM-DD | 2021-07-23 |
amount |
The original amount of the financial record. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents. | 1020 |
currency |
The currency in which the financial record is initially defined (3-letter code under ISO 4217). | EUR |
currency_minor_units |
Minor units of the currency. | 100 |
payout_amount |
The payout amount. Expressed in minor currency units (as an integer). For instance, 1020 means 10 USD and 20 cents. | 1020 |
payout_currency |
The payout currency (3-letter code under ISO 4217). | EUR |
payout_currency_minor_units |
Minor units of the payout currency. | 100 |
record_type_key |
Type of financial record. For example: SALE, REFUND, DISCOUNT FEE, CHARGEBACK FEE. | SALE |
provider |
Name of the Provider that processed the transaction. | Solidgate |
payment_method |
Payment method. | card |
card_brand |
Card Brand. | VISA |
geo_country |
Customer country. The code shall have the format ISO 3166-1 alpha-3. | USA |
issuing_country |
Country of the issuing bank. | USA |
Related articles FAQ