Changelog
Global Payments 2 API
This page contains updates introduced in Global Payments 2 API.
Version 2.2.0 | October 10, 2025
This section contains updates introduced in Global Payments 2.2.0 API.
| Summary | Description |
|---|---|
| Acknowledged accepted payments | Acknowledged accepted payments with an HTTP 201 response instead of HTTP 202 for both the payments and payment returns endpoints. Updated the response body to include additional parameters, such as payment status. |
| Acknowledged duplicate payments | Acknowledge duplicate payments with an HTTP 200 response instead of HTTP 202 on both the payments and payment returns endpoints, and enhance the response body to explicitly identify duplicate payments. |
| Enhanced QUERY endpoint | Supported querying a payment by paymentId in addition to endToEndId in the QUERY endpoint. |
Consolidated GET endpoints |
Consolidated GET endpoints into a single resource. Removed the GET /payments/{paymentId}/status endpoint for a simpler experience. |
| Updated OAS and mocks | Updated schemas and mock payloads to reflect the above changes. |
| Updated client testing environment URL | Updated the CAT environment URL to the sandbox URL for improved accuracy in the testing environment. |
| Improved webhook visibility | Added the x-jpmc-webhooks annotation for better webhook visibility on the PDP. |
| Reverted webhook and OAS version changes | Rolled back changes to webhook definitions and OAS versions to maintain stability. |
Version 2.1.3 | September 4, 2025
This section contains updates introduced in Global Payments 2.1.3 API.
| Summary | Description |
|---|---|
| Added production-sandbox | Added production-sandbox as an API gateway deployment target. |
Version 2.1.2 | August 28, 2025
his section contains updates introduced in Global Payments 2.1.2 API.
| Summary | Description |
|---|---|
Added transactionIdentifier attribute |
For read-only scenarios, added the transactionIdentifier attribute to otherPaymentReferences. |
| Updated URL descriptions | Updated the URL descriptions for Prod, CAT, and Mock. |
| Enabled digital signing for returns | Enabled digital signature capabilities for posting returns via the returns end point. |
Version 2.1.1 | August 28, 2025
This section contains updates introduced in Global Payments 2.1.1 API.
| Summary | Description |
|---|---|
Added new property productCode |
Updated API config with new the property productCode. |
Version 2.1.0 | August 21, 2025
This section contains updates introduced in Global Payments 2.1.0 API.
Summary |
Description |
|---|---|
Client Initiated returns |
Introduced 2 new endpoints:
|
Version 2.0.25 | August 14, 2025
This section contains updates introduced in Global Payments 2.0.25 API.
| Summary | Description |
|---|---|
Updated URL descriptions |
Exposed mock URLs and updated sandbox to client testing. |
| Reintroduced sample payloads | Restored sample payloads and basic payload mocks for select markets. |
Version 2.0.24 | August 07, 2025
This section contains updates introduced in Global Payments 2.0.24 API.
| Summary | Description |
|---|---|
Updated URL descriptions |
Made cosmetic improvements to the URL description on the API References Overview page. |
Version 2.0.23 | June 05, 2025
This section contains updates introduced in Global Payments 2.0.23 API.
| Summary | Description |
|---|---|
Included sandbox URLs |
Added and exposed sandbox endpoints for client testing in the API References Overview page. |
Increase field length for countrySubDivision |
Extended the maximum length for the countrySubDivision fields to 35 characters. |
| Updated mocks for callbacks | Refined callback mock to align with the latest specifications for type. |
Removed eventContext from callbacks |
Updated the specification by removing the unused eventContext field from callbacks during a routine review. |
Version 2.0.22 | May 22, 2025
This section contains updates introduced in Global Payments 2.0.22 API.
| Summary | Description |
|---|---|
Version bump due to RTL pipeline issues. |
Version bump due to RTL pipeline issues. |
Version 2.0.21 | May 21, 2025
This section contains updates introduced in Global Payments 2.0.21 API.
| Summary | Description |
|---|---|
| Added an exceptions block | Added an exceptions block to |
Refactored CardAccount object |
Refactored the network field in CardAccount to a string with acronyms as documentation. |
| Updated WPI kill switch error message | Updated WPI kill switch error message. The new WPI message is channel agnostic. |
| Removed all mock examples | Removed all mock examples. |
Version 2.0.20 | April 14, 2025
This section contains updates introduced in Global Payments 2.0.20 API.
| Summary | Description |
|---|---|
Updated CardAccount object |
Added a new optional network property to CardAccount object. The enum includes VISA and MASTERCARD. |
Relaxed validation for debtorAgent |
Made financialInstitutionIds for debtorAgent conditional to support WIRE payment flow. |
Expanded enum for creditor.accountType |
Expanded enum for creditor.accountType by adding CACR, NROR, and SNRR to support India's Immediate Payment Service (IMPS). |
| Updated WIRE PACS.009 flow | Added previousInstructingAgent to additionalParties as replacement for additionalDebtors to support WIRE PACS.009 flow. |
Version 2.0.19 | March 24, 2025
This section contains updates introduced in Global Payments 2.0.19 API.
| Summary | Description |
|---|---|
| Updated payment initiation mock response | Updated payment initiation mock response to include duplicateRequest flag. |
Version 2.0.18 | March 15, 2025
This section contains updates introduced in Global Payments 2.0.18 API.
| Summary | Description |
|---|---|
Updated clearingSystem.name |
clearingSystem.name updated to include INTERAC as enum value. |
| Updated fields with min/max constraints | Updated the API specification to include minimum and maximum character lengths for the missing fields. |
Moved achTraceNumber and paymentBatchId |
Moved achTraceNumber and paymentBatchId to paymentIdentifiers for the response-only flow. This update affects only callbacks, GET endpoints and request flow is not impacted. |
| Added WPI kill switch changes | Included a new response header Retry-After response code and UEC code - 12995 added to the 503 response for payment initiation response. |
Version 2.0.17 | March 14, 2025
This section contains updates introduced in Global Payments 2.0.17 API.
Change
| Summary | Description |
|---|---|
| Updated query payment response | Updated query payment response object to return an array of payments. |
Version 2.0.16 | February 18, 2025
This section contains updates introduced in Global Payments 2.0.16 API.
Change
| Summary | Description |
|---|---|
Updated POST/payments callback |
Updated POST/payments callback definition to support generic event schema. |
Added achTraceNumber and valueDate |
Added achTraceNumber and valueDate to Callback, Payment Status and Payment Detail schema for US ACH. |
Added clearingSystem |
Introduced the clearingSystem component to support India IMPS and created the corresponding mocks and examples. |
Updated |
Updated additionalCreditors to support TP3, TP4, TPx flows. |
Version 2.0.15 | February 14, 2025
This section contains updates introduced in Global Payments 2.0.15 API.
New
| Summary | Description |
|---|---|
Added the |
Added the paymentRedirection object to the Status schema and callback, to support UK FPS Account Redirection. |
Change
| Summary | Description |
|---|---|
Updated fields with min/max constraints |
Updated the API specification to include minimum and maximum character lengths for all fields. |
Version 2.0.14 | February 3, 2025
This section contains updates introduced in Global Payments 2.0.14 API.
Change
| Summary | Description |
|---|---|
Updated the |
Updated the |
Optimized the |
Optimized the |
Updated mocks and examples |
Updated the mocks and examples to reflect the optimization of the |
Updated the |
Updated the |
Increased |
Increased the maximum length of |
Version 2.0.13 | December 20, 2024
This section contains updates introduced in Global Payments 2.0.13 API.
Change
| Summary | Description |
|---|---|
| Updated JPM Coin System to Kinexys Digital Payments | Updated the naming of JPM Coin System to Kinexys Digital Payments to reflect product rebranding. |
| Updated Kinexys endToEndId length to 16 characters | Updated E2E ID used in transaction for Kinexys DDA and BDA transactions to have a maximum length restriction of 16 characters. |
| Updated the JPM support page link | Corrected the link to reach out to JPMorgan Support on the Payments Developer Portal. |
Added the x-jpmc-performance-sla field |
Added the x-jpmc-performance-sla field to the API specification. |
Increased the maximum character length for the city field |
Increased the maximum character length for the city field to 35. |
Version 2.0.11 | November 6, 2024
This section outlines updates in Global Payments 2.0.11 API compared to Global Payments 1.1.26 API.
New
| Summary | Description | ||
|---|---|---|---|
| Expanded availability of ACH and Wire. | ACH credit payments are available in the following countries:
|
ACH debit payments are available in the following countries:
|
Same-currency wire payments are available in the following countries:
|
| Reordered schema by objects. | The reordered schema logically uses objects as the building blocks for making payments. This ensures that the information is expandable, context-aware, and sustainable in terms of API evolution. | ||
| Added support for Wire. | Wire supports low-value and high-value payments in the same currency. | ||
| Added idempotency key. |
An idempotency key enhances duplicate checks of payments. | ||
Change
| Summary | Description |
|---|---|
| Enhanced data capture. | The API schema captures broader upstream payment information for the following:
|
The API schema supports multi-party flows that accommodate information for the following:
|
|
| Improved granular error reporting. | The API schema supports different types of error codes to facilitate payment processing, including, but not limited to, the following:
|
.