Overview

Our Disbursement API provides a flexible and secure way to manage fund transfers across multiple payout methods. It enables developers to create disbursement links for various channels—including bank cards, cash pickup, and ACH (bank accounts), ensuring broad coverage for different payment preferences.

In addition to initiating transfers, the API supports retrieving real-time status updates for any disbursement, giving transparency and control throughout the process. For advanced scenarios, it offers endpoints to perform generic disbursement transfers and update existing transactions, such as canceling claim codes or modifying transfer details. This comprehensive set of endpoints simplifies integration for businesses that need to deliver funds quickly and reliably to their customers.

Disbursements API Endpoints

Create Bank Card Link

POST /programs/{programCode}/accounts/{accountIdentifier}/disbursements/bankcard

Creates a new disbursement link to a bank card for the specified account and program.

Create Cash Link

POST /programs/{programCode}/accounts/{accountIdentifier}/disbursements/cash

Creates a new disbursement link for cash pickup for the specified account and program.

Create ACH Link

POST /programs/{programCode}/accounts/{accountIdentifier}/disbursements/ach

Creates a new disbursement link to an ACH (bank account) for the specified account and program.

Get Transfer Status

GET /programs/{programCode}/accounts/{accountIdentifier}/disbursements/transfer/{transferIdentifier}

Retrieves the status and details of a specific disbursement transfer for the given account and program.

Create Disbursement Transfer

POST /programs/{programCode}/accounts/{accountIdentifier}/disbursements/transfer/{transferIdentifier}

Performs a generic disbursement transfer for the specified account and program. Use for sending funds to a destination.

Update Disbursement Transfer

PUT /programs/{programCode}/accounts/{accountIdentifier}/disbursements/transfer/{transferIdentifier}

Updates an existing disbursement transfer, such as canceling a claim code, for the specified account and program.