Statement Report

Export a merchant statement report by sending a date range and file format to the statement export endpoint.

Use the Merchant Statement API to generate a statement report for a selected period. The API returns the report as a downloadable file, such as statement.csv when you request format: "csv".

Endpoint

POST https://backend.sa.amwal.tech/accounting/merchant_statement/

Prerequisites

Get your merchant API key from the Merchant Portal.
Get your X-Amwal-Key for the environment you want to export from.
Choose the report date range using YYYY-MM-DD format.

Export a statement report

Send a POST request with the report start date, end date, and export format.

curl 'https://backend.sa.amwal.tech/accounting/merchant_statement/' \
  --compressed \
  -X POST \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-Amwal-Key: YOUR_AMWAL_KEY' \
  --data-raw '{"start":"2026-01-01","end":"2026-05-10","format":"csv"}' \
  -o statement.csv

When the request succeeds, cURL writes the exported report to statement.csv in your current directory.

Request headers

Header	Required	Description
`Authorization`	Yes	Your merchant API key.
`Accept`	Yes	Set to `application/json`.
`Content-Type`	Yes	Set to `application/json` because the request body is JSON.
`X-Amwal-Key`	Yes	The Amwal environment key for the merchant account you are exporting from.

Request body fields

Field	Type	Required	Description	Example
`start`	string	Yes	Start date for the statement report in `YYYY-MM-DD` format.	`2026-01-01`
`end`	string	Yes	End date for the statement report in `YYYY-MM-DD` format.	`2026-05-10`
`format`	string	Yes	Export file format. Use `csv` to download a CSV report.	`csv`

Output file

Use the -o option to save the exported report to a file:

-o statement.csv

You can change the filename to match your reporting workflow, for example merchant-statement-2026-01-01-to-2026-05-10.csv.

Highlighted output fields

The exported statement report includes the following fields:

Field	Description	Possible values
`Date`	Date associated with the statement report row.	—
`Transaction_id`	Unique transaction identifier in the statement report.	—
`Order ID`	Merchant order identifier associated with the transaction.	—
`Description`	Description for the transaction report row.	—
`Payment Option`	Payment option used for the transaction.	—
`Installment Duration`	Installment plan duration selected for the transaction.	`3 months`, `6 months`, `12 months`, `24 months`
`Payment Link ID`	Payment link identifier associated with the transaction.	—
`Order Refund ID`	Refund identifier associated with the order, when a refund exists.	—
`Disputed Status`	Current dispute status for the transaction.	`PENDING`, `RESOLVED`, `LOST`
`Debit`	Debit amount recorded for the statement report row.	—
`Credit`	Credit amount recorded for the statement report row.	—
`Balance`	Running balance after the statement report row is applied.	—
`Payment Brand`	Payment brand used for the transaction.	—
`Branch Name`	Branch name associated with the transaction.	—
`Merchant Payout ID`	Payout ID linked to each transaction..	—

key
Do not publish real Authorization or X-Amwal-Key values in your documentation or client-side code. Store keys securely and replace the placeholders before running the request.

Sample Reports

View the sample reports for Statements, Payouts, and VAT Invoices to understand each report format.