Creates an account

Prev Next
Post
/accounts

Creates an account based on a customer ID and a product specification. It can be used to create eMoney or virtual accounts, according to the chosen product.

The account is created only if some conditions are met:

  1. Customer and product exists in Customer Service and in the Product Catalogue respectively

  2. Product is eligible for that customer (Legal Entity associated to the chosen product is a known one).

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
accounts.createCreating an account
Header parameters
x-client-id
stringRequired

Client ID header.

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
x-device
string

Device information permitted for the data query.

You can use this parameter to apply an experience base to optimize data collection.

Min length0
Max length255
Pattern^[a-zA-Z]*$
jwt-data
string

JWT data security header

Min length0
Max length8000
Pattern^[a-zA-Z_0-9_@./#&+-]*$
Body parameters

Request body of POST account.

POST_ACCOUNT_MINIMAL_REQUEST_BODY
{
  "customerId": "PNXTGB2LXXXUS1234567890",
  "baseCurrency": "GBP"
}
POST_ACCOUNT_PRODUCT_ID_REQUEST_BODY
{
  "customerId": "PNXTGB2LXXXUS1234567890",
  "baseCurrency": "GBP",
  "productId": "0589bd6c-cca4-4b46-9c8a-b786171e66e0"
}
POST_ACCOUNT_PRODUCT_DETAILS_REQUEST_BODY
{
  "customerId": "PNXTGB2LXXXUS1234567890",
  "baseCurrency": "GBP",
  "permittedActivity": "first_party",
  "fundsSource": "own_funds",
  "nickName": "My eMoney Account"
}
POST_ACCOUNT_REQUEST_BODY_VIRTUAL
{
  "customerId": "PNXTGB2LXXXUS1234567890",
  "baseCurrency": "GBP",
  "permittedActivity": "first_party",
  "fundsSource": "own_funds",
  "nickName": "My eMoney Account",
  "additionalInfo": {},
  "productId": "0589bd6c-cca4-4b46-9c8a-b786171e66e0",
  "realAccountId": {
    "accountIdType": "uuid",
    "accountId": "3dc722db-0ca5-41fb-a196-e15297e84fd0",
    "country": "GB"
  }
}
Expand All

Data structure containing all the ways to create an account.

AnyOf
CreateAccountMinimalRequestBody
object (CreateAccountMinimalRequestBody)
customerId
string Required

Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.

Min length8
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXXUS1234567890
baseCurrency
string Required

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
nickName
string | null

NickName account Name (alias) that the customer has assigned to the account for easy identification. Applies only when the operation is used by a physical or business customer, not when used by Santander staff.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleMy eMoney Account
additionalInfo
object (AdditionalInfo)

Free JSON object.

Example{}
CreateAccountWithProductIdRequestBody
object (CreateAccountWithProductIdRequestBody)
customerId
string Required

Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.

Min length8
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXXUS1234567890
baseCurrency
string Required

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
productId
string Required

UUID identification type

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
nickName
string | null

NickName account Name (alias) that the customer has assigned to the account for easy identification. Applies only when the operation is used by a physical or business customer, not when used by Santander staff.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleMy eMoney Account
additionalInfo
object (AdditionalInfo)

Free JSON object.

Example{}
CreateAccountWithProductDetailsRequestBody
object (CreateAccountWithProductDetailsRequestBody)
customerId
string Required

Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.

Min length8
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXXUS1234567890
baseCurrency
string Required

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
permittedActivity
string Required

Activity that the customer must handle to apply for the product.

Valid values[ "first_party", "third_party", "third_party_downstream" ]
Examplefirst_party
fundsSource
string Required

Funds source that the customer should have to apply for the product.

Valid values[ "own_funds", "client_funds" ]
Exampleown_funds
nickName
string | null

NickName account Name (alias) that the customer has assigned to the account for easy identification. Applies only when the operation is used by a physical or business customer, not when used by Santander staff.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleMy eMoney Account
additionalInfo
object (AdditionalInfo)

Free JSON object.

Example{}
CreateClientVirtualAccountRequestBody
object (CreateClientVirtualAccountRequestBody)
customerId
string

Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.

Min length8
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXXUS1234567890
baseCurrency
string Required

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
permittedActivity
string

Activity that the customer must handle to apply for the product.

Valid values[ "first_party", "third_party", "third_party_downstream" ]
Examplefirst_party
fundsSource
string

Funds source that the customer should have to apply for the product.

Valid values[ "own_funds", "client_funds" ]
Exampleown_funds
nickName
string | null

NickName account Name (alias) that the customer has assigned to the account for easy identification. Applies only when the operation is used by a physical or business customer, not when used by Santander staff.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleMy eMoney Account
additionalInfo
object (AdditionalInfo)

Free JSON object.

Example{}
productId
string

UUID identification type

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
realAccountId
object (RealAccountId)

Identifier of an account. It is usually used to identify the real account related to a virtual account.

accountIdType
string Required

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
accountId
string Required

Identifier of an account.

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleGB40PNXT09991100000022
country
string

Data structure containing details of the country for the account. Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]*$
ExampleGB
Responses
201

