Skip to main content
GET
List Settlement Batches

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-org-id
string
default:""
required

The Organization ID header used for authorization

x-partner-id
string
default:""
required

The Partner ID header used for authorization

Query Parameters

status
enum<string>

Filter batches by processing status

Available options:
PROCESSING,
COMPLETED,
FAILED
cutoff_from
integer<int64>

Unix timestamp (seconds) for the inclusive cutoff start range

cutoff_to
integer<int64>

Unix timestamp (seconds) for the inclusive cutoff end range

page
integer<int32>

Results page number (minimum 1)

Required range: x >= 1
limit
integer<int32>

Page size (maximum 100)

Required range: 1 <= x <= 100

Response

Response containing settlement batches visible to the partner

Standard response structure for successful operations

ok
boolean

Indicates if the operation was successful

Example:

true

data
object

Contains the response data