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

Mastercard Status API

The Status API from Mastercard — 6 operation(s) for status.

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

Tagged areas include Status. 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 6 operations across 6 paths, and defines 44 schemas. It is described by OpenAPI 2.0, at version 1.0.

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

6 operations 6 paths 44 schemas 1 GET4 POST1 PUT

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
Resource Areas
1

Paths & Operations 6

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

Status 6
POST
/payment-requests/{payment_request_lifecycle_id}/status-retrievals
Mastercard Payment Request Status Retrieval Request.
retrievePaymentRequestStatus 6 params body → 200400401
POST
/agreements/{agreement_id}/status-retrievals
Mastercard Agreement Request Status Retrieval Request.
retrieveAgreementStatus 6 params body → 200400401
GET
/srci/{src-client-id}/dpas/batch/status/{batch-id}
Mastercard Get Status of the Dpa Add/update Async (batch) Job by Batch Id.
getDpaBatchStatus 3 params → 200400401403404500
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
PUT
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/status-changes
Mastercard Change Sub-merchant Status.
updateAlertsSubMerchantStatus 5 params body → 200400401403404422default
POST
/vendors/{vendor_id}/orders/status
API used by external Vendors to provide the orders status
updateOrderStatus 1 param body → 200400401

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are AlertsSubMerchantResource (9 properties), OrderItemStatus (7 properties), BatchStatusItems (7 properties), DpaBatchStatus (7 properties). Each schema is shown below with its type and property counts.

Error_2
object
An error object is associated with individual DPA failures in a given batch (assuming a COMPLETEDWITHERRORS response). Please note: In the event of a SUCCESSFU…
4 properties 3 required
User
string
Username for the user creating or modifying a resource
AlertsSubMerchantResource
object
Response containing a specific sub-merchant with details
9 properties
MerchantStatus
string
Merchant Status must be one of - ACTIVATED, DEACTIVATED
ErrorList
array
The list of errors
LastName
string
The individual's last name
DpaResults
object
Object for individual Digital Payment Application (DPA) item status data.
4 properties
AgreementRequestStatusRetrievalAck
NewRefundRequestStatusRetrieval
ErrorResponse
object
Error Response object
1 property 1 required
Errors
object
Object that contains the list of errors
1 property 1 required
DebtorForSRR
object
2 properties 2 required
MessageRequestBlock
object
4 properties 4 required
BatchStatusItems
object
7 properties
CreatedOrModifiedBy
object
Timestamp and user responsible for creation or modification of the resource
2 properties
ErrorDetail
object
Error associated with a failed Digital Payment Application (DPA) item action.
4 properties 1 required
UserId
string
The user id of the submitter/technical contact.
AlertsMerchantMemberId
string
Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants
AlertsSubMerchantStatusUpdate
object
Request used to update sub-merchant status
1 property 1 required
FirstName
string
The individual's first name
CreditorForSRR
object
2 properties 2 required
MerchantCategoryCode
string
A four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
PaymentRequestStatusRetrievalAck
Errors_3
object
Errors object
1 property 1 required
MerchantType
string
Merchant Type must be one of - PARTNER, ACQUIRER, SUBMERCHANT
DpaBatchStatus
object
The DpaBatchStatus response contains information related to the status of a submitted Digital Payment Application (DPA) batch.
7 properties
NewPaymentRequestStatusRetrieval
Timestamp
string
Timestamp of the creation or modification of the resource
NewAgreementRequestStatusRetrieval
MerchantName
string
Merchant's partial or full name.
Error_4
object
Error object
5 properties
RefundRequestStatusRetrievalAck
MessageResponseBlock
object
4 properties 4 required
ErrorWrapper
object
A top level object for errors
1 property 1 required
MessageResponseBlock_2
object
4 properties 4 required
Error
object
A single error
5 properties
OrderItemStatus
object
7 properties
Errors_2
object
1 property 1 required
History
object
4 properties
ErrorItem
object
Error Details
5 properties
ErrorsWrapper
object
1 property 1 required
OrderStatus
object
4 properties
OrderItemError
object
3 properties
OrderStatusArray
array
order status array list

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-status-api-openapi.yml Raw ↑

Other APIs Mastercard publishes across the network.

Mastercard Universal Specification Submission API
Mastercard Account to Account Commerce for Creditor Service Providers
Mastercard Debtor Service Provider Resources API
Mastercard Automatic Billing Updater API
Mastercard Benefit Eligibility Service API
Mastercard Bill Pay API
Mastercard Bill Payment Validator
Mastercard BIN Lookup API
Mastercard Business Payment Controls
Mastercard Carbon Calculator API
Mastercard Carbon Calculator Experience API
Mastercard Checkout Solutions
Where this information came from

This is an independent, third-party profile of Mastercard Status 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.