Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Lending

Cancel a disbursement

Cancel a disbursement.

post/v0/lending/disbursements/{disbursement_id}/cancel

Path parameters

disbursement_idstring required

ID of the disbursement object you want to cancel.

Headers

Idempotency-Keystring

Idempotency key

Response

The canceled disbursement object.

idstring

id of the Disbursement object

client_loan_idstring

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

created_atstring date-time

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

updated_atstring date-time

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

status'created' | 'processing' | 'succeeded' | 'canceled' | 'failed'

The current status of this Disbursement object.

amountinteger

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

currency_code'USD'

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

payment_method'ach'

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

Example response

{
  "id": "disbursement_xyz001",
  "created_at": "2022-06-27T11:22:33Z",
  "updated_at": "2022-06-27T11:22:33Z",
  "status": "succeeded",
  "currency_code": "USD",
  "payment_method": "ach",
  "payment_details": {
    "delivery_type": "same_business_day",
    "trace_number": "123456789012345",
    "statement_descriptor": "P2P Credit",
    "counterparty": {
      "name": "Lara Smikle",
      "account_number": "1032345678",
      "routing_number": "021000021",
      "account_type": "checking"
    },
    "correction": {
      "account_number": "1032345678",
      "routing_number": "021000021"
    },
    "failure": {
      "failure_code": "account_closed"
    }
  }
}