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.

Returns

Returns funding instructions for a customer cash balance

Parameters

• bank_transfer (object, required) Additional parameters for bank_transfer funding types

  • bank_transfer.type (enum, required) The type of the bank_transfer Possible enum values:

    • eu_bank_transfer A bank transfer to a eu_bank_transfer

    • gb_bank_transfer A bank transfer to a gb_bank_transfer

    • jp_bank_transfer A bank transfer to a jp_bank_transfer

    • mx_bank_transfer A bank transfer to a mx_bank_transfer

    • us_bank_transfer A bank transfer to a us_bank_transfer

  • bank_transfer.eu_bank_transfer (object, optional) Configuration for eu_bank_transfer funding type.

    • bank_transfer.eu_bank_transfer.country (string, required) The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.

  • bank_transfer.requested_address_types (array of enums, optional) List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

    Permitted values include: sort_code, zengin, iban, or spei. Possible enum values:

    • iban An IBAN financial address

    • sort_code A SortCode financial address

    • spei A Spei financial address

    • zengin A Zengin financial address

• currency (enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.

• funding_type (enum, required) The funding_type to get the instructions for. Possible enum values:

  • bank_transfer Use a bank_transfer hash to define the bank transfer type

curl https://api.stripe.com/v1/customers/{{CUSTOMER_ID}}/funding_instructions \
  -u "<<YOUR_SECRET_KEY>>" \
  -d funding_type=bank_transfer \
  -d currency=eur \
  -d "bank_transfer[type]=eu_bank_transfer" \
  -d "bank_transfer[eu_bank_transfer][country]=DE"

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
}