Skip to main content
List All Disbursements

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Headers

X-Wallet-Id
string

Optional. Narrows the results to a single distribution account. Omit it to cover every account you have access to.

Query Parameters

page
number
default:1

The page requested.

page_limit
number
default:20

Define how many results will be returned in the response.

q
string

A search term used to query through the disbursement names.

status
enum<string>

Comma-separated list of disbursement statuses to filter by.

Available options:
DRAFT,
READY,
STARTED,
PAUSED,
COMPLETED,
CANCELED
created_at_after
string

Only return disbursements that are created after this date. Format: YYYY-MM-DD

created_at_before
string

Only return disbursements that are created before this date. Format: YYYY-MM-DD

sort
enum<string>
default:created_at

Field used to sort disbursements

Available options:
name,
created_at
direction
enum<string>
default:desc

Direction for sorting disbursements.

Available options:
asc,
desc

Response

A list of Disbursement details

pagination
object
data
object[]