Upgrade your API version
Why you should upgrade
Following are the reasons for upgrading your API version:
- Mastercard is undertaking a strategic initiative to simplify interactions with Mastercard Gateway.
- As part of this initiative, the support for older versions of the Payment Gateway APIs will be discontinued.
- The oldest version of the API, dating back to 2010, is considered outdated.
- This version is no longer fit for purpose and in some cases, it is also no longer compliant with current standards.
Migration toolkit
To support you through this Gateway APIs transition, we have prepared comprehensive resources to facilitate a smooth upgrade:
- Migration guides for upgrading from select API versions to version 100.
- Postman examples for version 100 are now available to assist with the upgrade process.
- We have a detailed Changelog documenting all modifications in new API versions.
- Follow the steps on how to test your migrated API versions.
Before you begin
Choose your integration type
To migrate from a legacy version of the Gateway API, follow the guide that most closely represents your current integration and features.
Developers should treat these guides as a starting point and perform thorough testing and validation against their specific use cases, data flows, and business logic. Always consult the API references and changelog for the most accurate and complete information.
| If your current Integration is... | Operation | Integration available from | Upgrade to version 100 |
|---|---|---|---|
| Hosted checkout | Initiate Checkout | 63+ | This guide walks you through the latest changes to help you upgrade your integration. |
| Hosted session: Session | Create checkout session | 27 to 62 | Hosted Checkout: Initiate Checkout v100 |
| Retrieve session | 18+ | Migrate to v100 | |
| Update Session | 18+ | Migrate to v100 | |
| Create Payment Page Session | 17 to 26 | Hosted Checkout: Initiate Checkout v100 | |
| Authorize with session | 2 to 3 | Transaction: Authorize v100 | |
| Create Session | 2+ | Migrate to v100 | |
| Pay with session | 2 to 3 | Transaction: Pay v100 | |
| Save Card (with system-generated token) with Session | 2 to 3 | Tokenization: Create or Update Token v100 | |
| Save Card with Session | 2 to 3 | Tokenization: Create or Update Token v100 | |
|
Direct payment: Transaction |
Authorize |
All versions |
This guide walks you through the latest changes to help you upgrade your integration. |
|
Balance Inquiry |
46+ |
||
|
Capture |
All versions |
||
|
Disbursement |
62+ |
||
|
Pay |
All versions |
||
|
Referral |
4+ |
||
|
Refund |
All versions |
||
|
Retrieve order |
11+ |
||
|
Retrieve Transaction |
All versions |
||
|
Update Application Transaction Counter |
100 |
||
|
Update Authorization |
11+ |
||
|
Verify |
7+ |
||
|
Void |
4+ |
||
|
Hosted Batch: Batch |
Close Batch |
4+ |
This guide walks you through the latest changes to help you upgrade your integration. |
Support
We understand that API migrations can be complex, and we are committed to supporting you throughout this process. Contact our dedicated support team if you have any questions or require additional assistance. If you need technical support during your migration to version 100, contact your Mastercard account manager or email the support team at gateway_support@mastercard.com.