Create or retrieve funding instructions for a customer cash balance
POST / v1 / customers /:id / funding_instructions
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.
Parameters
- bank _ transfer object Required Additional parameters for
bank_transferfunding types - currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- funding _ type enum Required The
funding_typeto get the instructions for. Possible enum valuesbank_transferUse a bank_transfer hash to define the bank transfer type
Returns
Returns funding instructions for a customer cash balance
Response
{ "object": "funding_instructions", "bank_transfer": { "country": "DE", "financial_addresses": [ { "iban": { "account_holder_address": { "city": "Dublin", "country": "IE", "line1": "Some address", "line2": null, "postal_code": "D01H104", "state": "Dublin 1" }, "account_holder_name": "Merchant name", "bank_address": { "city": "Dublin", "country": "IE", "line1": "1 North Wall Quay", "line2": null, "postal_code": "D01 T8Y1", "state": "Dublin" }, "bic": "SOGEDEFFXXX", "country": "DE", "iban": "DE006847740991234567890" }, "supported_networks": [ "sepa", "swift" ], "type": "iban" } ], "type": "eu_bank_transfer" }, "currency": "eur", "funding_type": "bank_transfer", "livemode": false}
Retrieve a cash balance transaction
GET / v1 / customers /:id / cash_balance_transactions /:id
Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
Parameters
No parameters.
Returns
Returns a cash balance transaction object if a valid identifier was provided.
Response
{ "id": "ccsbtxn_1Na16B2eZvKYlo2CUhyw3dsF", "object": "customer_cash_balance_transaction", "created": 1690829143, "currency": "eur", "customer": "cus_9s6XKzkNRiz8i3", "ending_balance": 10000, "funded": { "bank_transfer": { "eu_bank_transfer": { "bic": "BANKDEAAXXX", "iban_last4": "7089", "sender_name": "Sample Business GmbH" }, "reference": "Payment for Invoice 28278FC-155", "type": "eu_bank_transfer" } }, "livemode": false, "net_amount": 5000, "type": "funded"}
List cash balance transactions
GET / v1 / customers /:id / cash_balance_transactions
Returns a list of transactions that modified the customer’s cash balance.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit cash balance transactions, starting after item starting_after. Each entry in the array is a separate cash balance transaction object. If no more items are available, the resulting array will be empty.
Response