Query Payout Summaries

Return a paginated list of matching payout summaries.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
merchantId	string Merchant to show entries for
createdAfter	string <date-time> Return payouts that were created at or after this timestamp in ISO-8601 format. Defaults to 30 days ago. Example: createdAfter=2025-01-14T23:51:47.270687875Z
createdBefore	string <date-time> Return payouts that were created at or before this timestamp in ISO-8601 format. Defaults to today. The total date range must be 180 days or less.

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/transactions/payouts

Request samples

Curl
JavaScript

Response samples

application/json

[{"payoutId": "payout_Z4b4jHGMLxLtxuaD",
"currency": "AUD",
"settlementDate": "2019-08-24",
"merchantId": "mcht_Z4b4i3GMLxLtxuZ2",
"merchantBusinessName": "string",
"amount": 0,
"openingBalance": 0,
"closingBalance": 0,
"totalAmount": 0,
"status": "paid",
"bankAccountNumber": "string",
"paymentChannel": "direct_entry",
"statementDescriptor": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]