Skip to main content

Embedded Payments

Use Embedded Payments APIs to integrate account management and payout services into your existing platform. The API resources provided are designed as a series of logical components that make it easy for you to build an account and payment ecosystem

For more information refer to the Embedded Payments guides.

Versioning

Embedded Payments API supports versioning using a prefix in the endpoint URL. This prefix has the following format: "vXX", where XX is the version number.

For example:

https://api-mock.payments.jpmorgan.com/tsapi/v1/ef/clients

Which version to use

Always use the latest version of the Embedded Payments API. 

Note: The transactions resource is always a version ahead of the other endpoints in the Embedded Payments API. Use the drop-down menu to toggle between versions to see transactions specifications. 

For example: 

  • V2.0.9 contains transactions endpoints. 
  • V1.0.9 contains all other Embedded Payments endpoints. 

Production endpoints

The Embedded Payments API has one production endpoint https://apigateway.jpmorgan.com/tsapi/v1/ef

For example:

https://apigateway.jpmorgan.com/tsapi/v1/ef/clients

Error reason codes

The Embedded Payments API uses standard HTTP response codes, and provides additional detail through the error response payload. Further details are provided in the Error response codes section.