Beta version

Welcome to the beta version of the Global Payments 2 API! For the generally available Global Payments API, refer to Global Payments.

We're refreshing all of our Try-Me-Now scenarios to bring you a more powerful, intuitive, and realistic testing experience. The mock flows are temporarily unavailable while we work behind the scenes - but stay tuned! New and improved scenarios are coming soon to help you explore the Global Payments API.

Changelog

Global Payments 2 API

This page contains updates introduced in Global Payments 2 API.

Version 2.0.22 | May 22, 2025

This section contains updates introduced in Global Payments 2.0.22 API.

What changed 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.

What changed in Global Payments 2.0.21 API
Summary	Description
Added an exceptions block	Added an exceptions block to `GET /payments/returns/{returnId}` and `PaymentReturn` callback schema.
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.

What changed 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.

What changed 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.

What changed 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

What changed in Global Payments 2.0.17 API
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

What changed in Global Payments 2.0.16 API
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 `additionalCreditors`	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

What's new in Global Payments 2.0.15 API
Summary	Description
Added the `paymentRedirection` object	Added the `paymentRedirection` object to the Status schema and callback, to support UK FPS Account Redirection.

Change

What changed in Global Payments 2.0.15 API
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

What changed in Global Payments 2.0.14 API
Summary	Description
Updated the `Request-Id` header	Updated the `Request-Id` header by removing insignificant examples.
Optimized the `purpose` object	Optimized the `purpose` object to ensure consistency with `categoryPurpose`.
Updated mocks and examples	Updated the mocks and examples to reflect the optimization of the `purpose` object.
Updated the `paymentSubStatus` enum	Updated the `paymentSubStatus` enum in the OpenAPI Specification (OAS), mocks, and Postman collection to ensure consistency.
Increased `alternateAccountIdentifier.identifier` max length	Increased the maximum length of `alternateAccountIdentifier.identifier` to 500.

Version 2.0.13 | December 20, 2024

This section contains updates introduced in Global Payments 2.0.13 API.

Change

What changed in Global Payments 2.0.13 API
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

What's new in Global Payments 2.0.11 API
Summary	Description
Expanded availability of ACH and Wire.	ACH credit payments are available in the following countries: Brazil Canada Chile Single Euro Payments Area (SEPA) United Kingdom United States	ACH debit payments are available in the following countries: Canada SEPA United Kingdom United States (includes IAT)	Same-currency wire payments are available in the following countries: Brazil Canada Germany Switzerland United Kingdom United States
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

What changed in Global Payments 2.0.11 API
Summary	Description
Enhanced data capture.	The API schema captures broader upstream payment information for the following: Mandate information Regulatory reporting Settlement information
Enhanced data capture.	The API schema supports multi-party flows that accommodate information for the following: Additional creditor Additional debtor Initiating party Instructed agent Intermediary agents
Improved granular error reporting.	The API schema supports different types of error codes to facilitate payment processing, including, but not limited to, the following: J.P. Morgan proprietary Unified Codes, which are granular to the nature of the error. ISO codes, which ensure industry compatibility. Clearing codes, which support Nacha codes for United States ACH transactions.