POST
/v1/customers/{customer}/funding_instructionsCreate or retrieve customer funding instructions
Creates or retrieves stable bank-transfer funding instructions for a customer's cash balance. Supply bank_transfer, currency, and funding_type to request instructions, and repeated requests for the same customer return the same instructions. Use bank_transfer to select the supported transfer type and any requested address types.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
customerstringrequired
The customer identifier whose cash-balance funding instructions you want to create or retrieve.
Customer cash-balance funding instruction request.
bank_transferobjectrequired
Additional parameters for `bank_transfer` funding types
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
expandarray<string>optional
Specifies which fields in the response should be expanded.
funding_typestringrequired
The `funding_type` to get the instructions for.
200Returns bank-transfer funding instructions with the requested currency, funding type, financial addresses, live-mode indicator, and object type.
bank_transferobjectrequired
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
funding_typestringrequired
The `funding_type` of the returned instructions
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
defaultError response.
errorobjectrequired
Error handling
bank_transfer, currency, and funding_type are required. funding_type must be bank_transfer, currency must be a supported lowercase three-letter ISO currency code, and bank_transfer.type must be one of eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.