Create a FinancialAddress object v2

Response attributes

• idstring

  The ID of a FinancialAddress.

• objectstring, value is "v2.money_management.financial_address"

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

• createdtimestamp

  The creation timestamp of the FinancialAddress.

• credentialsnullable object

  Object indicates the type of credentials that have been allocated and attached to the FinancialAddress. It contains all necessary banking details with which to perform money movements with the FinancialAddress. This field is only available for FinancialAddresses with an active status.

  Hide child attributes

  • credentials.gb_bank_accountnullable object

    The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.

    Hide child attributes

    • credentials.gb_bank_account.account_holder_namestring

      The account holder name to be used during bank transference.

    • credentials.gb_bank_account.account_numbernullable string

      The account number of the UK Bank Account.

    • credentials.gb_bank_account.last4string

      The last four digits of the UK Bank Account number. This will always be returned. To view the full account number when retrieving or listing FinancialAddresses, use the include request parameter.

    • credentials.gb_bank_account.sort_codestring

      The sort code of the UK Bank Account.

  • credentials.sepa_bank_accountnullable object

    The credentials of the SEPA Bank Account for the FinancialAddress. This contains unique banking details such as the IBAN, BIC, etc. of a SEPA bank account.

    Hide child attributes

    • credentials.sepa_bank_account.account_holder_namestring

      The account holder name to be used during bank transfers.

    • credentials.sepa_bank_account.bank_namestring

      The name of the Bank.

    • credentials.sepa_bank_account.bicstring

      The BIC of the SEPA Bank Account.

    • credentials.sepa_bank_account.countryenum

      The originating country of the SEPA Bank account.

    • credentials.sepa_bank_account.ibanstring

      The IBAN of the SEPA Bank Account.

    • credentials.sepa_bank_account.last4string

      The last four digits of the SEPA Bank Account number. This will always be returned. To view the full account number when retrieving or listing FinancialAddresses, use the include request parameter.

  • credentials.typeenum

    The type of Credentials that are provisioned for the FinancialAddress.

    Possible enum values

    gb_bank_account A UK Bank Account credential. This indicates that the associated credentials object contains unique banking details pertinent to a UK bank account.

    us_bank_account A US Bank Account credential. This indicates that the associated credentials object contains unique banking details pertinent to a US bank account.

  • credentials.us_bank_accountnullable object

    The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.

    Hide child attributes

    • credentials.us_bank_account.account_numbernullable string

      The account number of the US Bank Account.

    • credentials.us_bank_account.bank_namenullable string

      The name of the Bank.

    • credentials.us_bank_account.last4string

      The last four digits of the US Bank Account number. This will always be returned. To view the full account number when retrieving or listing FinancialAddresses, use the include request parameter.

    • credentials.us_bank_account.routing_numberstring

      The routing number of the US Bank Account.

    • credentials.us_bank_account.swift_codenullable string

      The swift code of the bank or financial institution.

• currencyenum

  The currency the FinancialAddress supports.

• financial_accountstring

  A ID of the FinancialAccount this FinancialAddress corresponds to.

• livemodeboolean

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

• settlement_currencynullable enum

  The currency the FinancialAddress settles into the FinancialAccount.

• statusenum

  An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.

  Possible enum values

  active The Financial Address is active.

  archived The Financial Address is archived, it cannot be used anymore.

  failed The Financial Address creation failed.

  pending The Financial Address is being created.