How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mastercard

Mastercard Payments API

The Payments API from Mastercard — 17 operation(s) for payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Mastercard Payments API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, a changelog, a support channel, and a getting-started guide.

This API exposes 17 operations across 17 paths, and defines 91 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.example.com.

17 operations 17 paths 91 schemas 1 DELETE1 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.example.com
Contact
Bill Pay Development Support
Resource Areas
1

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 1 DELETE, 1 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 17
POST
/service-providers/payment-cards
Bulk Registration of Payment Cards
BulkRegisterPaymentCards body → 200400404
DELETE
/service-providers/payment-cards/{payment_card_id}
Delete a Payment Card
PaymentCardDeletion 1 param → 202400404
GET
/payment-cards/{payment_card_id}/transaction-footprints
Fetches Historical Transactions and its Transaction Footprints
GetPaymentCardTransactionHistory 5 params → 200400404
POST
/payment-cards/transaction-footprints/aggregates
Fetches carbon score for payment cards and aggregates the same on a weekly and monthly basis. The result will be in descending order.
GetPaymentCardAggregateTransactions body → 200400404415
POST
/payment-cards
Register a Payment Card (to be deprecated)
RegisterPaymentCard body → 200400404415
POST
/payment-card-enrolments
Batch Registration of Payment Cards (to be deprecated)
BatchRegisterPaymentCards body → 200400404415
POST
/payment-card-deletions
Delete one or more Payment Cards (to be deprecated)
PaymentCardDeletions body → 202400404415
POST
/payments/guests
Guest Donation
guestDonationUsingPOST 3 params body → 200201400401403404415500
POST
/payments
One Time Donation API
oneTimePaymentUsingPOST 3 params body → 200201400401403404415500
POST
/payment-requests
Mastercard Payment Request Creation.
createPaymentRequest 5 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/status-retrievals
Mastercard Payment Request Status Retrieval Request.
retrievePaymentRequestStatus 6 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/refunds
Mastercard Refund Account Request.
retrieveRefundAccount 6 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/refunds/{refund_request_lifecycle_id}/payment-confirmations
Mastercard Refund Payment Confirmation.
confirmRefundPayment 7 params body → 200400401
POST
/payment-request-retrievals
Mastercard Retrieve Payment Request Details.
retrievePaymentRequest 4 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/payment-confirmation-advices
Mastercard Confirm Payment
confirmPaymentAdvice 6 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/step-up-advices
Mastercard Step-up Advice
createStepUpAdvice 5 params body → 200400401
POST
/payment-requests/{payment_request_lifecycle_id}/refunds/{refund_request_lifecycle_id}/status-retrievals
Mastercard Refund Request Status Retrieval Request
retrieveRefundStatus 7 params body → 200400401

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are TransactionAcknowledgement (14 properties), TransactionMetadata (14 properties), TransactionForPAL (10 properties), CreditorAckForPaymentRetrieval (8 properties). Each schema is shown below with its type and property counts.

