Create a disbursement for a facility

POST

Create a disbursement for a facility. If disbursements_ach_enabled is false, use none for transfer_type.

Path parameters

facility_idstringRequired

Request

This endpoint expects an object.
amountintegerRequired
The amount of the disbursement, in cents (e.g. 1000 = $10.00)
transfer_typeenumRequired
Allowed values: standardnext_daysame_daynone
The type of transfer to use for the disbursement
disbursement_bank_accountobjectOptional
The bank account to disburse to

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
Allowed values: standardnext_daysame_daynone
The type of transfer to use for the disbursement
failure_reasonstringOptional
A reason for the failure if any exists
datestringOptional
The date of the disbursement (YYYY-MM-DD)

Errors