The Funding Instruction object 

Attributes

• bank_transferobject

  Details to display instructions for initiating a bank transfer

  Hide child attributes

  • bank_transfer.countrystring

    The country of the bank account to fund

  • bank_transfer.financial_addressesarray of objects

    A list of financial addresses that can be used to fund a particular balance

    Hide child attributes

    • bank_transfer.financial_addresses.ibannullable object

      An IBAN-based FinancialAddress

      Hide child attributes

      • bank_transfer.financial_addresses.iban.account_holder_addressobject

        The account holder’s physical address

        Hide child attributes

        • bank_transfer.financial_addresses.iban.account_holder_address.citynullable string

          City, district, suburb, town, or village.

        • bank_transfer.financial_addresses.iban.account_holder_address.countrynullable string

          Two-letter country code (ISO 3166-1 alpha-2).

        • bank_transfer.financial_addresses.iban.account_holder_address.line1nullable string

          Address line 1 (e.g., street, PO Box, or company name).

        • bank_transfer.financial_addresses.iban.account_holder_address.line2nullable string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • bank_transfer.financial_addresses.iban.account_holder_address.postal_codenullable string

          ZIP or postal code.

        • bank_transfer.financial_addresses.iban.account_holder_address.statenullable string

          State, county, province, or region.

      • bank_transfer.financial_addresses.iban.account_holder_namestring

        The name of the person or business that owns the bank account

      • bank_transfer.financial_addresses.iban.bank_addressobject

        The bank’s physical address

        Hide child attributes

        • bank_transfer.financial_addresses.iban.bank_address.citynullable string

          City, district, suburb, town, or village.

        • bank_transfer.financial_addresses.iban.bank_address.countrynullable string

          Two-letter country code (ISO 3166-1 alpha-2).

        • bank_transfer.financial_addresses.iban.bank_address.line1nullable string

          Address line 1 (e.g., street, PO Box, or company name).

        • bank_transfer.financial_addresses.iban.bank_address.line2nullable string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • bank_transfer.financial_addresses.iban.bank_address.postal_codenullable string

          ZIP or postal code.

        • bank_transfer.financial_addresses.iban.bank_address.statenullable string

          State, county, province, or region.

      • bank_transfer.financial_addresses.iban.bicstring

        The BIC/SWIFT code of the account.

      • bank_transfer.financial_addresses.iban.countrystring

        Two-letter country code (ISO 3166-1 alpha-2).

      • bank_transfer.financial_addresses.iban.ibanstring

        The IBAN of the account.

    • bank_transfer.financial_addresses.sort_codenullable object

      An account number and sort code-based FinancialAddress

      Hide child attributes

      • bank_transfer.financial_addresses.sort_code.account_holder_addressobject

        The account holder’s physical address

        Hide child attributes

        • bank_transfer.financial_addresses.sort_code.account_holder_address.citynullable string

          City, district, suburb, town, or village.

        • bank_transfer.financial_addresses.sort_code.account_holder_address.countrynullable string

          Two-letter country code (ISO 3166-1 alpha-2).

        • bank_transfer.financial_addresses.sort_code.account_holder_address.line1nullable string

          Address line 1 (e.g., street, PO Box, or company name).

        • bank_transfer.financial_addresses.sort_code.account_holder_address.line2nullable string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • bank_transfer.financial_addresses.sort_code.account_holder_address.postal_codenullable string

          ZIP or postal code.

        • bank_transfer.financial_addresses.sort_code.account_holder_address.statenullable string

          State, county, province, or region.

      • bank_transfer.financial_addresses.sort_code.account_holder_namestring

        The name of the person or business that owns the bank account

      • bank_transfer.financial_addresses.sort_code.account_numberstring

        The account number

      • bank_transfer.financial_addresses.sort_code.bank_addressobject

        The bank’s physical address

        Hide child attributes

        • bank_transfer.financial_addresses.sort_code.bank_address.citynullable string

          City, district, suburb, town, or village.

        • bank_transfer.financial_addresses.sort_code.bank_address.countrynullable string

          Two-letter country code (ISO 3166-1 alpha-2).

        • bank_transfer.financial_addresses.sort_code.bank_address.line1nullable string

          Address line 1 (e.g., street, PO Box, or company name).

        • bank_transfer.financial_addresses.sort_code.bank_address.line2nullable string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • bank_transfer.financial_addresses.sort_code.bank_address.postal_codenullable string

          ZIP or postal code.

        • bank_transfer.financial_addresses.sort_code.bank_address.statenullable string

          State, county, province, or region.

      • bank_transfer.financial_addresses.sort_code.sort_codestring

        The six-digit sort code

    • bank_transfer.financial_addresses.supported_networksnullable array of enums

      The payment networks supported by this FinancialAddress

    • bank_transfer.financial_addresses.typeenum

      The type of financial address

  • bank_transfer.typeenum

    The bank_transfer type

    Possible enum values

    eu_bank_transfer A bank transfer to an EU bank account

    gb_bank_transfer A bank transfer to a GB bank account

• currencystring

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

• funding_typeenum

  The funding_type of the returned instructions

  Possible enum values

  bank_transfer Use a bank_transfer hash to define the bank transfer type

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.