List all FinancialAddress objects v2

Response attributes

• dataarray of objects

  A list of FinancialAddresses.

  Hide child attributes

  • data.idstring

    The ID of a FinancialAddress.

  • data.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.

  • data.createdtimestamp

    The creation timestamp of the FinancialAddress.

  • data.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

    • data.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

      • data.credentials.gb_bank_account.account_holder_namestring

        The account holder name to be used during bank transference.

      • data.credentials.gb_bank_account.account_numbernullable string

        The account number of the UK Bank Account.

      • data.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.

      • data.credentials.gb_bank_account.sort_codestring

        The sort code of the UK Bank Account.

    • data.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.

    • data.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

      • data.credentials.us_bank_account.account_numbernullable string

        The account number of the US Bank Account.

      • data.credentials.us_bank_account.bank_namenullable string

        The name of the Bank.

      • data.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.

      • data.credentials.us_bank_account.routing_numberstring

        The routing number of the US Bank Account.

      • data.credentials.us_bank_account.swift_codenullable string

        The swift code of the bank or financial institution.

  • data.currencyenum

    The currency the FinancialAddress supports.

  • data.financial_accountstring

    A ID of the FinancialAccount this FinancialAddress corresponds to.

  • data.livemodeboolean

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

  • data.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.

• next_page_urlnullable string

  The next page url.

• previous_page_urlnullable string

  The previous page url.