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 Retrievals API

The Retrievals API from Mastercard — 4 operation(s) for retrievals.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

5 operations 4 paths 38 schemas 4 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
Contact
Bill Pay Development Support
Resource Areas
1

Paths & Operations 5

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

Retrievals 5
POST
/document-verifications/document-data-retrievals
Retrieve the details of a document.
retrieveDocumentData 1 param body → 200400403404
PUT
/document-verifications/document-data-retrievals
Add and Validate a Document - Retrieve the details of an additional document.
retrieveMultiDocumentData 2 params body → 200400403404
POST
/payment-request-retrievals
Mastercard Retrieve Payment Request Details.
retrievePaymentRequest 4 params body → 200400401
POST
/agreement-retrievals
Mastercard Retrieve Agreement Details
retrieveAgreement 4 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 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are TransactionAcknowledgement (14 properties), DocumentDataRetrieval (12 properties), AuditEventsItem (12 properties), BaseEvidenceData (9 properties). Each schema is shown below with its type and property counts.

TpAuditMetadata
object
Object containing metadata related to the request.
2 properties 2 required
Locale
string
IETF BCP 47 code which identifies the language to be used in any dialogs being shown to the user during the flow. The default value is "en-US".
AddressData
object
6 properties
DocumentDataStatus
Object containing the details of the document whose accuracy has been confirmed by the user.
10 required
BaseEvidenceData
object
9 properties
PDS
string
Encrypted Personal Device Storage (PDS) which hosts the users identity attributes. The PDS can be retrieved from the MIDS Core SDK, please refer to the SDK gui…
DocumentData
Object containing the details of the document whose accuracy has been confirmed by the user.
10 required
ErrorResponse
object
The error response model used by all the API endpoints.
1 property 1 required
AuditEventsItem
object
12 properties
SdkVersion
string
Mastercard SDK version integrated with TP App, it is a constant extracted from MIDS SDK Configurations (generated while bundling SDK artifacts). If the TP app…
DocumentDataRetrieval
object
12 properties 7 required
UserConsent
string
Confirmation provided by the TP that the user has consented that the ID-Network can have access to their identity for the purposes of the API call. Should be A…
MultiDocumentDataRetrieval
6 required
DocumentVerificationExtractedData
object
3 properties 2 required
ARID
string
A unique identifier for any activity being executed arising out of a Claim Share request. This value is passed as a parameter in the URL redirecting a User to…
CountryCode
string
The country code of the country where the transaction originates from.
NewAgreementDetailRetrieval
NewRefundRequestStatusRetrieval
CreditorAckForPaymentRetrieval
object
8 properties 4 required
RefundRequestStatusRetrievalAck
NewPaymentRequestDetailRetrieval
AgreementDetailRetrieval
DebtorAckForPaymentRetrieval
object
2 properties 2 required
MessageResponseBlock
object
4 properties 4 required
TransactionAcknowledgement
object
14 properties 9 required
AgreementAckForAgmtRetrieval
object
3 properties 3 required
Debtor
object
2 properties 2 required
CreditorAckForAgmtRetrieval
object
6 properties 4 required
ErrorWrapper
object
A top level object for errors.
1 property 1 required
Amount
object
2 properties 2 required
AgreementForAgmtRetrieval
object
2 properties
PaymentRequestDetailRetrieval
Errors
object
Object that contains the list of errors.
1 property 1 required
DebtorForSRR
object
2 properties 2 required
ErrorList
array
The list of errors.
MessageRequestBlock
object
4 properties 4 required
TransactionForPaymentRetrieval
object
5 properties 3 required
Error
object
A single error.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-retrievals-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
#Retrievals
← Back to M APIs
API Details
ID
mastercard:mastercard-retrievals-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-retrievals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mastercard-retrievals-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 Retrievals 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.