The client account is created and the information is retrieved.

CREATE_EMONEY_ACCOUNT
{
  "displayNumber": "*0022",
  "nickName": "My eMoney Account",
  "baseCurrency": "GBP",
  "status": "Open",
  "accountIdentifiersList": [
    {
      "accountIdType": "uuid",
      "accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66e1"
    },
    {
      "accountIdType": "iban",
      "accountId": "GB40PNXT09991100000022"
    },
    {
      "accountIdType": "bban",
      "accountId": "PNXT09991100000022",
      "country": "GB"
    }
  ],
  "customer": {
    "customerId": "PNXTGB2LXXXUS1234567890",
    "segmentCode": "sme",
    "customerName": "Customer Company Name"
  },
  "productId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
  "virtualAccountStructureId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
  "productName": "eMoney Account",
  "accounting": {
    "accountingId": "client_account",
    "accountingName": "Client Account"
  },
  "legalEntity": {
    "bic": "PNXTGB2LXXX",
    "legalEntityId": "pagonxt_uk",
    "legalEntityName": "PagoNxt OneTrade UK Ltd"
  },
  "balances": {
    "current": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "consolidated": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "pendingConsolidation": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "withholding": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "overdraft": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "limit": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "available": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    }
  },
  "openingDateTime": "2017-07-21T17:32:28.000Z",
  "lastUpdateDateTime": "2017-07-21T17:32:28.000Z",
  "closingDateTime": "2017-07-21T17:32:28.000Z",
  "additionalInfo": {}
}
CREATE_VIRTUAL_ACCOUNT
{
  "displayNumber": "*0022",
  "nickName": "My eMoney Account",
  "baseCurrency": "GBP",
  "status": "Open",
  "accountIdentifiersList": [
    {
      "accountIdType": "uuid",
      "accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66e1"
    },
    {
      "accountIdType": "iban",
      "accountId": "GB40PNXT09991100000022"
    },
    {
      "accountIdType": "bban",
      "accountId": "PNXT09991100000022",
      "country": "GB"
    }
  ],
  "customer": {
    "customerId": "PNXTGB2LXXXUS1234567890",
    "segmentCode": "sme",
    "customerName": "Customer Company Name"
  },
  "productId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
  "virtualAccountStructureId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
  "productName": "eMoney Account",
  "accounting": {
    "accountingId": "virtual_account",
    "accountingName": "Virtual Account"
  },
  "legalEntity": {
    "bic": "PNXTGB2LXXX",
    "legalEntityId": "pagonxt_uk",
    "legalEntityName": "PagoNxt OneTrade UK Ltd"
  },
  "balances": {
    "current": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "consolidated": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "pendingConsolidation": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "withholding": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "overdraft": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "limit": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "available": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "realAccountAvailable": {
      "amount": {
        "amount": "0",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    }
  },
  "realAccountIdentifiersList": [
    {
      "realAccountIdType": "iban",
      "realAccountId": "GB40PNXT09991100000023",
      "country": "GB"
    }
  ],
  "openingDateTime": "2017-07-21T17:32:28.000Z",
  "lastUpdateDateTime": "2017-07-21T17:32:28.000Z",
  "closingDateTime": "2017-07-21T17:32:28.000Z",
  "additionalInfo": {}
}
Expand All
object

Data structure containing account details.

displayNumber
string

Account number to be displayed. The entire account number is not displayed for privacy reasons.

Min length3
Max length255
Pattern^[a-zA-Z_0-9*-]*$
Example*0022
nickName
string | null

NickName account Name (alias) that the customer has assigned to the account for easy identification. Applies only when the operation is used by a physical or business customer, not when used by Santander staff.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleMy eMoney Account
baseCurrency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
status
string

Account status. The possible values are:

  • Open = Account is open and movements are restricted only by the customers available balance and account contract attributes.
  • Blocked by customer= The account is open but is blocked for credit, blocked for debit, or both, ONLY if this block was set by customer itself. In case it is blocked by other distinct to customer, the status will be Blocked.
  • Blocked = Account has some restrictive block.
  • Closed = Account is closed.
Valid values[ "Open", "Closed", "Blocked by customer", "Blocked", "Blocked-CR", "Blocked-DR" ]
ExampleOpen
accountIdentifiersList
Array of object (RealAccountId)

List of account Identifiers.

Min items0
Max items200
object

Identifier of an account. It is usually used to identify the real account related to a virtual account.

accountIdType
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
accountId
string

Identifier of an account.

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleGB40PNXT09991100000022
country
string

Data structure containing details of the country for the account. Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]*$
ExampleGB
customer
object (CustomerAssociated)

