Skip to main content
POST
Advance Sandbox Disbursement

Authorizations

Authorization
string
header
required

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

Path Parameters

disbursement_id
string
required

ID of the disbursement object you want to advance.

Pattern: ^disbursement_\w+$

Query Parameters

event
string
required

Disbursement webhook event that you want to simulate. Possible values can be found in the Events & Webhooks section.

Response

Disbursement object advanced.

id
string

id of the Disbursement object

Pattern: ^disbursement_\w+$
Example:

"disbursement_xyz001"

client_loan_id
string

The ID of your loan. This must be the same loan_id used in the Loan Origination Request.

created_at
string<date-time>

The ISO-8601 timestamp at which the Disbursement object was created.

Example:

"2022-06-27T11:22:33Z"

updated_at
string<date-time>

The ISO-8601 timestamp at which the Disbursement object was last updated.

Example:

"2022-06-27T11:22:33Z"

status
enum<string>

The current status of this Disbursement object.

Available options:
created,
processing,
succeeded,
canceled,
failed
Example:

"succeeded"

amount
integer<int64>

Amount disbursed to the counterparty in cents. This amount will align with disbursement_amount from the Loan Origination Request

currency_code
enum<string>

A three-letter currency code as defined in ISO 4217.

Available options:
USD
Example:

"USD"

payment_method
enum<string>

The payment method chosen for disbursement. Only ACH is supported today.

Available options:
ach
Example:

"ach"

payment_details
object