API Reference

Get settlement batches

get
https://example.com/v1/pay/settlements/batches

Retrieve paginated settlement batches with filtering options

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

Page number for pagination

string

Number of items per page

string

Start date for filtering (ISO 8601 format)

string

End date for filtering (ISO 8601 format)

string

Filter by settlement reference

string
enum

Filter by currency

number

Minimum amount filter

number

Maximum amount filter

string

Filter by settlement status

string

Search across settlement reference, amount, currency, and status

string

Export as CSV

Headers
string
required
length ≥ 1

Starks API Key for authentication

Responses

Updated 7 months ago

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

Updated 7 months ago