Skip to main content
POST
/
v1
/
issuing
/
reports
Create Report
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/reports \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "report_type": "SETTLEMENT",
  "start_time": "2024-03-21T17:17:32+08:00",
  "end_time": "2024-03-21T17:17:32+08:00"
}
'
{
  "report_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-idempotency-key
string<uuid>
required

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-of
string

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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Body

application/json
​
report_type
string
required

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

Example:

"SETTLEMENT"

​
start_time
string
required

The earliest time for transaction.

Example:

"2024-03-21T17:17:32+08:00"

​
end_time
string
required

The latest timestamp for transaction.

Example:

"2024-03-21T17:17:32+08:00"

Response

Create report successfully.

​
report_id
string
required

Unique identifier for the report.

Example:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"