Skip to main content

Core concepts

The Optimization & Protection API allows you to enhance your payments experience in a standalone manner or as an integration to our Online Payments API. This API has the following key features and functionalities:

Instant response

The Optimization & Protection API sends acknowledgements instantly via synchronous response. If you have enabled notifications, the final status is sent via a webhook/asynchronous notification. You can also call the transaction status API to confirm the status of any transaction.

Encryption and security

OAuth2.0 is used for authentication with the Optimization & Protection API.

Throttling and TPS limits

The J.P. Morgan Payments Platform is specifically built to scale with client requirements. It runs on a cloud infrastructure and horizontally scales to support higher processing and bursts of traffic.  

J.P. Morgan does not currently prescribe any Transaction Per Second (TPS) limits or throttling. Some clearing systems may prescribe specific TPS limits that the bank must adhere to depending on the market.

To help you mitigate any issues arising from this, we run a dynamic throttling solution that sends payments to beneficiary banks at a more manageable volume, which results in higher success rates. We are highly experienced in working with high TPS clients in several markets and can enable you to handle bursts and high-volume peaks.

Contact us if you have queries on TPS limit management.

Callbacks/Notifications

Understanding webhooks and callbacks is essential for the Optimization & Protection API. For more information about notifications, see Notifications.

Environments

Our client testing and production environments are available 24/7 with 99.99%+ uptime.

Response reason/error codes

In addition to standard HTTP response codes, the Optimization & Protection API uses four key response values to help you determine the outcome of your request. The following fields are in the body of the response:

Optimization & Protection key response values
Response Description
responseStatus

Valid values include: SUCCESS or ERROR.

  • SUCCESS — This means the request was approved by the issuer or completed successfully.
  • ERROR — This is only returned for 4XX or 5XX HTTP responses.
responseCode This field contains a shorter description of the processing result. For 200 HTTP responses, this is displayed to the consumer.
responseMessage This field contains a longer, more descriptive message. These messages are not intentionally displayed to the consumer.  
hostMessage The term "host" refers to the system from which J.P. Morgan has received a response. The hostMessage is mapped to J.P. Morgan’s response fields, but the unaltered message is returned, if received. For 5XX HTTP responses, the presence of this field indicates where the error exists.

For additional information about response codes and messages, see the API reference.