Skip to content

Reports

Generate payout, statement and wallet reports.

Operations

Payout Report

Request

Payout report as CSV, one row per payment in the window, streamed as it is read.

start and end bound the window on payment creation time, and country picks the corridor; both are required. status narrows to the listed statuses. ids narrows to specific payments — set external to supply the external_id values from the original payment requests instead of SwiftX ids. An id that matches nothing still gets a row carrying just that id, so the report accounts for every id sent.

Beneficiary account validation is not part of this report.

Security
bearerAuth
Bodyapplication/jsonrequired
startstring, (date-time)(Start)required

Start of the window, on order creation

endstring, (date-time)(End)required

End of the window, exclusive

countrystring(ApiCountry)required

Payment country

Enum:"BGD""IND""PAK""PHL""NPL""EGY""VNM""NGA"
statusArray of strings or null(Status)
Any of:

Filter on the effective status — the one the report reports, overrides applied

<= 9 items
Array of strings
externalboolean(External)

When true, ids holds external_id values from the original payment requests rather than SwiftX ids

Default:false
idsArray of any or null(Ids)
Any of:

Only report these payments. An id that matches nothing still gets a row, carrying just the id.

sorting_orderstring(SortingOrder)

ORDER BY direction with explicit nulls handling.

ASC => ASC NULLS LAST DESC => DESC NULLS LAST

Both place nulls at the end, which should be a sane default

Default:"desc"
Enum:"asc""desc"
curl -i -X POST \
  https://docs.swiftxpay.com/_mock/openapi/v3/reports/payout \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "country": "BGD",
    "status": [
      "queued"
    ],
    "external": false,
    "ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "sorting_order": "asc"
  }'

Responses

Successful Response

Response
No content