finAPI Error Responses (ErrorMessage type)

Usually error responses in finAPI will look like this:

{
    "errors": [
{ "message": "string",
"code": "string",
"type": "string"
},
...
]
"date": "string",
"requestId": "string",
"endpoint": "string",
"authContext": "string",
"bank": "string"
}

 

Example:

{
    "errors": [
{ "message": "Bank with ID '12345' not found.",
"code": "UNKNOWN_ENTITY",
"type": "TECHNICAL"
}
]
"date": "2017-03-20 13:05:11.719",
"requestId": "selfgen-f60eb395-85da-4219-9cae-f32f1ca71080"
"endpoint": "GET /api/v1/banks"
"authContext": "11/35",
"bank": "00000000 - FinAPI Test Bank"
}


The field "code" can contain the following values depending on the service.
All fields can be filled with different values. Each single service describes in finAPI DOCS which codes can be returned.

  • MISSING_FIELD
  • UNKNOWN_ENTITY
  • METHOD_NOT_ALLOWED
  • ENTITY_EXISTS
  • ILLEGAL_ENTITY_STATE
  • UNEXPECTED_ERROR
  • ILLEGAL_FIELD_VALUE
  • UNAUTHORIZED_ACCESS
  • BAD_REQUEST
  • UNSUPPORTED_ORDER
  • ILLEGAL_PAGE_SIZE
  • INVALID_FILTER_OPTIONS
  • TOO_MANY_IDS
  • BANK_SERVER_REJECTION
  • IBAN_ONLY_MONEY_TRANSFER_NOT_SUPPORTED
  • COLLECTIVE_MONEY_TRANSFER_NOT_SUPPORTED
  • INVALID_TWO_STEP_PROCEDURE
  • MISSING_TWO_STEP_PROCEDURE
  • UNSUPPORTED_MEDIA_TYPE
  • UNSUPPORTED_BANK
  • USER_NOT_VERIFIED
  • USER_ALREADY_VERIFIED
  • INVALID_TOKEN
  • LOCKED
  • NO_ACCOUNTS_FOR_TYPE_LIST
  • FORBIDDEN

The field "type" may contain:

  • BUSINESS (errors depict German error messages for the user, e.g. from a bank server)
  • TECHNICAL (errors depict internal errors, either on the side of finAPI or on the side of a bank server)

The field "bank" contains the BLZ and name of the bank that was involved in the request, if it was a request that involves bank communication (import, update, money transfer or direct debit). Otherwise, the field will be not set (null). 


Authentication errors constitute an exception. E.g. if you want to run a service with a wrong access token the following error message with a 401 HTTP status code is shown:

{
    "error": "invalid_token",
"error_description": "Invalid access token: cccbce46-xxxx-xxxx-xxxx-xxxxxxxxxx"
}

 

Please note: for more information also see the JSON schema.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk