Integration GuideAPI Reference
API Reference

Request a client reconciliation report for a period

post
https://sandbox.8b.world/reconciliation/api/v2/outgoing-reconciliations/settlement-accounts//reports/on-demand

Starts asynchronous generation of a reconciliation report (registry) for an arbitrary period of up to 40 calendar days. The response is returned immediately with the status GENERATION_STARTED; poll the status endpoint with the returned reportId until the status becomes GENERATED. Only one report per Settlement Account can be generated at a time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Settlement Account ID with the SA prefix.

Body Params
string
required

First day of the period, YYYY-MM-DD. The period starts at 00:00:00 in the given timezone.

string
required

Last day of the period, YYYY-MM-DD, inclusive. The period ends at 23:59:59 in the given timezone. The period length must not exceed 40 calendar days.

string
required

Timezone in IANA format, used to cut the period boundaries and to render dates in the report.

transactionTypeAndStatus
array of objects
required
length ≥ 1

Transaction types and statuses to include in the report.

transactionTypeAndStatus*
string
enum
Defaults to XLSX

Report file format.

Allowed:
Responses

Updated about 1 hour ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago

Did this page help you?