TransactionId
string
A unique ID associated with a payment transaction, For example, original payment transaction ID. The same ID will be returned in the response corresponding to…
X-MC-Correlation-ID
string
AggregateSearchCriteria
object
Request object which holds the criteria (that is, list of payment card IDs and aggregate type) for retrieving aggregate transactions.
5 properties 2 required
PaymentCard
object
The request object for registering a new Payment Card. This object will be encrypted before sending it to the server.
2 properties 2 required
TransactionMetadata
object
Metadata about a transaction.
14 properties 10 required
PaymentCardEnrolment
object
The response object which contains Payment Card information.
5 properties
PaymentCardId
string
Unique ID provided in the response while registering a payment card.
PaymentCardReference
object
Reference information for a Payment Card generated after a successful registration. This information should be used to perform the further operation for that c…
4 properties 4 required
ErrorWrapper
object
The error response object gets returned in case of any error.
1 property 1 required
HistoricalTransactionFootprint
object
A single transaction footprint along with transaction info for a corresponding payment transaction.
2 properties 2 required
TransactionFootprint
object
A single transaction footprint calculated for a corresponding payment transaction.
2 required
Category
object
User understandable information about an MCC categorization.
4 properties
HistoricalTransactionFootprints
object
Response object which holds all the transaction footprints for historical transactions.
5 properties
CarbonUsage
object
Object to hold carbon usage data.
2 properties
AggregateTransactionFootprints
object
List of AggregateTransactionFootprint.
2 properties 1 required
Errors
object
Error object which returns a list of Error objects.
1 property 1 required
AggregateTransactionFootprint
object
Aggregate transaction footprint for a single payment card ID.
2 properties 2 required
ErrorList
array
CrossPANAggregation
object
Cross PAN aggregated carbon footprint for given aggregate type.
1 property
Day
string
PaymentCardEnrolments
array
List of payment card enrolments corresponding to each of the payment cards. This information should be used to identify the success and failure enrolments and…
FootprintAggregation
object
Aggregation of carbon score for a payment card ID and given aggregation level.
CurrencyCode
string
Currency code as per ISO 4217
Error
object
Error object which contains details about the error.
5 properties 4 required
CardCvcGuest
object
3 properties
Error-415
object
1 property 1 required
3ds2
object
Required If authPayerResponse object is passed, only for MPGS.
2 properties 1 required
User
object
3 properties 2 required
Error-401
object
1 property 1 required
Authentication
object
2 properties
Error-403
object
1 property 1 required
Error-201
object
1 property 1 required
OneTimePaymentSuccess
object
3 properties
GuestDonate
object
5 properties 3 required
AuthPayerResponse
object
1 property
cardExpiry
object
2 properties
Donation
object
3 properties 3 required
GuestDonation
object
3 properties
CardCVC
object
Cvc is a unique number.NOTE In case of card not added already then primaryAccountNumber and cardExpiry are required and cardCvc is conditional, optional for St…
3 properties
Error-404
object
1 property 1 required
3ds
object
Required If authPayerResponse object is passed.
4 properties 3 required
Error-500
object
1 property 1 required
RealTimePayment
object
7 properties 2 required
SessionDetails
object
1 property
Error_2
object
1 property 1 required
CreditorAckForPaymentRetrieval
object
8 properties 4 required
NewPaymentRequestDetailRetrieval
Status
object
2 properties 1 required
Refund
object
6 properties 4 required
ErrorList_2
array
The list of errors
CreditorForPAL
object
5 properties 2 required
TransactionForPaymentRetrieval
object
5 properties 3 required
NewRefundRequestStatusRetrieval
NewPaymentRequest
PaymentConfirmationAdvice
AgreementStatus
object
2 properties 2 required
NewRefundAccount
PaymentRequest
RefundAccount
NewPaymentConfirmationAdvice
StepUpNotification
PaymentRequestDetailRetrieval
Errors_2
object
Object that contains the list of errors
1 property 1 required
RequestStatus
object
1 property 1 required
DebtorForSRR
object
2 properties 2 required
MessageRequestBlock
object
4 properties 4 required
TransactionForPAL
object
10 properties 7 required
Payment
object
4 properties 4 required
status
object
2 properties 1 required
NewStepUpNotification
TransactionAckForPAL
object
6 properties 3 required
CreditorForSRR
object
2 properties 2 required
RefundPaymentAdviseConfirmation
PaymentRequestStatusRetrievalAck
NewRefundPaymentConfirmation
NewPaymentRequestStatusRetrieval
TransactionForStepUpNotification
object
3 properties 2 required
CreditorForRefund
object
2 properties 2 required
RefundAcknowledgement
object
2 properties 2 required
RefundRequestStatusRetrievalAck
refundPayment
object
3 properties 3 required
DebtorAckForPaymentRetrieval
object
2 properties 2 required
MessageResponseBlock
object
4 properties 4 required
TransactionAcknowledgement
object
14 properties 9 required
Debtor
object
2 properties 2 required
AgreementConForPaymentAdvice
object
Agreement Confirmation from DSP
3 properties 1 required
ErrorWrapper_2
object
A top level object for errors
1 property 1 required
Amount
object
2 properties 2 required
MessageResponseBlock_2
object
4 properties 4 required
AgreementAcknowledgement
object
2 properties 2 required
Error_3
object
A single error
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-payments-api-openapi.yml Raw ↑

Other APIs Mastercard publishes across the network.

Mastercard Universal Specification Submission API
AE Profile APIs.io
Mastercard Account to Account Commerce for Creditor Service Providers
AE Profile APIs.io
Mastercard Debtor Service Provider Resources API
AE Profile APIs.io
Mastercard Automatic Billing Updater API
AE Profile APIs.io
Mastercard Benefit Eligibility Service API
AE Profile APIs.io
Mastercard Bill Pay API
AE Profile APIs.io
Mastercard Bill Payment Validator
AE Profile APIs.io
Mastercard BIN Lookup API
AE Profile APIs.io
Mastercard Business Payment Controls
AE Profile APIs.io
Mastercard Carbon Calculator API
AE Profile APIs.io
Mastercard Carbon Calculator Experience API
AE Profile APIs.io
Mastercard Checkout Solutions
AE Profile APIs.io
#Payments
← Back to M APIs
API Details
ID
mastercard:mastercard-payments-api
Base URL
https://api.example.com
Docs
https://developer.mastercard.com/product/account-services-catalogue/
Provider
Mastercard
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mastercard-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mastercard-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Mastercard Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.