Customer associated with an account.

customerId
string

Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.

Min length8
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXXUS1234567890
segmentCode
string

Segment code (classification) in which the bank has categorized the customer. Possible values (sme, corp, mnc, bank, emi, api, regulated_corp, lc, fi, nbfi).

Valid values[ "sme", "corp", "mnc", "bank", "emi", "api", "regulated_corp", "lc", "fi", "nbfi" ]
Examplesme
customerName
string

Customer Name associated with the account

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleCustomer Company Name
productId
string

UUID identification type

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
virtualAccountStructureId
string

UUID identification type

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
productName
string

Name of the product associated with the account

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleeMoney Account
accounting
object (Accounting)

Data structure that represent an account type.

accountingId
string

Accounting Identification of the customer account.

Min length0
Max length50
Pattern^[a-z_]*$
Exampleclient_account
accountingName
string

Accounting Name of the customer account.

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleClient Account
legalEntity
object (LegalEntityDetails)

Legal Entity details object.

bic
string

Bic of the LegalEntity

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePNXTGB2LXXX
legalEntityId
string

Unique Identifier of the legal entity associated with the account

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Examplepagonxt_uk
legalEntityName
string

Legal Name of the legal entity associated with the account

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplePagoNxt OneTrade UK Ltd
balances
object

Data structure containing information related to different balances.

current
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
consolidated
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
pendingConsolidation
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
withholding
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
overdraft
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
limit
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
available
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
realAccountAvailable
object (BaseBalance) | null

Base Balance and date of last change

amount
object (BalanceAmount)

Amount. The value uses the data format defined in ISO 20022 and has a maximum of 18 digits, of which 5 can be decimals, separated by a point.

amount
number (double)

Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.

Separation is a point.

Minimum-2147483647
Maximum2147483647
Example99.99
currency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
lastChangeDateTime
string (date-time) | null

Balance last update date time.

The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
realAccountIdentifiersList
Array of object (RealAccountIdentifier)

List of real account Identifiers.

Min items0
Max items200
object

Identifier of a real account. It is usually used to identify the real account related to a virtual account.

realAccountId
string

Account identifier

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExamplerealAccountId1
realAccountIdType
string

Format used for the account number in the accountId property.

