Payout Order Retrieval

Payout orders can be retrieved by order ID, by merchant reference ID, or through a filtered list.

Endpoint Paths

GET /api/v1/orders/payout/{id}

GET /api/v1/orders/payout?reference_id={reference_id}

GET /api/v1/orders/payout/list

Overview

Retrieval mode	Endpoint path	Parameters	Request body	Response structure
Get order by ID	/api/v1/orders/payout/{id}	id path parameter	None	Single payout order object
Get orders by reference ID	/api/v1/orders/payout	reference_id query parameter	None	Array of payout order objects
List payout orders	/api/v1/orders/payout/list	Pagination and filter query parameters	None	Paginated response object with content array

Retrieval Modes

Get Order by ID

Use this mode to retrieve one specific payout order by its system-generated order identifier.

GET /api/v1/orders/payout/3fa85f64-5717-4562-b3fc-2c963f66afa6

Get Order by ID›

Get Orders by Reference ID

Use this mode to retrieve payout orders by the merchant-side order reference identifier.

GET /api/v1/orders/payout?reference_id=merchant-payout-12345

Get Orders by Reference ID›

List Payout Orders

Use this mode to retrieve a paginated list of payout orders by query filters.

GET /api/v1/orders/payout/list?page=1&groupId=3fa85f64-5717-4562-b3fc-2c963f66afa6&statuses=CREATED&statuses=SUCCESS

List filters are sent as query parameters. The id and reference_id filters are not used on the list endpoint.

List Payout Orders›

Authentication

All retrieval modes require the standard request headers.

Headers

X-Api-Key-Id string · uuid required

API key identifier issued for the merchant integration.

X-Signature string required

Request signature generated from the HTTP method, request path without query string, raw request body, and timestamp.

X-Timestamp integer · int64 required

Unix epoch timestamp in seconds used in the signature base string.

For GET retrieval requests, the signature base string uses an empty request body value.

For signature generation rules, see Request Signature Authentication.

Response Structures

Single Order Object

Returned when the request uses the {id} path parameter.

Array of Order Objects

Returned when the request includes the reference_id query parameter.

Paginated Object

Returned when the request uses the list endpoint with pagination and filter query parameters.