Facilities

Retrieve a disbursement by its id

GET
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

Response

This endpoint returns an object
id
string
The id of the disbursement
facility_id
string
amount
integer
The amount of the disbursement, in cents (e.g. 1000 = $10.00)
status
enum
The status of the disbursement
Allowed values: pendingprocessingsettledfailedcancelled
created_on
datetime
Timestamp the disbursement object is created on
transfer_type
enum
The type of transfer to use for the disbursement
Allowed values: standardnext_daysame_daynone
failure_reason
stringOptional
A reason for the failure if any exists
date
stringOptional
The date of the disbursement (YYYY-MM-DD)

Errors