The possible values are:

  • IBAN = IBAN code
  • BBAN = Basic Bank Account Number (BBAN) that represents a country-specific bank account number. Each country has its own standards for the format and length of the BBAN. The value is at most 31 char or 35 bytes long.
  • UUID = Unique account identifier. It is an internal code to uniquely identify the account. Some accounts are internal so they have UUID but no IBAN/BBAN.

For example:

  • In UK, the BBAN format is: Bank(4) + Sort code(6) + Account(8)
  • In Spain, it is: Banco(4) + Sucursal(4) + CD(2) + CTA(10)
Valid values[ "iban", "bban", "uuid" ]
Exampleiban
country
string

Data structure containing details of the country for the account. Country code. The value is based on the ISO 3166-1 alpha-2 (https://www.iso.org/obp/ui/#search/code/).

Min length2
Max length2
Pattern^[A-Z]*$
ExampleGB
openingDateTime
string (date-time)

Balance last update date time. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
lastUpdateDateTime
string (date-time) | null

Last update date of the Account. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
closingDateTime
string (date-time) | null

Date when the Account was closed. The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'

Example2017-07-21T17:32:28Z
additionalInfo
object (AdditionalInfo)

Free JSON object.

Example{}
limits
Array of object (LimitResponse)

Data structure that represents all limits that an account has.

Min items0
Max items200
object

Response that retrieves all the limits based on specific filters.

limitId
string

UUID identification type

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
limitCurrency
string

Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).

Min length3
Max length3
Pattern^[A-Z]*$
ExampleGBP
limitAmount
string

Limit amount.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Example100
limitType
string

Indicates the type of limit.

Valid values[ "overdraft", "intra_day_limit", "pencil_limit", "balance_limit" ]
Examplebalance_limit
400

Data structure showing something is wrong with the request body format

