Changelog
Global Payments 2 API
This page contains updates introduced in Global Payments 2 API.
Version 2.2.2 | October 22, 2025
This section contains updates introduced in Global Payments 2.2.2 API.
| Summary | Description |
|---|---|
Improved transactionIdentifier and wire mocks |
Enhanced the description for the transactionIdentifier field in callbacks and GET status responses. US Wire mocks have been updated for consistency. |
| Added support for countries of nationality | Introduced the countriesOfNationality field to the ultimateDebtor field, supporting IN IMPS RDA (FIR Flow). All related mocks, examples, and test collections are updated. |
Version 2.2.1 | October 16, 2025
This section contains updates introduced in Global Payments 2.2.1 API.
| Summary | Description |
|---|---|
| Improved test scripts and mock data | Integration testing is now more reliable with improved scripts and mock data. |
| Removed malformed request headers | Malformed request headers have been removed from test collections. |
| Made endToEndId optional | The endToEndId field is now optional in the QUERY endpoint, providing greater flexibility. |
Version 2.2.0 | October 10, 2025
This section contains updates introduced in Global Payments 2.2.0 API.
| Summary | Description |
|---|---|
Consolidated GET endpoints |
Consolidated GET endpoints for simpler integration and removed the /payments/{paymentId}/status endpoint. |
| Updated schema structures | Updated the schema structures for payment returns and requests to improve clarity and consistency. |
| Changed client testing environment URL | The client testing environment URL has been changed to Sandbox for improved accuracy. |
| Enhanced webhook visibility | A new custom annotation has been added for better webhook visibility. |
| Rolled back certain webhook and specification changes | Certain webhook and specification changes have been rolled back to maintain platform stability. |
Version 2.1.6 | October 1, 2025
This section contains updates introduced in Global Payments 2.1.6 API.
| Summary | Description |
|---|---|
| Updated payment initiation and returns endpoints | Endpoints have been updated to support enhanced security standards. |
| Improved test collections and mock logic | Default responses in test collections and mock logic are now more accurate. |
| Removed outdated examples and cleaned up test collections | Outdated examples have been removed and test collections have been cleaned up. |
| Upgraded to OpenAPI Specification v3.1.0 | Documentation and compatibility have been improved with the upgrade to OpenAPI Specification v3.1.0. |
| Migrated callback functionality | Callback functionality has been migrated to the new webhooks object. |
Version 2.1.5 | September 19, 2025
This section contains updates introduced in Global Payments 2.1.5 API.
| Summary | Description |
|---|---|
| Updated India IMPS examples | India IMPS examples have been updated and references to unrelated markets removed. |
| Improved UK FPS mock test scripts | UK FPS mock test scripts have been improved and regular mock testing enabled. |
| Enabled release targets for mocks | Release targets for mocks have been enabled in the API configuration. |
Version 2.1.4 | September 9, 2025
This section contains updates introduced in Global Payments 2.1.4 API.
| Summary | Description |
|---|---|
| Enhanced gateway configurations | Gateway configurations have been enhanced. |
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:
|
.