XS2A Error Handling | finAPI Technical Documentation

HTTP status codes are part of XS2A responses.

XS2A returns error information in the format inside the tppMessages element.

Attribute	Type	Condition	Description
`category`	string	mandatory	constant `ERROR`
`code`	Message Code	mandatory	Message code according to the Berlin Group standard definitions. E.g. `ACCESS_EXCEEDED`, `CONSENT_INVALID`, `RESOURCE_UNKNOWN`, etc.
`text`	Max512Text	optional	Text explaining the error

Attribute

Type

Condition

Description

category

string

mandatory

constant ERROR

code

Message Code

mandatory

Message code according to the Berlin Group standard definitions.

E.g. ACCESS_EXCEEDED, CONSENT_INVALID, RESOURCE_UNKNOWN, etc.

text

Max512Text

optional

Text explaining the error

Example for HTTP Status 429 Too many requests

JSON

{
    "tppMessages": [
        {
            "category": "ERROR",
            "code": "ACCESS_EXCEEDED",
            "text": "Access on accounts has been exceeding the daily multiplicity for consent {consentId}."
        }
    ]
}