BAD_REQUEST
{
  "errors": [
    {
      "code": "INVALID_SCHEMA",
      "message": "Invalid input.",
      "level": "ERROR",
      "description": "Error validating schema."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
401

Unauthorized

UNAUTHORIZED
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "A token must be provided.",
      "level": "ERROR",
      "description": "There was an error during token verification in header [authorization]"
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
403

Forbidden

OPERATION_NOT_ALLOWED
{
  "errors": [
    {
      "code": "OPERATION_NOT_ALLOWED",
      "message": "operation not allowed due to lack of permissions.",
      "level": "ERROR",
      "description": "Operation not allowed due to lack of permissions."
    }
  ]
}
INVALID_AUTH_TOKEN
{
  "errors": [
    {
      "code": "INVALID_AUTH_TOKEN",
      "message": "The token provided is invalid.",
      "level": "ERROR",
      "description": "Invalid auth token."
    }
  ]
}
FORBIDDEN
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "message": "A token must be provided.",
      "level": "ERROR",
      "description": "Operation not allowed due to lack of permissions."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
404

The product or the customer does not exist in the system.

CUSTOMER_NOT_FOUND
{
  "errors": [
    {
      "code": "ACCOUNT_NOT_FOUND_FOR_CUSTOMER_ID",
      "level": "ERROR",
      "message": "Some of the accounts could not be found for the selected customer.",
      "description": "Some of the accounts could not be found for the selected customer."
    }
  ]
}
PRODUCT_NOT_FOUND
{
  "errors": [
    {
      "code": "PRODUCT_NOT_FOUND",
      "level": "ERROR",
      "message": "Product not found.",
      "description": "The product \"productId\" could not be found."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
405

Method Not Allowed

METHOD_NOT_ALLOWED
{
  "errors": [
    {
      "code": "METHOD_NOT_ALLOWED",
      "level": "ERROR",
      "message": "Method not allowed",
      "description": "The request method is known by the server but is not supported by the target resource."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
406

Not Acceptable

NOT_ACCEPTABLE
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "ERROR",
      "message": "Not Acceptable",
      "description": "This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
409

Conflict

CONFLICT
{
  "errors": [
    {
      "code": "CONFLICT",
      "level": "ERROR",
      "message": "Conflict",
      "description": "This response is sent when a request conflicts with the current state of the server."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
413

Payload too large

PAYLOAD_TOO_LARGE
{
  "errors": [
    {
      "code": "PAYLOAD_TOO_LARGE",
      "level": "ERROR",
      "message": "Payload too large",
      "description": "Request entity is larger than limits defined by server. The server might close the connection or return an Retry-After header field."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
414

Request URI Too Long

REQUEST_URI_TOO_LONG
{
  "errors": [
    {
      "code": "URI_TOO_LARGE",
      "level": "ERROR",
      "message": "URI too large",
      "description": "The URI requested by the client is longer than the server is willing to interpret."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
415

Unsupported Media Type

UNSUPPORTED_MEDIA_TYPE
{
  "errors": [
    {
      "code": "UNSUPPORTED_MEDIA_TYPE",
      "level": "ERROR",
      "message": "Unsupported Media Type",
      "description": "The media format of the requested data is not supported by the server, so the server is rejecting the request."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
422

Unprocessible entity

PRODUCT_NOT_ELIGIBLE
{
  "errors": [
    {
      "code": "PRODUCT_NOT_ELIGIBLE",
      "message": "The customer is not eligible for the product.",
      "level": "ERROR",
      "description": "Specific description about the service that is having problems"
    }
  ]
}
INVALID_CUSTOMER_INFORMATION
{
  "errors": [
    {
      "code": "INVALID_CUSTOMER_INFORMATION",
      "level": "ERROR",
      "message": "Customer service did not provide valid information for the customer to continue the operation.",
      "description": "The customer info from customer service is not valid."
    }
  ]
}
FULL_ACCOUNT_NUMBER_COUNTER
{
  "errors": [
    {
      "code": "FULL_ACCOUNT_NUMBER_COUNTER",
      "level": "ERROR",
      "message": "The selected account number counter to generate the IBAN is full",
      "description": "The account number counter identified by code=GBPAGO111111, minAccountNumber=3, maxAccountNumber=5 is out of numbers."
    }
  ]
}
ACCOUNT_NUMBER_COUNTER_NOT_AVAILABLE
{
  "errors": [
    {
      "code": "ACCOUNT_NUMBER_COUNTER_NOT_AVAILABLE",
      "message": "A new account number counter should be created to open an account for this product",
      "level": "ERROR",
      "description": "Counter for code=GBPAGO111111, minAccountNumber=3, maxAccountNumber=5 is not available to generate IBAN."
    }
  ]
}
CURRENCY_NOT_ENABLED
{
  "errors": [
    {
      "code": "CURRENCY_NOT_ENABLED",
      "message": "Currency not enabled",
      "level": "ERROR",
      "description": "The following currency baseCurrency is not enabled."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
429

Too Many Requests

TOO_MANY_REQUESTS
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too many requests.",
      "description": "The user has sent too many requests in a given amount of time"
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
500

Internal Server Error

INTERNAL_SERVER_ERROR
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "Internal Server Error.",
      "level": "ERROR",
      "description": "INTERNAL_SERVER_ERROR"
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
503

Service Down Error

SERVICE_ERROR
{
  "errors": [
    {
      "code": "SERVICE_DOWN_ERROR",
      "message": "Service down error.",
      "level": "ERROR",
      "description": "Service down error."
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
504

Gateway Timeout Error

GATEWAY_TIMEOUT
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT_ERROR",
      "message": "Gateway timeout error.",
      "level": "ERROR",
      "description": "Gateway timeout error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema
default

Internal Server Error

INTERNAL_SERVER_ERROR
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "message": "Internal Server Error.",
      "level": "ERROR",
      "description": "INTERNAL_SERVER_ERROR"
    }
  ]
}
Expand All
object

Data structure containing the details for errors.

errors
Array of object (Error)

Array of errors.

Min items0
Max items50
object

Data structure containing error details.

code
string

Unique alphanumeric human readable error code.

Min length1
Max length255
Pattern^[a-zA-Z_0-9-]*$
ExampleINVALID_CODE
message
string

Brief summary of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
Exampleinvalid_message
level
string

Level of the reported issue. The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue.

Min length1
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleError validating schema