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

The Agreement API from Mastercard — 4 operation(s) for agreement.

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

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

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

4 operations 4 paths 25 schemas 4 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
Resource Areas
1

Paths & Operations 4

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

Agreement 4
POST
/agreements/{agreement_id}/updates
Mastercard Update Agreement.
updateAgreement 5 params body → 200400401
POST
/agreements/{agreement_id}/status-retrievals
Mastercard Agreement Request Status Retrieval Request.
retrieveAgreementStatus 6 params body → 200400401
POST
/agreement-retrievals
Mastercard Retrieve Agreement Details
retrieveAgreement 4 params body → 200400401
POST
/agreement-searches
Mastercard Retrieve Agreement List
retrieveAgreementList 4 params body → 200400401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are CreditorAckForAgmtRetrieval (6 properties), Error (5 properties), MessageRequestBlock (4 properties), MessageResponseBlock (4 properties). Each schema is shown below with its type and property counts.

NewAgreementDetailRetrieval
NewAgreementUpdate
Creditor
object
2 properties 2 required
AgreementRequestStatusRetrievalAck
AgreementList
array
An object that has a list of active agreements and details about each agreement that belongs to the Debtor.
AgreementForAgmtUpdate
object
2 properties 2 required
AgreementListRetrieval
AgreementDetailRetrieval
NewAgreementListRetrieval
MessageResponseBlock
object
4 properties 4 required
AgreementAckForAgmtRetrieval
object
3 properties 3 required
Debtor
object
2 properties 2 required
CreditorForSRR
object
2 properties 2 required
CreditorAckForAgmtRetrieval
object
6 properties 4 required
ErrorWrapper
object
A top level object for errors
1 property 1 required
AgreementAckUpdate
AgreementForAgmtRetrieval
object
2 properties
AgreementListItems
object
2 properties 2 required
Errors
object
Object that contains the list of errors
1 property 1 required
CreditorAcknowledgement
object
3 properties 2 required
ErrorList
array
The list of errors
MessageResponseBlock_2
object
4 properties 4 required
NewAgreementRequestStatusRetrieval
MessageRequestBlock
object
4 properties 4 required
Error
object
A single error
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-agreement-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 Agreement 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.