List settlement requests

curl --request GET \
  --url https://api-sandbox.superbank.co/v1/settlement-requests \
  --header 'X-Api-Key: <api-key>'

GET

settlement-requests

curl --request GET \
  --url https://api-sandbox.superbank.co/v1/settlement-requests \
  --header 'X-Api-Key: <api-key>'

X-Api-Key

string

header

required

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,

PAYIN_CANCELED,

PAYIN_UNDER_REVIEW,

PAYIN_FAILED,

PAYOUT_CANCELED,

PAYOUT_UNDER_REVIEW,

PAYOUT_FAILED

200

Settlement requests retrieved

⌘I