Skip to navigation
DisbursementsDisbursements

List disbursements

Returns a list of disbursements.

Authentication

AuthorizationBearer

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

Query parameters

organization_idstringOptional
The unique identifier for the organization
page_limitintegerOptional

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

next_page_tokenstringOptional
A token to use to retrieve the next page of results. This is useful for paginating over many pages of results. If set, all other arguments are expected to be kept the same as previous calls and the value of this field should be from the nextPageToken in the previous response.
includesstringOptional

A comma separated list of fields to include in the response. Possible values include:

  • organization: Include the organization object in the response.
idempotency_keystringOptional

Filter to the disbursement created with this exact Idempotency-Key header on POST /v1/disbursements. Useful for recovering the result of a create request when the response was lost (e.g. network timeout). Returns at most one disbursement. Disbursements created via POST /v1/disbursements/bulk cannot be looked up this way.

Response headers

X-Request-IdstringOptional
The unique identifier for the request

Response

The response for Disbursements.list
resultslist of objectsOptional
next_page_tokenstringOptional

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error