Platform reports

Copy for LLMView as Markdown

Platform reports provide programmatic access to data about your connected accounts and their activity. You can use Create a platform report API to generate reports and Get a platform report API to download them as CSV files.

Each report type covers a specific domain of connected account data. See the sections below for the fields included in each report type.

Balance report

The balance report provides a snapshot of current wallet balances across all your connected accounts. Specify type as BALANCE_REPORT in Create a platform report API.

Shell

1curl -X POST https://api-demo.airwallex.com/api/v1/platform_reports/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "file_format": "CSV",
6    "type": "BALANCE_REPORT"
7  }'

The downloadable report retrieved via Get a platform report API will include the following fields.

Field	Description
`account_id`	The ID of the connected account.
`currency`	The wallet currency.
`available_balance`	The balance available for use.
`reserved_balance`	The balance reserved for pending transactions.
`total_balance`	The total balance, including available and reserved amounts.
`last_update`	The timestamp when the balance was last updated.

Transaction reconciliation report

The transaction reconciliation report lists all financial transactions across your connected accounts. Specify type as TRANSACTION_RECON_REPORT in Create a platform report API.

Shell

1curl -X POST https://api-demo.airwallex.com/api/v1/platform_reports/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "file_format": "CSV",
6    "from_created_at": "2024-05-01T00:00:00+0000",
7    "to_created_at": "2024-05-10T07:00:00+0000",
8    "type": "TRANSACTION_RECON_REPORT"
9  }'

The downloadable report retrieved via Get a platform report API will include the following fields.

Field	Description
`transaction_id`	The unique ID of the transaction.
`request_id`	The client request ID submitted with the transaction.
`source_id`	The ID of the source transaction.
`batch_id`	The batch ID, if the transaction was part of a batch.
`account_id`	The ID of the connected account.
`conversion_id`	The ID of the associated conversion, if applicable.
`created_at`	The timestamp when the transaction was created.
`estimated_settled_at`	The estimated settlement timestamp.
`settled_at`	The actual settlement timestamp.
`last_update`	The timestamp when the record was last updated.
`status`	The transaction status.
`settlement_amount`	The settlement amount. For `CONVERSION` type transactions, this equals `net_amount`.
`fee`	The transaction fee amount.
`net_amount`	The net transaction amount after fees.
`exchange_rate`	The exchange rate applied to the transaction.
`currency`	The transaction currency.
`currency_pair`	The currency pair, for conversion transactions.
`type`	The transaction source type, for example `CONVERSION` or `TRANSFER`.
`financial_transaction_type`	The financial transaction type.
`payment_method`	The payment method used.
`description`	The transaction description.

Payout report

The payout report lists all payout transactions across your connected accounts. Specify type as PAYOUT_REPORT in Create a platform report API.

Shell

1curl -X POST https://api-demo.airwallex.com/api/v1/platform_reports/create \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "file_format": "CSV",
6    "from_created_at": "2024-05-01T00:00:00+0000",
7    "to_created_at": "2024-05-10T07:00:00+0000",
8    "type": "PAYOUT_REPORT"
9  }'

The downloadable report retrieved via Get a platform report API will include the following fields.

Field	Description
`transaction_id`	The unique ID of the payout transaction.
`request_id`	The client request ID submitted with the payout.
`account_id`	The ID of the connected account.
`created_at`	The timestamp when the payout was created.
`status`	The payout status.
`cancelled_at`	The timestamp when the payout was cancelled, if applicable.
`last_update`	The timestamp when the record was last updated.
`failure_reason`	The reason for failure, if the payout failed.
`beneficiary_bank_account_name`	The name of the beneficiary bank account holder.
`beneficiary_bank_account_country`	The country of the beneficiary bank account.
`beneficiary_currency`	The currency of the beneficiary account.
`payment_method`	The payment method used.
`local_clearing_system`	The local clearing system used to process the payment.
`source_currency`	The currency debited from the connected account wallet.
`source_amount`	The amount debited from the connected account wallet.
`payment_currency`	The currency in which the payment was sent to the beneficiary.
`payment_amount`	The amount sent to the beneficiary in `payment_currency`.
`reference`	The payment reference.
`short_reference_id`	The short transaction reference.
`underlying_conversion_id`	The ID of the underlying conversion, if a currency conversion was performed.
`metadata`	Additional metadata associated with the payout.

Was this page helpful?