v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Create or retrieve funding instructions for a customer cash balance

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

post/v1/customers/{customer}/funding_instructions

Path parameters

customerstring required

Response

Successful response.

currencystring required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

funding_type'bank_transfer' required

The funding_type of the returned instructions

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'funding_instructions' required

String representing the object's type. Objects of the same type share the same value.