Settlements¶
The Settlements set of mutations and queries help you with the reconciliation of payments that we do to the merchant’s Bank Account.
We provide the ability to download CSV files that can be used in your favorite data processing tool, in addition to responses in JSON format that can be used to automate integration with our system.
Regardless of the format, reports can be generated with custom date ranges.
Generate CSV Report¶
Settlement reports contain all transactions recorded in our system and allows you to reconcile the payout amount with the orders in your system.
It is possible to generate a report with a custom date range. Use the generateReport mutation
for this purpose.
Once this mutation is executed, you will receive a waitToken which you can use to poll or subscribe
to get a link to a downloadable CSV file.
With the generated waitToken we can now subscribe to or poll the settlementReport query field. Use the waitToken value
as the reportId variable in the following example:
Note
Links returned by this query will be available for 10 minutes. Do no store the link as it will not work after the expiration time.
The most typical date range that is generated is for the previous day, these reports are automatically pre-generated at the beginning of each day so they can be downloaded faster. You still need to follow the procedure above to get the daily generated reports.
Settlement Summary¶
You can get the aggregated data for multiple settlement reports for a given period of time. Each line in the report is aggregated by the type of transaction.
Use the settlementSummary and pass the time range you are interested in:
Transaction Summary¶
These reports contain an aggregated summary for each order and transaction type.
Every transaction is related to a unique purchase id. All related transactions
of a purchase are associated with this identifier.
Each purchase is associated with the provided merchantReference, which is also present
in this report.
Pagination¶
The cursor_key variable is special. It should be treated as an opaque string containing the information
for fetching the next page. In the previous example, we fetched a batch of size 5, to fetch the next
5 items, we need to pass any of the values found in the next_page field for each row.