Get transaction details

Prev Next
Get
/accounts/{account_id}/transactions/{transaction_id}

Gets transaction details based on an account identifier and transaction identifier.

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
transactions.readRetrieving transaction information
Header parameters
sca-token-id
string

SCA token ID

Min length1
Max length128
Pattern^[a-zA-Z_0-9]*$
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]*$
Path parameters
account_id
Required

Identifier of the account. The number format is defined in the "account_id_type" parameter.

ExampleES8299999999530000000097
transaction_id
stringRequired

Transaction identifier.

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
Query parameters
account_id_country
string

Account id country

Min length2
Max length2
Pattern^[A-Z]*$
ExampleGB
account_id_type
string

Account id type

Valid values[ "iban", "bban", "uuid" ]
Exampleiban
show_caused_by
string

Flag to retrieve the account identifier with type virtual_account or virtual_account_limited which has caused the entry.

Valid values[ "virtual" ]
Examplevirtual
_expand
string

Query param (string, splitted by comma) that determine how many information we should return. Possible values for this query are:

  • transaction_description
  • related_virtual_account

If the value is 'transaction_description', the response includes the transaction additional info.

If the value is 'related_virtual_account', the response includes related virtual account transaction info.

The default value is empty and returns no transaction description.

Valid values[ "transaction_description", "related_virtual_account" ]
Exampletransaction_description
response_type
string

String that in case that it is ISO20022, returns a transactionCategory field like an object in transaction response.

String that in case that it is not ISO20022, returns a transactionCategory field like a string in transaction response.

By default, the value is false.

Valid values[ "ISO20022" ]
ExampleISO20022
Responses
200

Data structure showing client account details.

TRANSACTION
{
  "transactionId": "0f4367d2-5247-46ff-9b60-f52894ef949c",
  "operationDate": "2017-07-21T17:32:28.000Z",
  "valueDate": "2017-07-21T17:32:28.000Z",
  "bookingDate": "2017-07-21T17:32:28.000Z",
  "type": "debit",
  "transactionCategory": {
    "domain": "PMNT",
    "family": "RCDT",
    "subFamily": "DMCT"
  },
  "categoryDescription": "Received Credit Transfers - Domestic Credit Transfer",
  "transactionAmount": {
    "amount": "5000",
    "currency": "GBP"
  },
  "balances": {
    "current": {
      "amount": {
        "amount": "150",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "value": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "consolidated": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "pendingConsolidation": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "withholding": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "overdraft": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "limit": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "available": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    }
  },
  "references": {
    "transactionClientReference": "CF44-312-1234ABC197",
    "transactionBatchReference": "NONREF",
    "transactionInternalReference": "1500CF321006HSK1"
  },
  "additionalInfo": {}
}
TRANSACTION_WITH_CAUSED_BY
{
  "relatedVirtualAccountTransaction": {
    "accountIdentifiersList": [
      {
        "accountIdType": "uuid",
        "accountId": "0589bd6c-cca4-4b46-9c8a-b786171e66d1"
      },
      {
        "accountIdType": "iban",
        "accountId": "GB40PNXT09991100000023",
        "country": "GB"
      },
      {
        "accountIdType": "bban",
        "accountId": "PNXT09991100000023",
        "country": "GB"
      }
    ],
    "transactionDetailsLink": "/accounts/0589bd6c-cca4-4b46-9c8a-b786171e66d1/transactions/0564bd6c-cca4-4b46-9c8a-b786171f66a1/?account_id_type=uuid"
  },
  "transactionId": "0f4367d2-5247-46ff-9b60-f52894ef949c",
  "operationDate": "2017-07-21T17:32:28.000Z",
  "valueDate": "2017-07-21T17:32:28.000Z",
  "bookingDate": "2017-07-21T17:32:28.000Z",
  "type": "debit",
  "transactionCategory": {
    "domain": "PMNT",
    "family": "RCDT",
    "subFamily": "DMCT"
  },
  "categoryDescription": "Received Credit Transfers - Domestic Credit Transfer",
  "transactionAmount": {
    "amount": "5000",
    "currency": "GBP"
  },
  "balances": {
    "current": {
      "amount": {
        "amount": "150",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "value": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "consolidated": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "pendingConsolidation": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "withholding": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "overdraft": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "limit": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    },
    "available": {
      "amount": {
        "amount": "100",
        "currency": "GBP"
      },
      "lastChangeDateTime": "2017-07-21T17:32:28.000Z"
    }
  },
  "references": {
    "transactionClientReference": "CF44-312-1234ABC197",
    "transactionBatchReference": "NONREF",
    "transactionInternalReference": "1500CF321006HSK1"
  },
  "additionalInfo": {}
}
Expand All
object

Data of a transaction

relatedVirtualAccountTransaction
object (RelatedVirtualAccountTransaction)

Related virtual account transaction.

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
transactionDetailsLink
string

Link to the account transactions list.

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ ''""]*$
Example/accounts/e0c38c29-cdc1-4c61-9c14-a877b72cf549/transactions?account_id_type=uuid
transactionId
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
operationDate
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
valueDate
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
bookingDate
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
type
string

Nature of the transaction. Possible values could be: credit, debit, reverse-credit, reverse-debit.

Valid values[ "debit", "credit", "reverse debit", "reverse credit" ]
Exampledebit
transactionCategory
object (TransactionCategoryRequest)

Data structure containing transaction category request.

domain
string

Bank transaction code domain.

Min length4
Max length4
Pattern^[A-Z]*$
ExamplePMNT
family
string

Bank transaction code family.

Min length4
Max length4
Pattern^[A-Z]*$
ExampleRCDT
subFamily
string | null

Bank transaction code sub family.

Min length4
Max length4
Pattern^[A-Z]*$
ExampleDMCT
categoryDescription
string

Transaction category description.

Min length0
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleReceived Credit Transfers - Domestic Credit Transfer
transactionAmount
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
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
value
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
references
object (References)

Types of transactions references.

transactionClientReference
string

Client transaction identification (customer reference included in a domestic electronic statement). If the 'client transaction identification' field is not used in the report for the banking system supervisor for this particular entry, 'NONREF' must be used.

Min length3
Max length255
Pattern^[a-zA-Z_0-9_@./#&+-_ '""]*$
ExampleCF44-312-1234ABC197
transactionBatchReference
string

Transaction identification (customer reference included in a domestic electronic batch). If the 'client batch identification' field is not used in the report for the banking system supervisor for this particular entry, 'NONREF' must be used.

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

Internal reference of the account servicing institution. If there is no information, 'NONREF' must be used.

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

Free JSON object.

Example{}
204

No content

400

Bad Request

INVALID_SCHEMA
{
  "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

Data structure showing an account does not exist in the system.

NOT_FOUND
{
  "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."
    }
  ]
}
ACCOUNT_NOT_FOUND
{
  "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."
    }
  ]
}
REAL_ACCOUNT_VIRTUAL_STRUCTURE_NOT_EXIST
{
  "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."
    }
  ]
}
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

Unprocessable Entity

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."
    }
  ]
}
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