API ReferenceFacilities

Retrieve a disbursement by its id

Retrieve a disbursement by its id

Path parameters

facility_idstringRequired

The facility_id of the facility you want to retrieve

disbursement_idstringRequired

The disbursement_id of the disbursement you want to retrieve

Headers

AuthorizationstringRequired

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

Response

This endpoint returns an object.
idstring

The id of the disbursement

facility_idstring
amountinteger

The amount of the disbursement, in cents (e.g. 1000 = $10.00)

statusenum

The status of the disbursement

created_ondatetime

Timestamp the disbursement object is created on

transfer_typeenum

The type of transfer that the disbursement was (ACH, ledger only, or special cases like refunds)

Allowed values:
failure_reasonstringOptional

A reason for the failure if any exists

datestringOptional

The date of the disbursement (YYYY-MM-DD)

Errors