Retrieves the virtual accounts of a given client account identifier.
The real account identifier can be UUID, IBAN or BBAN specifying a country.
OAuth Grant type, Private JWT
Client ID header.
Device information permitted for the data query.
You can use this parameter to apply an experience base to optimize data collection.
Identifier of the account. The number format is defined in the "account_id_type" parameter.
Account id country
Account id type
List of account type identifiers.
Name of the accounting id type.
Additional Account Info
Customer identifier.
Customer name associated with the account.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Minimum monetary balance value required for the account to be included in the response. Both negative and positive values are allowed.
Start date for the time period from which accounts are to be retrieved.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Start date for the time period from which accounts are to be retrieved, based on the date when the last transaction have been done.The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Whether closed accounts are included in the response.
The possible values are:
- true = Accounts with closed status are included
- false = Accounts with closed status are not included
The default value is false. If the 'status' parameter is provided, this parameter must not be used.
Legal Name of the legal entity associated with the account.
Short code list of the legal entities associated with the account.
Alias of an account that the customer has assigned to the account for easy identification.
Unique identifiers of products associated with an account.
Name of the product associated with the account.
Status of the accounts to be included in the response. The possible values are a comma separated list of:
- Open = Account is open and movements are restricted only by the customers available balance and account contract attributes. This includes accounts with warnings.
- Blocked = Account has some restrictive block.
- Closed = Account is closed.
Maximum monetary balance value required for the account to be included in the response. Both negative and positive values are allowed.
End date for the time period from which accounts are to be retrieved.
The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
End date for the time period from which accounts are to be retrieved, based on the date when the last transactions have been done.The date format is 'yyyy-MM-ddThh:mm:ss.fff±timezone', where fff are milliseconds and timezone can be 'Z' or 'hh:mm'
Virtual account id country
Virtual account id type
Identifier of an specific virtual account structure
List of virtual accounts to be included in the response. The accounts must be defined with comma-separated account numbers without blank spaces. All accounts must be identified using the account number format defined in the 'virtual_account_id_type' parameter. The maximum number of included accounts is 20. If you want data about more than 20 accounts, call the API multiple times, for 20 accounts at a time.
Query param (string, splitted by comma) that determine how many information we should return. Possible values for this query are:
- balances
- status
If the value is 'balances', the response includes the following balance types:
- consolidated
- pendingConsolidation
- withholding
- overdraft
- limit
- available
- current
The default value is empty and returns no balances.
If the value is 'status', the response includes the following status expanded types:
- Open
- Blocked-DR
- Blocked-CR
- Blocked-DR&CR
- Closed
The default value is empty and returns (by default) the following values:
- Open
- Blocked
- Closed
Number of values that should be informed per page.
Pagination identifier.
Sorting order for the retrieved accounts.
The possible values are:
- +product_name = ascending by product_name
- -product_name = descending by product_name
- +customer_name = ascending by customer_name
- -customer_name = descending by customer_name
- +opening_date_time = ascending by opening_date_time
- -opening_date_time = descending by opening_date_time
- +last_update_date_time = ascending by last_update_date_time
- -last_update_date_time = descending by last_update_date_time
- +closing_date_time = ascending by closing_date_time
- -closing_date_time = descending by closing_date_time
If the value is omitted, the default value is '-opening_date_time'.
Data structure showing virtual account list details.
{
"accountsList": [
{
"accountDetails": {
"displayNumber": "*0022",
"nickName": "My eMoney Account",
"baseCurrency": "GBP",
"status": "Open",
"accountIdentifiersList": [
{
"accountIdType": "uuid",
"accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66e1"
},
{
"accountIdType": "iban",
"accountId": "GB40PNXT09991100000022",
"country": "GB"
},
{
"accountIdType": "bban",
"accountId": "PNXT09991100000022",
"country": "GB"
}
],
"customer": {
"customerId": "PNXTGB2LXXXUS1234567890",
"segmentCode": "sme",
"customerName": "Customer Company Name"
},
"productId": "42dbdc87-a491-4566-bb97-eb2d9aea4707",
"productName": "eMoney Account",
"accounting": {
"accountingId": "virtual_account",
"accountingName": "Virtual Account"
},
"realAccountIdentifiersList": [
{
"realAccountIdType": "uuid",
"realAccountId": "74382f61-2410-4169-9ddc-ef8f892b3504"
},
{
"realAccountIdType": "iban",
"realAccountId": "GB20PAGO09197400000026"
},
{
"realAccountIdType": "bban",
"realAccountId": "9197400000026",
"country": "GB"
}
],
"legalEntity": {
"bic": "PNXTGB2LXXX",
"legalEntityId": "pagonxt_uk",
"legalEntityName": "PagoNxt OneTrade UK Ltd"
},
"openingDateTime": "2021-07-21T17:32:28.000Z",
"lastUpdateDateTime": "2021-07-21T17:32:28.000Z",
"closingDateTime": "2021-07-21T17:32:28.000Z",
"additionalInfo": {}
},
"accountDetailsLink": "/accounts/0589bd6c-cca4-4b46-9c8a-b786171e66e1?account_id_type=uuid",
"transactionsListLink": "/accounts/0589bd6c-cca4-4b46-9c8a-b786171e66e1/transactions?account_id_type=uuid"
}
],
"_links": {
"_first": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=0&_limit=10&_sort=-opening_date_time",
"_prev": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=10&_limit=10&_sort=-opening_date_time",
"_next": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=30&_limit=10&_sort=-opening_date_time",
"_last": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=40&_limit=10&_sort=-opening_date_time"
},
"_count": "1"
}{
"accountsList": [
{
"accountDetails": {
"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",
"productName": "eMoney Account",
"accounting": {
"accountingId": "virtual_account",
"accountingName": "Virtual Account"
},
"balances": {
"current": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"consolidated": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"pendingConsolidation": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"withholding": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"overdraft": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"limit": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"available": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
},
"realAccountAvailable": {
"amount": {
"amount": "99.99",
"currency": "GBP"
},
"lastChangeDateTime": "2017-07-21T17:32:28.000Z"
}
},
"realAccountIdentifiersList": [
{
"realAccountIdType": "uuid",
"realAccountId": "74382f61-2410-4169-9ddc-ef8f892b3504"
},
{
"realAccountIdType": "iban",
"realAccountId": "GB20PAGO09197400000026"
},
{
"realAccountIdType": "bban",
"realAccountId": "9197400000026",
"country": "GB"
}
],
"legalEntity": {
"bic": "PNXTGB2LXXX",
"legalEntityId": "pagonxt_uk",
"legalEntityName": "PagoNxt OneTrade UK Ltd"
},
"openingDateTime": "2021-07-21T17:32:28.000Z",
"lastUpdateDateTime": "2021-07-21T17:32:28.000Z",
"closingDateTime": "2021-07-21T17:32:28.000Z",
"additionalInfo": {}
},
"accountDetailsLink": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504?account_id_type=uuid",
"transactionsListLink": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/transactions?account_id_type=uuid"
}
],
"_links": {
"_first": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=0&_limit=10&_sort=-opening_date_time",
"_prev": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=10&_limit=10&_sort=-opening_date_time",
"_next": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=30&_limit=10&_sort=-opening_date_time",
"_last": "/accounts/74382f61-2410-4169-9ddc-ef8f892b3504/virtual-accounts?_offset=40&_limit=10&_sort=-opening_date_time"
},
"_count": "1"
}Data structure showing all virtual account list.
Array of customer's accounts
Data structure showing all virtual account details.
Data structure containing account details.
Account number to be displayed. The entire account number is not displayed for privacy reasons.
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.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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.
List of account Identifiers.
Identifier of an account. It is usually used to identify the real account related to a virtual account.
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)
Identifier of an account.
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/).
Customer associated with an account.
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.
Segment code (classification) in which the bank has categorized the customer. Possible values (sme, corp, mnc, bank, emi, api, regulated_corp, lc, fi, nbfi).
Customer Name associated with the account
UUID identification type
UUID identification type
Name of the product associated with the account
Data structure that represent an account type.
Accounting Identification of the customer account.
Accounting Name of the customer account.
Legal Entity details object.
Bic of the LegalEntity
Unique Identifier of the legal entity associated with the account
Legal Name of the legal entity associated with the account
Data structure containing information related to different balances.
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
Base Balance and date of last change
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.
Data in ISO 20022 format containing up to 18 digits from which 5 may be decimals.
Separation is a point.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
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'
List of real account Identifiers.
Identifier of a real account. It is usually used to identify the real account related to a virtual account.
Account identifier
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)
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/).
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'
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'
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'
Free JSON object.
Data structure that represents all limits that an account has.
Response that retrieves all the limits based on specific filters.
UUID identification type
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
Limit amount.
Indicates the type of limit.
Link to the account transactions list.
Link to the account details.
Pagination Links.
Link to the first page of the account list. The exact value depends on the data to be accessed. The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the previous page of the account list. The exact value depends on the data to be accessed. The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the previous page of the account list. The exact value depends on the data to be accessed. The exact content of the page depends on the input parameters provided in the request, such as the offset.
Link to the last page of the account list. The exact value depends on the data to be accessed. The exact content of the page depends on the input parameters provided in the request, such as the offset.
Define the count pagination component
No content
Bad Request
{
"errors": [
{
"code": "INVALID_SCHEMA",
"message": "Invalid input.",
"level": "ERROR",
"description": "Error validating schema."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Data structure showing an error 401 related to account types.
{
"errors": [
{
"code": "ACCOUNT_TYPE_ERROR",
"level": "ERROR",
"message": "This account type has no access to get all virtual accounts",
"description": "This account type \"virtual_account\" has no access to get all virtual accounts."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Forbidden
{
"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."
}
]
}{
"errors": [
{
"code": "INVALID_AUTH_TOKEN",
"message": "The token provided is invalid.",
"level": "ERROR",
"description": "Invalid auth token."
}
]
}{
"errors": [
{
"code": "FORBIDDEN",
"message": "A token must be provided.",
"level": "ERROR",
"description": "Operation not allowed due to lack of permissions."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Data structure showing an account does not exist in the system.
{
"errors": [
{
"code": "NOT_FOUND",
"level": "ERROR",
"message": "Not found.",
"description": "The server can not find the requested resource. In the browser, this means the URL is not recognized."
}
]
}{
"errors": [
{
"code": "ACCOUNT_NOT_FOUND",
"level": "ERROR",
"message": "Account not found.",
"description": "The data related to the account with identifier \"a26c7fc3-3f9b-4045-a946-24e565bee1f9\" could not be found."
}
]
}{
"errors": [
{
"code": "REAL_ACCOUNT_VIRTUAL_STRUCTURE_NOT_EXIST",
"level": "ERROR",
"message": "Real account has no virtual account structure",
"description": "This account with an UUID \"698b21e5-016f-487c-b0a7-bb86772f126f\" has no virtual structure ID."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Conflict
{
"errors": [
{
"code": "CONFLICT",
"level": "ERROR",
"message": "Conflict",
"description": "This response is sent when a request conflicts with the current state of the server."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unprocessable Entity
{
"errors": [
{
"code": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"message": "Unprocessable entity.",
"description": "The request was well-formed but was unable to be followed due to semantic errors."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
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"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Service Down Error
{
"errors": [
{
"code": "SERVICE_DOWN_ERROR",
"message": "Service down error.",
"level": "ERROR",
"description": "Service down error."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Gateway Timeout Error
{
"errors": [
{
"code": "GATEWAY_TIMEOUT_ERROR",
"message": "Gateway timeout error.",
"level": "ERROR",
"description": "Gateway timeout error"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.