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_
transferobjectRequired Additional parameters for
bank_
funding typestransfer - currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- funding_
typeenumRequired The
funding_
to get the instructions for.type Possible enum valuesbank_
transfer Use a bank_transfer hash to define the bank transfer type
Returns
Returns funding instructions for a customer cash balance
{ "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}
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.
{ "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"}
Returns a list of transactions that modified the customer’s cash balance.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
cash balance transactions, starting after item starting_
. Each entry in the array is a separate cash balance transaction object. If no more items are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/customers/cus_9s6XKzkNRiz8i3/cash_balance_transactions", "has_more": false, "data": [ { "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" } ]}
Fund a test mode cash balance Test helper
Create an incoming testmode bank transfer
Parameters
- amountintegerRequired
Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the smallest currency unit (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
- currencyenumRequired
Three-letter ISO currency code, in lowercase. Must be a supported currency.
More parameters
- referencestring
Returns
Returns a specific cash balance transaction, which funded the customer’s cash balance.
{ "id": "ccsbtxn_1NlhIV2eZvKYlo2CKwRcXkii", "object": "customer_cash_balance_transaction", "created": 1693612963, "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"}
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
Related guide: Card payments with Sources