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

The Plan API from Mastercard — 2 operation(s) for plan.

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

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

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

2 operations 2 paths 20 schemas 2 GET

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 2

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

Plan 2
GET
/plans/{plan_id}
Retrieves Buy Now, Pay Later installment plan.
getPlan 1 param → 200400401403404405
GET
/approvals/{plan_id}
Get the status of checkout and callback URL to PSP (Payment service provider).
getPlanApprovalStatus 1 param → 200401403404406

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are InstallmentPlan (12 properties), PlanInstallmentInformation (8 properties), Error (5 properties), MerchantPlan (4 properties). Each schema is shown below with its type and property counts.

TransactionOffers
array
A list of offers presented to the consumer. This is a mandatory field for During Purchase use case of Mastercard Installments Payment Services.
MerchantPlan
object
4 properties 2 required
StatusField
string
Current status of a plan. One of: CREATED, APPROVED, DECLINED, TIMEDOUT.
PlanIdField
string
A unique identifier assigned to an installment plan.
InstallmentPlan
object
12 properties 5 required
ScheduledRepayments
array
This object will be populated only when consumer offer selection is enabled.
PSPData
object
1 property
ErrorWrapper
object
The error response object which gets returned in case of any error.
1 property 1 required
CompletionPSPData
PlanInstallmentInformation
object
This object is mandatory for Mastercard Installments Payment Services.
8 properties 2 required
Amount
number
Amount to be paid in an installment.
Errors
object
Error object which returns the list of Error objects.
1 property 1 required
Transaction
object
2 properties 2 required
ProviderIdField
string
Provider ID is internal ID generated by Configuration API.
ErrorList
array
ScheduledRepayment
object
3 properties
Consumer
object
4 properties
OfferIdField
string
Unique identifier for installment offers. This is mandatory for 'Mastercard Installments Payment Services product.
TransactionOffer
object
1 property 1 required
Error
object
Error object which contains details about the Error.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-plan-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 Plan 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.