Error Code Explanation
Errors in Domestic Payment and Domestic Payment Consent APIs
Below table depicts HTTP status codes and JSON error code and messages in the error response payload.
| HTTP Status Code | Scenario | UK Error Code | Error Messages | Error Code |
|---|---|---|---|---|
| 400 | Request payload field validation failure | UK.OBIE.Field.Invalid | Invalid remittance information provided | 400 |
| Invalid country code provided | ||||
| Invalid country subdivision provided | ||||
| Invalid address line provided | ||||
| Invalid scheme provided | ||||
| BAD_REQUEST_BODY | instance value not found in enum | |||
| BAD_REQUEST_BODY | object has missing required properties | |||
| UK.OBIE.Field.InvalidDate | Provided date-time expired | |||
| UK.OBIE.Unsupported.Scheme | Invalid scheme provided | |||
| UK.OBIE.Unsupported.Currency | Invalid currency provided in request | |||
| UK.OBIE.Unsupported.LocalInstrument | Invalid local instrument provided | |||
| Header Validation Failure | UK.OBIE.Header.Invalid | Invalid Idempotency key provided in header | ||
| BAD_REQUEST_PARAMTER | Missing required request parameters | |||
| Request Signature Validation Failure | UK.OBIE.Signature.Invalid | Unable to parse x-jws-signature header | ||
| UK.OBIE.Signature.InvalidClaim | Invalid claim headerType present in joseHeader of x-jws-signature | |||
| Invalid claim headerType present in joseHeader of x-jws-signature | ||||
| Unable to parse claims present in joseHeader of x-jws-signature | ||||
| UK.OBIE.Signature.MissingClaim | Mandatory claim missing alg in joseHeader of x-jws-signature | |||
| UK.OBIE.Signature.Malformed | Unable to parse x-jws-signature header | |||
| UK.OBIE.Signature.Missing | Mandatory claim http://openbanking.org.uk/iss missing in joseHeader of x-jws-signature header | |||
| Consent/Payment retrieval for invalid consentId/paymentId | UK.OBIE.Resource.NotFound | Invalid payment id format | ||
| Staged payment setup resource is expired | ||||
| Missing Payload | UK.OBIE.Resource.InvalidFormat | invalid payload found during jws verification | ||
| Consent validation failure in idempotent payment retries/payment initiation | UK.OBIE.Resource.ConsentMismatch | Payload comparison failed with the consent resource | ||
| Consent not authorized before payment attempt | UK.OBIE.Resource.ConsentStatusNotAuthorised | Corresponding consent resource doesn't have required status to proceed | ||
| Consent status validation failure | UK.OBIE.Resource.InvalidConsentStatus | Corresponding consent resource doesn't have required status to proceed | ||
| Bank adapter failure | OB.Adapters.Field.MissingOrInvalid | BankId no se encuentra registrado | 404 | |
| 401 | Token expiry/cross token usage | UNAUTHORIZED | User is unauthorized from accessing the requested resource | 401 |
| Header Invalid: Authorization and DPoP | ||||
| Path Parameter Invalid: Bank | ||||
| 403 | Token with invalid scope | FORBIDDEN | User is not authorized to access this resource with an explicit deny | 403 |
| 500 | Invalid response format | INTERNAL_SERVER_ERROR | Internal Server Error | 500 |
| 415 | Invalid content type | NA | Unsupported Media Type | 415 |
| 429 | Too many retries | NA | NA | 429 |
| 500 | Internal Server Error | UK.OBIE.UNEXPECTEDERROR | 500 Internal Server Error | 500 |
| duplicate payment id used | ||||
| invalid response from OB jwks endpoint | ||||
| Required 'intentId' missing for Consent validation | ||||
| Payment context incompatible with risk delivery address |
Errors in Authorization Server and DCR APIs
| Status Code | Scenario | UK Error Code | Error Messages | Code |
|---|---|---|---|---|
| 400 | DCR Post | REDEBAN.OBIE.Invalid.Redirect.Url | Redirect url is not registered | 400 |
| REDEBAN.OBIE.Invalid.Request.Uri | Request uri is not valid | |||
| REDEBAN.OBIE.Invalid.SSA.Signature | Signature of the SSA token is invalid | |||
| REDEBAN.OBIE.Invalid.JWT | Registration JWT token is invalid | |||
| REDEBAN.OBIE.Token.Type.Invalid | Token is of Invalid Type | |||
| REDEBAN.OBIE.Invalid.SSA.Payload | SSA IAT is mandatory | |||
| REDEBAN.OBIE.Invalid.SSA.Payload | SSA JTI is mandator | |||
| REDEBAN.OBIE.SSA.Is.Mandatory | Software statement is missing in request | |||
| REDEBAN.OBIE.Invalid.SSA.Payload | SSA ORG ID is mandatory | |||
| REDEBAN.OBIE.Invalid.SSA.Payload | SSA ORG Short Name mandatory | |||
| REDEBAN.OBIE.Invalid.SSA.Payload | SSA ORG JWKS end point is mandatory | |||
| REDEBAN.OBIE.Client.Meta.Data | DCR issuer is manadatory | |||
| REDEBAN.OBIE.Client.Meta.Data | Aud is mandatory | |||
| REDEBAN.OBIE.Client.Meta.Data | Expiry time is mandatory | |||
| REDEBAN.OBIE.Client.Meta.Data | Software statement is missing in request | |||
| REDEBAN.OBIE.Client.Meta.Data | Grant types is mandatory | |||
| REDEBAN.OBIE.Client.Meta.Data | Response type is mandatory | |||
| Token | REDEBAN.OBIE.Invalid.Client.Id | Client id is not valid | ||
| REDEBAN.OBIE.Invalid.Client.Assertion.Type | Input client assertion type is not valid | |||
| REDEBAN.OBIE.Invalid.Request.Scope | Input scope is not valid | |||
| REDEBAN.OBIE.Bank.Is.Not.Exists | Request bank is invalid | |||
| REDEBAN.OBIE.Invalid.Grant.Type | input grant type is not valid | |||
| REDEBAN.OBIE.Invalid.Client.Assertion.Type | Input client assertion type is not valid | |||
| REDEBAN.OBIE.Invalid.Client.Assertion.Jwt | Input client assertion jwt is not valid | |||
| REDEBAN.OBIE.Invalid.Authorization.Code | Input authorization code is not valid | |||
| PAR | REDEBAN.OBIE.Invalid.Client.Id | Client id is not valid | ||
| REDEBAN.OBIE.Invalid.Client.Assertion.Type | Input client assertion type is not valid | |||
| REDEBAN.OBIE.Invalid.Request.Scope | Input scope is not valid | |||
| REDEBAN.OBIE.ConsentId.Mandatory | No Consent id found in the request | |||
| REDEBAN.OBIE.Invalid.Response.Type | Input response type is not valid | |||
| REDEBAN.OBIE.Invalid.Code.Challenge | Input code challenge not valid | |||
| REDEBAN.OBIE.Invalid.Code.Challenge.Method | Input code challenge method not valid | |||
| 500 | Internal Server Error | UK.OBIE.UnexpectedError | Techical error. | 500 |
| Technical error while establishing data base connection | ||||
| 500 Internal Server Error |
Errors in Bank Integration APIs
| Status Code | Scenario | UK Error Code | Error Messages | Code |
|---|---|---|---|---|
| 400 | Backchannel APIs | REDEBAN.OBIE.Field.Invalid | Invalid consent id | 400 |
| REDEBAN.OBIE.Data.NotFound | No data found for the payment consent Id | |||
| REDEBAN.OBIE.Header.Tenant.Id.Missing | Tenant id not found | |||
| REDEBAN.OBIE.Field.Missing | Request payload invalid | |||
| REDEBAN.OBIE.Field.Missing | Request data payload invalid | |||
| REDEBAN.OBIE.Field.Missing | Input sub is not found | |||
| REDEBAN.OBIE.Field.Missing | No debtor account found in request | |||
| REDEBAN.OBIE.Field.Missing | Input balance is not found | |||
| REDEBAN.OBIE.Field.Missing | Input currency is not found | |||
| 500 | Internal Server Error | UK.OBIE.UnexpectedError | Techical error. | 500 |
| Technical error while establishing data base connection | ||||
| 500 Internal Server Error |