M Trans API PG En-Us
M Trans API PG En-Us
Acquirers
Product Guide
11 February 2025
Contents
Contents
Chapter 4: Implementation......................................................................................................... 16
Implementation process overview...................................................................................................... 17
Implementation process..................................................................................................................17
Implementation stages...................................................................................................................17
1. Project initiation..................................................................................................................... 18
2. MTF onboarding......................................................................................................................18
3. MTF testing............................................................................................................................. 19
4. Production onboarding..........................................................................................................20
5. Production testing..................................................................................................................20
6. Go-Live..................................................................................................................................... 20
Customer implementation services....................................................................................................20
Appendix A: Glossary........................................................................................................................25
Terms and definitions............................................................................................................................26
Notices.......................................................................................................................................................33
ATTENTION: Transaction APIs (TAPI) are not yet available in countries with on-soil requirements.
Audience
The intended audience for this guide is acquirers and third-party processors. Refer to the
"Intended audience" section of this manual for additional details.
Product
Transaction APIs for acquirers implements a JSON-based APIs suite for authorization, reversal,
inquiry, and clearing using the International Organization for Standardization (ISO) 20022
Acquirer-to-Issuer Card Messages (ATICA) standards.
Table 1: Details
Metadata Value
Audience Acquirers and third-party processors.
Product Network Solutions, Clear Now for Acquirers, Clear
On Demand for Acquirers (GCMS), Mastercard
Edge Connectivity products, Economics as a
Service, Switching (Authorization), Switching
(Clearing), Transaction APIs
Region Global
Type Guide, Product or service guide, Product guide
Publish Date 11 February 2025
Intended audience
Mastercard provides this guide for acquirers and third-party processors for their sole use.
This guide is for the following audiences:
• Acquiring customers interested in enabling Transaction APIs to interface with the Mastercard
Network for authorization and clearing using Mastercard Edge Connectivity products.
• Third-party processors and other categories of acquirer service providers that are interested
in future phases of Transaction APIs to interface with the Mastercard Network for
authorization and clearing.
Contact information
Customers that have questions related to Transaction APIs can refer to the “Frequently asked
questions” appendix, or contact:
• Their Mastercard representative for further information.
• Customer support at customer_support@mastercard.com.
NOTE: If you do not have a Mastercard representative, assistance can be obtained from the
Mastercard Developers support page: https://developer.mastercard.com/.
Revisions
The guide and related materials are subject to change from time to time. Mastercard has the
right, in its sole discretion, to interpret, amend, and enforce this guide.
A subsequent revision is effective as of the date indicated in the publication and has precedence
over any previous edition. In the event of a conflict between this guide and a subsequently
published edition, the subsequently published edition has precedence.
Authorization
An online authorization message establishes the availability of funds and ensures that the card
is valid for use (for example, not reported as stolen). During authorization, a cardholder presents
the card or cardholder account number as payment in exchange for goods and services to the
merchant. The acquirer transmits the transaction to the Mastercard Network, which then
routes to the issuer responsible for approving or declining the authorization request. Once the
transaction is authorized successfully, both the issuer and acquirer support clearing and
settlement functions to exchange funds between the cardholder and the merchant.
Clearing
Clearing is the process of exchanging financial and non-financial data through a network before
settlement. During clearing, transaction payment data passes between issuers and acquirers
through the Mastercard Network.
Single message systems combine the authorization and clearing messages into a single online
message. Historically, single message systems were only used by Maestro® and Cirrus® card
brands in all regions except the Europe region.
Dual message systems use authorization and clearing messages that are separate instances.
The clearing message then confirms the full details of the completed transaction and includes
the final amount.
Settlement
Settlement is the process by which funds are exchanged based on the net value of all completed
and cleared financial transactions for each settlement day. The exchange of successfully
processed detailed financial transaction data through the Mastercard clearing system
represents an obligation to exchange funds. To facilitate the settlement of funds, Mastercard
uses the Settlement Account Management (SAM) system to streamline the process of moving
funds.
Prerequisite information
Transaction APIs is offered to acquirers and processors as an opt-in selection. Participation is
not mandatory.
Interested acquirers, issuers, or processors must fulfill these prerequisites:
• Onboarded as a licensed Mastercard member.
• Have a foundational business and technical understanding of transaction processing,
including authorization, clearing, and settlement.
• Have established Mastercard Edge connectivity to Mastercard.
NOTE: For more information on Mastercard Edge Connectivity products see the Mastercard Cloud Edge
Product Guide and Mastercard Co-Lo Edge Product Guide documentation.
To participate in Transaction APIs, acquirers, issuers, and processors must comply with the
Mastercard Standards, Rules, manuals, bulletin announcements, release announcements,
guidelines, technical specifications, Transaction APIs documentation (including but not limited to
this guide), and any other requirements set forth in this guide, each as amended from time to
time:
• Submit a completed enrollment form to their Mastercard representative (subject to
Mastercard approval).
• Support the Transaction APIs implementation process and complete the testing.
• Comply with all applicable laws and regulations.
It is the responsibility of the customer participating in Transaction APIs to ensure that their
infrastructure is configured to support Transaction APIs, according to specified standards in this
guide.
Benefits
Transaction APIs provide a simpler API interface for acquirers and processors to communicate
with the Mastercard Network. APIs based on the ISO 20022 ATICA specification means that
acquirers can use industry standards for card payments and expand to other payment types.
By using the latest technology, customers are no longer required to use a MIP hardware
appliance, they can now connect using Mastercard Edge Connectivity products. Transaction APIs
help eliminate the manual processes and is designed to enable acquirers to integrate their
payments systems to their other interfaces seamlessly. By using the latest technology,
Transaction APIs help Mastercard acquirers meet their customer expectations, scale-up in the
future, and remain competitive in the long-term.
Supported APIs
Transaction APIs enable acquirers and processors to interface with the Mastercard Network
using APIs. All the information needed to initiate the authorization, reversal, inquiry, and clearing
of card payments can be sent at a transaction level using the APIs channel.
The following table details the ISO 20022 Acquirer to Issuer Card Messages (ATICA) standard.
NOTE: For detailed message flow diagrams of the Transaction APIs, see the Mastercard Developers
support page.
Authorization API
The Authorization API allows exchanging Authorization Initiation Request and Response
messages to request approval of authorization or guarantee for a transaction to proceed.
The Authorization Initiation Request message is not intended to permit the application of this
transaction to the cardholder's account for issuing a bill or statement. Authorization
transactions assume that follow-up information, for example a Financial Advice API message or
a batch file that contains clearing messages are used to affect an actual settlement, cardholder
account posting, and cardholder billing.
The Authorization Response message carries the response information required to service (apply
or deny) the Authorization Initiation Request message.
NOTE: For detailed message flow steps and diagrams of the Authorization API, see the Mastercard
Developers support page.
Reversal API
Acquirers must send a Reversal Initiation Request when they are unable to deliver an issuer's
approved Authorization Response to a merchant. Merchants may also request their acquirers to
send a Reversal Initiation Request message to cancel the full or partial amount of the original
authorization amount.
NOTE: For detailed message flow steps and diagrams of the Reversal API, see the Mastercard
Developers support page.
Inquiry API
The acquirer Inquiry Request message requests the status of various aspects of a cardholder's
account with an issuer.
Inquiry transactions are considered non-financial and must be followed up with a subsequent
authorization, reversal, or financial request or advice. The inquiry response message contains the
results of the inquiry made by the acquirer or processor.
NOTE: For detailed message flow steps and diagrams of the Inquiry API, see the Mastercard
Developers support page.
NOTE: It is recommended that a new Transaction API customer that wants to benefit from the
Financial Advice API be onboarded as a new clearing customer.
NOTE: It is recommended that a new Transaction API customer that wants to benefit from the
Financial Request API be onboarded as a new clearing customer.
Environment Description
MTF (Mastercard Test Facility) The pre-production test environment contains the
latest pre-release or released version of the APIs,
intended for full integration testing, before moving
to production. At this stage, use the MTF keys
generated during the project creation.
Environment Description
Production The production environment contains the latest
production API release. You can request approval to
obtain the Production keys. Once approved, you
can proceed to complete your Production
Validation process in the production environment
before launching your solution. You can ramp up
slowly if you choose, but testing is not permitted in
the production environment.
NOTE: For detailed message flow steps and diagrams of the Financial Advice API, see the Mastercard
Developers support page.
API specifications
Use cases
Transaction APIs enable Mastercard customers to process financial and non-financial requests
that follow ISO 20022 ATICA standards.
Customers should refer to Mastercard Developers for the current list of use cases supported by
Transaction APIs.
Chapter 4 Implementation
This chapter provides an overview of how Transaction APIs (TAPI) is implemented, tested, validated, and
the expected timeframes associated with the testing.
Implementation process
The following table summarizes some of the impacts of implementing Transaction APIs on
participating acquirers' operations.
Implementation stages
Standard Transaction APIs implementation have the following stages:
Figure 1: Transaction API implementation stages
1. Project initiation
During project initiation, the project scope is discussed, and the acquirer can specify which of
their ICA numbers are eligible for the Transaction APIs implementation.
Transaction APIs are currently only available to support acquirer Mastercard Edge connectivity
infrastructure and not traditional MIP connectivity to acquirer physical data center.
The Mastercard terminal integration (M-TIP) is a process designed to provide Mastercard with a
suitable level of confidence that a given acquirer deployment does not damage Mastercard
operations or reputation.
Acquirers participating in Transaction APIs with terminals are required to execute M-TIP
certification before going live with Transaction APIs.
Mastercard responsibilities:
• Work with customer to setup MTLS key exchanges through the Key Management Portal on
Mastercard Connect®
• Implement TLS 1.2 certificates for acquirer security.
• Provide the five Transaction APIs endpoints:
– Authorization
– Reversal
– Inquiry
– Financial Advice
– Financial Request
M-TIP certifies the Transaction APIs instance of an acquirer deployment. On successful
completion of M-TIP, the participating acquirer receives an M-TIP Letter of Approval (LoA).
For more information about the M-TIP process, refer to the M-TIP Process Guide located in The
Technical Resource Center (TRC) on Mastercard Connect.
NOTE: Enabling an Edge product for use with Transaction APIs requires approximately 6-8 weeks.
2. MTF onboarding
The acquirer responsibilities include:
• Validate that their ICA number is active and choose to use their existing ICA number or have
a new ICA number created for them.
• Ensure that their infrastructure is configured to correctly to process the APIs messages
according to the supported APIs in this guide. The build process contains two main activities:
– The setup of Mastercard Edge Connectivity products
– The acquirer's building of their APIs
3. MTF testing
Acquirers are required to test the Transaction APIs functionality in the Mastercard Test Facility
(MTF) before promotion to the production environment.
Mastercard has created specific test cases for this product. Test cases and the additional
Transaction APIs relevant content is accessible through Mastercard Developers. Acquirers are
granted access to Mastercard Developers as part of their onboarding process.
There are four stages to the MTF testing:
• Test Strategy
• Test Approach
• Test Procedure
• Test Cases
Test Strategy
Testing is conducted through a combination of:
• Online Testing: Acquirers are to use the MTF environment listed on Mastercard Developers.
Customers should refer to the Mastercard Developers for information on preparing for
Transaction APIs Testing.
• Integrated Testing: If acquirers choose to perform Authorization API or Financial Request
API testing without using the Financial Advice API, they can use the business as usual (BAU)
Batch clearing process using IPM files
NOTE: To achieve MTF certification, acquirers must execute the prescribed tests and receive sign-off
from the Mastercard CIS Team.
Test Approach
The test approach guides the acquirers through the test procedures for each of the APIs
endpoints that replicate the behavior of the Mastercard Network, providing symmetry of
testing between ISO 8583 and ISO 20022 implementations. Each set uses the test case suite as
the ISO 8583 interface converted to ISO 20022 format. A Customer Implementation Services
(CIS) Test Lead assists each acquirer to tailor the test case suite based upon the
implementation requirements of the customer.
Test Procedure
Transaction APIs use the test case suite of ISO 8583 test cases in association with ISO 20022
mapping. The following are the steps to perform the testing:
1. Based on your implementation requirements, agree with your CIS Test Lead on the scope of
tests to execute from the Acquirer Credit and Debit Test Cases document located in The
Technical Resource Center (TRC) on Mastercard Connect.
2. Using the ISO 20022 to ISO 8583 mapping, you may convert the test cases in the Acquirer
Credit and Debit Test Cases document to ISO 20022 messages. Refer to the Transaction
APIs specific mapping documents on Mastercard Developers.
Test Cases
Customers should refer to Mastercard Developers for examples of test cases and payloads
supported by Transaction APIs. Upon testing completion, Mastercard validates the test results
and issues a Testing Acknowledgement Notification (TAN) to summarize the results and
acknowledges the completion of all testing requirements.
4. Production onboarding
Mastercard promotes the acquirer to the production instance of the Transaction APIs after a
TAN has been issued.
5. Production testing
Acquirers are required to run the recommended test cases available in Mastercard Developers in
the Production environment before scaling their Transaction APIs traffic. The acquirer
collaborates with their Mastercard representative to define an appropriate ramp-up plan.
6. Go-Live
After the acquirer is comfortable using Transaction APIs with limited volume, they can scale
their usage according to the ramp-up plan defined during the Production Testing stage.
Production Go-Live checklist:
1. Production connection to the Mastercard Edge Connectivity products
2. MTF Certification
3. M-TIP Certification (for customers using a terminal)
4. Successful completion of the Production Validation within the Production environment
5. The acquirer has been informed of the go-live support model
Reporting................................................................................................................................................................22
Mastercard support contact information.........................................................................................................22
Customer support process..................................................................................................................................22
1. Customer contacts Mastercard................................................................................................................23
2. Case created and assigned a priority...................................................................................................... 23
3. Mastercard teams engaged for resolution.............................................................................................24
4. Issue resolved...............................................................................................................................................24
Mission Control & Operations (MC&O) - critical issues.................................................................................. 24
Reporting
Transaction APIs do not currently provide any external reporting. Acquirers can refer to their
BAU reporting mechanisms.
Channel Description
Phone
(US toll-free) +1-800-999-0363
(International) +1-636-722-6176
Hours of operation: 24 hours a day, 7 days a
week
Email: Customer_support@mastercard.com.
Technical Resource Center (TRC) Enter the TRC and select Contact Us.
4. Issue resolved
The customer receives notification when the issue is resolved.
Appendix A Glossary
This appendix lists the terms and definitions of the Transaction APIs (TAPI).
The following table lists the terms and definitions used throughout this guide.
Term Definition
cain Corporate Action Instruction Message. A group of
ISO 20022 messages used by Transaction APIs.
Dual Message Authorization System A system that processes financial transactions.
Authorization and clearing occur in two separate
messages. The system typically processes credit
and signature debit transactions.
GET An HTTP method used for retrieving data.
Global Clearing Management System (GCMS) A centralized clearing facility owned and operated
by Mastercard for the daily processing and routing
of financial transactions between Mastercard and
its customers.
Global File Transfer Global File transfer (GFT) provides enterprise-wide
file exchange solutions for Mastercard.
Integrated Product Message (IPM) A format for the processing of clearing activity and
interchange-related activity. The message format
uses a variable-length and variable-format
structure based on the International Organization
for Standardization (ISO) 8583:1993 standard.
International Standard Organization (ISO) An international body that provides standards for
financial transactions and telecommunication
messages.
Mastercard Test Facility (MTF) A production-like test environment for use by all
customers for online testing.
POST A method is used to send data to a server using
APIs. An HTTP method for sending data to a server
using APIs.
Production Bulk File R119: MTF-GCMS Inbound Data.
REST Representational State Transfer. A type of web
service architecture for connecting disparate
computing systems.
TAN Testing Acknowledgment Notification.
Term Definition
Transaction APIs (TAPI) Transaction Application Programming Interfaces.
Procedure
1. Go to Mastercard Developers.
Figure 3: Mastercard Developers home page
Related documentation....................................................................................................................................... 32
Related documentation
Refer to the Technical Resource Center (TRC) located on Mastercard Connect® for the following
documents:
• Authorization Manual
• Chargeback Guide
• Customer Interface Specification
• Dual Message System Release Documents
• GCMS Parameter Table Layouts
• Global Clearing Management System Reference Manual
• IPM Clearing Formats
• Mastercard Transaction Calculator Product Guide
• Mastercard Cloud Edge Product Guide
• Mastercard Co-Lo Edge Product Guide
• Mastercard Rules
• M-TIP Process Guide
• Real-Time Clearing Product Guide Global
• Transaction Processing Rules
• Pricing and Billing Resource Center on Mastercard Connect
Refer to Mastercard Developers for the additional Transaction APIs resources:
• Reference Application for an example to get you started
• Use Cases for additional details on how the Transaction APIs work
• Tutorials and Guides for additional guidance
Notices
Following are policies pertaining to proprietary rights, trademarks, translations, and details
about the availability of additional information online.
Proprietary Rights
The information contained in this document is proprietary and confidential to Mastercard
International Incorporated, one or more of its affiliated entities (collectively “Mastercard”), or
both.
This material may not be duplicated, published, or disclosed, in whole or in part, without the
prior written permission of Mastercard.
Trademarks
Trademark notices and symbols used in this document reflect the registration status of
Mastercard trademarks in the United States. Consult with the Global Customer Service team or
the Mastercard Law Department for the registration status of particular product, program, or
service names outside the United States.
All third-party product and service names are trademarks or registered trademarks of their
respective owners.
EMV® is a registered trademark of EMVCo LLC in the United States and other countries. For
more information, see http://www.emvco.com.
Disclaimer
Mastercard makes no representations or warranties of any kind, express or implied, with respect
to the contents of this document. Without limitation, Mastercard specifically disclaims all
representations and warranties with respect to this document and any intellectual property
rights subsisting therein or any part thereof, including but not limited to any and all implied
warranties of title, non-infringement, or suitability for any purpose (whether or not Mastercard
has been advised, has reason to know, or is otherwise in fact aware of any information) or
achievement of any particular result.
Translation
A translation of any Mastercard manual, bulletin, release, or other Mastercard document into a
language other than English is intended solely as a convenience to Mastercard customers.
Mastercard provides any translated document to its customers “AS IS” and makes no
representations or warranties of any kind with respect to the translated document, including,
but not limited to, its accuracy or reliability. In no event shall Mastercard be liable for any
damages resulting from reliance on any translated document. The English version of any
Mastercard document will take precedence over any translated version in any legal proceeding.