Account Models

These models are returned by the get all accounts, get an account and get currency accounts endpoints.

AccountData

[
  {
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      },
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      }
    ],
    "currency": "currency",
    "status": "account_status"
  },
  {
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      },
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      }
    ],
    "currency": "currency",
    "status": "account_status"
  }
]

This model is a representation of an account within Ebury. Fields

string

Identification of the currency in which the account is held. Always present.

array

The list of AccountDetails for this currency. Always present.

string

The AccountStatus of the account. Always present.

string

The UUID of the account. Always present.

string

The AccountType of the account. Always present.

string

The AccountSubType of the account. Always present.

AccountDetails

{
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
        {
            "account_address": "account_address",
            "account_name": "account_name",
            "account_number": "account_number",
            "account_number_type": "account_number_type",
            "bank_identifier": "bank_identifier",
            "bank_identifier_type": "bank_identifier_type"
        },
        {
            "account_address": "account_address",
            "account_name": "account_name",
            "account_number": "account_number",
            "account_number_type": "account_number_type",
            "bank_identifier": "bank_identifier",
            "bank_identifier_type": "bank_identifier_type"
        }
    ],
    "currency": "currency",
    "status": "account_status"
}

This model is a representation of account data associated with an Account. Fields

string

The address of the account. Always present.

string

The name or names of the account owner(s) represented at an account level. Always present.

string

The number of the account. Always present.

string

The AccountNumberType of the account number. Always present.

string

The identifier of the bank. Always present.

string

The BankIdentifierType of the bank identifier. Always present.

AccountStatus

This is an enumeration of the statuses of an account. Values

Value	Description
`Enabled`	Account is enabled.
`Disabled`	Account is disabled.

CurrencyAccount

{
  "account_id": "int",
  "currency": "currency"
}

This model is a simplified representation of a currency account, used primarily for filtering and selection purposes. Fields

integer

The numeric ID of the currency account. Always present.

string

The ISO 4217 currency code for the account (e.g., “GBP”, “EUR”, “USD”). Always present.

AccountType

This is an enumeration of the types of an account. Values

Value	Description
`Personal`	Individual account.
`Business`	Corporate account.

AccountSubType

This is an enumeration of sub types of an account (product family group). Values

Value	Description
`EMoney`

AccountNumberType

This is an enumeration of number types of an account. Values

Value	Description
`IBAN`
`BBAN`

BankIdentifierType

This is an enumeration of bank identifier types, to comply with ISO20022 codes related to Clearing System Identification, with the addition of SWBIC for swift international payments. Values

Value	Description
`SWBIC`	Used for swift international payments.
other	Please refer to `ExternalClearingSystemIdentification1Code` inside Clearing System Identification of ISO20022.

​AccountData

​AccountDetails

​AccountStatus

​CurrencyAccount

​AccountType

​AccountSubType

​AccountNumberType

​BankIdentifierType

AccountData

AccountDetails

AccountStatus

CurrencyAccount

AccountType

AccountSubType

AccountNumberType

BankIdentifierType