Skip to main content
GET
List settlement requests

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
page
number

The page number to retrieve. Pages are 1-indexed. If omitted, defaults to the first page

​
limit
number

The maximum number of settlement requests to return per page. If omitted, defaults to 20. Maximum is 100

​
status
enum<string>

Filters settlement requests by status. If omitted, settlement requests of all statuses are returned

Available options:
REQUEST_STARTED,
REQUEST_EXPIRED,
REQUEST_CANCELED,
REQUEST_COMPLETED,
REQUEST_REFUNDED,
FUNDS_SENT,
FUNDS_RECEIVING_LATE,
SETTLEMENT_SENT,
SETTLEMENT_COMPLETED,
AWAITING_PAYIN_RECONCILIATION,
PAYIN_CANCELED,
PAYIN_UNDER_REVIEW,
PAYIN_FAILED,
PAYIN_AMOUNT_MISMATCH,
PAYOUT_CANCELED,
PAYOUT_UNDER_REVIEW,
PAYOUT_FAILED
​
external_id
string

Filters settlement requests by the external_id you supplied on create. Exact match.

Response

200

Settlement requests retrieved