v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Reports

Create Report

Creates a report for account transactions, card transactions or transaction settlements.

post/v1/issuing/reports

Headers

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Request body

report_typestring required

The type of report file, only SETTLEMENT and LEDGER can be accepted currently.

start_timestring required

The earliest time for transaction.

end_timestring required

The latest timestamp for transaction.

Example request

{
  "report_type": "SETTLEMENT",
  "start_time": "2024-03-21T17:17:32+08:00",
  "end_time": "2024-03-21T17:17:32+08:00"
}

Response

Create report successfully.

report_idstring required

Unique identifier for the report.

Example response

{
  "report_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7"
}