← Customers
post/v1/customers/{customer}/funding_instructions

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.

Path parameters

NameDescription
customer*

Request body

FieldTypeDescription
bank_transfer*object

Additional parameters for bank_transfer funding types

3 nested fields
FieldTypeDescription
eu_bank_transferobject
1 nested field
FieldTypeDescription
country*string
requested_address_typesarray<string>
type*string
currency*string (currency)

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

expandarray<string>

Specifies which fields in the response should be expanded.

funding_type*string

The funding_type to get the instructions for.

Response

FieldTypeDescription
bank_transfer*funding_instructions_bank_transfer
3 nested fields
FieldTypeDescription
country*string

The country of the bank account to fund

financial_addresses*array<funding_instructions_bank_transfer_financial_address>

A list of financial addresses that can be used to fund a particular balance

type*string

The bank_transfer type

currency*string

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

funding_type*string

The funding_type of the returned instructions

livemode*boolean

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

object*string

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