Error response codes

Error structure

• title: REQUIRED - Short human-readable title for the error.
• httpStatus: OPTIONAL - HTTP Status Code.
• traceId: OPTIONAL - JPMC trace identifier.
• requestId: OPTIONAL - The requestId of your original request.
• context: OPTIONAL (array) - Provides additional context and detail on the validation errors.
  • code: OPTIONAL (string) - JPMC Short code that identifies the error - publicly cataloged and documented.
  • message: REQUIRED (string) - Human-readable textual description of the error.
  • location: OPTIONAL (string) - One 'body', 'query', or 'path'.
  • field: OPTIONAL (string) - The name of the property or parameter in error. Where location is 'body' this SHOULD identify the property using a JSONPath representation.

Embedded Finance Error Code Catalog

The following table catalogs the fundamental codes emitted during API request validation

(Work in progress / more error codes to be added.)

Sync API Example

{
"title" : "Invalid Data",
"httpStatus" : 400,
"traceId" : "xxxxx-yyyyyy-zzzzzz",
"context" : [
{
"code": "10001",
"message": "Property 'amount' must be present",
"field": "amount",
"location": "BODY"
},
{
"code": "10100",
"message": "'pagesize' must be greater than 10",
"field": "pageSize",
"location": "QUERY"
},
{
"code": "10102",
"message": "'toDate must be later than 'fromDate'",
"location": "QUERY"
},
{
"code": "10104",
"message": "XZY is not a valid currency code",
"location": "BODY",
"field": "$.amount.currencyCode"
}
]
}

GCA errors

You may occassionally get error messages from our API gateway. They have a slightly different structure to other synchronous error responses. 

Error payload examples

Take a look at these error message examples to better understand the structure and form of error messages. 

Synchronous API response example

Synchronous API response with GCA error structure

Webhook (asycnhronous) error example