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.

Parameters

• bank_transferobjectRequired

  Additional parameters for bank_transfer funding types

  Hide child parameters

  • bank_transfer.typeenumRequired

    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_transferobject

    Configuration for eu_bank_transfer funding type.

    Hide child parameters

    • bank_transfer.eu_bank_transfer.countrystringRequired

      The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

  • bank_transfer.requested_address_typesarray of enums

    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

• currencyenumRequired

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

• funding_typeenumRequired

  The funding_type to get the instructions for.

  Possible enum values

  bank_transfer Use a bank_transfer hash to define the bank transfer type