Sign in
settlements

aid_settlement_generate_test_report

Generate a test settlement report. Only available in test.

scopes:

  • admin:billing
  • admin:reports
post/accounts/{aid}/settlements/reports/generate-test-report

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

transaction_idsstring[]

Array of transaction IDs to include in the report. If a transaction has already been settled earlier it will be ignored. An empty array will be ignored. Should not be combined with number_of_transactions or date_range.

number_of_transactionsinteger

Number of transactions to include. Can be combined with date_range, but should not be combined with transaction_ids. Must be a positive integer.

Example request

{
  "transaction_ids": [
    "T12345678.aaaabbbbccccddddeeee01",
    "T12345678.aaaabbbbccccddddeeee02"
  ],
  "number_of_transactions": 10,
  "date_range": {
    "start_date": "2025-12-01",
    "end_date": "2025-12-07"
  }
}

Response

No transactions to generate report. This can be if there are no new transaction events to generate report for.

messagestring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.