API ReferenceFacilities

Create a disbursement for a facility

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

Path parameters

facility_idstringRequired

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
amountintegerRequired

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

transfer_typeenumRequired

The type of transfer to use for the disbursement (ACH or none [ledger only])

Allowed values:
disbursement_bank_accountobjectOptional
The bank account to disburse to
settlement_priorityenumOptional
The speed at which the transfer should execute when ACH is used
Allowed values:

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_reasonstring or null
A reason for the failure if any exists
datestring or null

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

Errors