Mastercard Cards API
The Cards API from Mastercard — 7 operation(s) for cards.
Mastercard Cards API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Cards. 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 10 operations across 7 paths, and defines 130 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.example.com.
10 operations
7 paths
130 schemas
1 DELETE3 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 10
Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Cards 10
POST
/prepaid-cards
Mastercard prepaid Card Issuance - Issue Prepaid Card to Existing or New Client
POST
/debit-cards
Mastercard debit Card Issuance - Issue Debit Card to Existing or New Client
GET
/donors/{donor_id}/cards
Get All Cards API
POST
/donors/{donor_id}/cards
Add Card API
POST
/donors/{donor_id}/cards/searches
Search Card API
GET
/donors/{donor_id}/cards/{card_id}
Retrieve Card API
PUT
/donors/{donor_id}/cards/{card_id}
Update Card API
DELETE
/donors/{donor_id}/cards/{card_id}
Delete Card API
GET
/donations/non-ma/setup/cards
Get All Non Mastercard Brand Cards API
POST
/source-verifications/{issuing_country}/medicare-cards
Verifies the details of a medicare card document with an identity verification provider
Schemas 130
The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are MedicareCardSourceVerificationRequestAttributes (11 properties), Occupation (11 properties), BasePerson (10 properties), DonateCardRetrieve (10 properties). Each schema is shown below with its type and property counts.
CbsCustomer
object
1 property
MaritalStatus
string
Indicates Marital Status of the client. Conditional Mandatory field - Required while creating new client. Valid values are configured on 'Card Management Insti…
DeliveryMode
string
Client's preferred delivery mode. Application request with instant card true, delivery mode should be Branch. Valid values are configured on "Card Management I…
CustomField
object
2 properties
NewCardDetails
object
1 property
PermanentAddress
object
1 property
LegalDocument
object
Legal document that is required for KYC.
4 properties
Language
string
Language preference. Language tags should be in the 'Language-Region' format as described by Internet Engineering 'Task Force (IETF) BCP 47' standard. Conditio…
DebitCardDetails
object
9 properties
1 required
DebitClient
object
4 properties
DebitCardProfile
object
4 properties
InitialLoad
object
2 properties
PhoneNumber1
string
Single or Multiple or Range of contact numbers. for example, 9120556677/88/98. This field is required if configured as Business Mandatory .
EducationQualification
string
Educational Qualification. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Parameter S…
ConditionalPrimaryClientCode
string
Unique code of the existing primary client. Conditional Mandatory field - Primary clientCode or cardNumber or cardId must be present in the request while reque…
ErrorsInfo
object
1 property
1 required
CardStatus
string
The current status of the card. Valid values: NORMAL - Indicates normal card SUPERVISION - Indicates supervision card CANCELLED - Indicates cancelled card REPL…
EmployerType
string
Type of employer. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Parameter Setup Syst…
PhoneNumber2
string
Single or Multiple or Range of contact numbers. for example, 8120556678/68/58. This field is required if configured as Business Mandatory .
RequestValidityTime
object
Validity of the API request. It protects the API from unauthorized request or man-in-the-middle (MITM) attacks For example, if the validity of the API request…
1 property
1 required
NewApplication
object
2 properties
1 required
OccupationType
string
Occupation type of the employee. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Param…
ClientSearchInfo
object
2 properties
BaseCard
object
Base Card information
3 properties
ConditionalProgramCode
string
Program code of a card. Conditional Mandatory field - Required while requesting for PRIMARY card.
CurrentAddress
object
1 property
BaseSearchCard
object
Base Search Card
6 properties
Client
object
5 properties
ReuterReferenceNumber
string
Reuter reference number value. This field is required if configured as Business Mandatory .
DebitApplication
object
Contains information about different types of debit cards
1 property
1 required
ClientType
string
Indicates client type Conditional Mandatory field - Required while creating new client. Valid values are configured on 'Card Management Institution Parameter S…
PrepaidCardProfile
object
5 properties
OnboardingApplicationType
string
Application type indicates the type of card being requested. Valid values: PRIMARY - Issue Primary Card ADDON - Issue Add-On Card SUPPLEMENTARY - Issue Supplem…
LVCCard
object
LVC Card information
4 properties
AddOnClient
object
2 properties
CardRelationship
string
An indicator at card level to describe type of client associated with the card. Valid values: PRIMARY - Indicates primary card ADDON - Indicates add-on card SU…
CobrandNumber
string
Co-brand Number Value. It is also known as Partner Membership Number. This field is required if configured as Business Mandatory .
ConditionalCardNumber
string
Unique number (PAN) assigned to the existing card. Conditional Mandatory field - Primary clientCode or cardNumber or cardId must be present in the request whil…
Title
string
The title or salutation that is added before the name of client. Conditional Mandatory field - Required while creating new client. The valid values are configu…
CurrentContact
object
2 properties
ConditionalPictureCode
string
Picture Code. Conditional Mandatory field - Required while applying 'Picture Card' card for new primary client, if not configured at device plan level.
ProgramCode
string
Program code of a card
AccountPromoPlanCodes
object
1 property
ConditionalCardId
string
Unique value to identify a card. Conditional Mandatory field - Primary clientCode or cardNumber or cardId must be present in the request while requesting card…
CardExpiry
string
Expiry date of the card in "MM/YY" format. This field is not applicable for LVC cards. The 'expiry' and 'expiry Date Time' fields are mutually exclusive, which…
Mobile
object
Mobile number details
2 properties
LegalDocumentType
string
Legal Document Type Conditional Mandatory field - Required when type is configured in document checklist plan associated with program. Valid values are configu…
Errors
object
1 property
1 required
RiskCategory
string
Client's risk category. This field is required if configured as Business Mandatory . Valid values: NONE - Insignificant or no risk LOW - Low risk MODERATE - Mo…
ClientCode
string
Unique code of the client
Address
object
8 properties
ErrorMessage
object
5 properties
4 required
PrimaryCard
object
3 properties
Contact
object
2 properties
PhotoIndicator
string
Indicates whether picture or photo should be printed on the card or default template to be applied. In case of LVC card request, valid value is only NORMAL. Va…
CardAlias
string
Alias assigned to each card. This attribute is available only if the CNA (Card number alias) functionality is enabled for the institution.
CardPromoPlanCode
string
Promo plan assigned to the card. If provided, the value must be present in card promotion plan configuration.
NewCard
object
8 properties
2 required
ProfessionType
string
Profession Type. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Parameter Setup Syste…
LodgingMode
string
Lodging Mode. Valid values are configured on 'Card Management Institution Parameter Setup System Codes [ISSS15]' screen for 'Type Id=RESIDENCESTATUS'. Few samp…
BaseCardWithSecrets
object
Card information
3 properties
Profile
object
Set of Personally Identifiable Information (PII) associated with a given client.
8 properties
Designation
string
Designation of the employee. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Parameter…
CbsAccount
object
Core Banking System Account Info. Applicable for Debit Cards only
4 properties
LvcExpiryDateTime
string
Applicable only for 'LVC' card. The date/time after which the 'LVC' card should be considered as expired or invalid. The 'expiry' and 'expiry Date Time' fields…
CardPlanCode
string
Plan assigned to the card. If provided, the value must be part of the selected program code and included in the card or account plan configuration in CSR porta…
TravelDetails
object
Travel Information, Applicable only if the client has a prepaid card.
4 properties
CardPackId
string
Card pack id is the unique id assigned to the physical packet that contains the card for delivery to the client or branch. Usually paired cards are delivered i…
CustomFields
array
Custom fields array (not recommended to be used)
ConditionalAddonClientCode
string
Unique code of the existing add-on client. Conditional Mandatory field - Add-on clientCode and relation fields are mutually exclusive.
Relation
string
It is the relation of the add-on client with the primary client. Conditional Mandatory field - Add-on 'client code' and relation fields are mutually exclusive…
EmbossedName
string
Embossed name of the client. Conditional Mandatory field - Required while creating new client.
Gender
string
Indicates Gender of the client. Conditional Mandatory field - Required while creating new client. Valid values are configured on 'Card Management Institution P…
SourceSystemClientMapping
object
Client information mapping with source system identifiers
3 properties
CardNumber
string
Unique number (PAN) assigned to the card. This number might be masked based on the API masking configuration settings of the institution in the MI Issuing cust…
AlternateName
string
Alternate name of the client.
ClientPreferences
object
6 properties
BasicProfile
object
Set of Personally Identifiable Information (PII) associated with a given client.
6 properties
BaseNewCardDetails
object
8 properties
1 required
CbsAccountType
string
Bank ISO Account Type in CBS. Conditional Mandatory field - Required while linking new debit account. Possible values configured in CSR portal on "Card Managem…
PhoneExtension
string
Extension Number
BaseAccount
object
3 properties
OfficeContact
object
3 properties
CardId
string
Unique value to identify a card
CardType
string
The type indicates the card category. Valid values: EMVCARD MAGNETICSTRIPECARD STATICVIRTUALCARD LIMITEDVALIDITYVIRTUALCARD NFCPAYPASS NFCEMVPAYPASS NFCMAGSTRI…
Application
object
4 properties
1 required
PrepaidCardApplication
object
2 properties
Cvv
string
Card verification value (CVV), card security code (CSC), card verification code (CVC), or card code verification (CCV) found on the back of a card that provide…
LegalDocuments
array
Set of legal documents associated with a given client that are required for KYC.
RegisteredContacts
object
3 properties
Person
object
2 properties
StatementDeliveryOption
string
Statement delivery options. Conditional Mandatory field - Required while creating new client. Valid values are configured on 'Card Management Institution Param…
ConditionalCardAlias
string
Alias to be assigned to the newly issued card. Conditional Mandatory field - Required if the CNA functionality is turned on for the institution. OR This field…
EncodedName
string
Applicable only for Physical Card. Encoded name of the client. The value can contain space. For example, John Smith. This field is required if configured as Bu…
FreshCard
object
7 properties
1 required
BasePerson
object
10 properties
MailingAddress
string
Client's preferred mailing address. Conditional Mandatory field - Required while creating new client. Valid values: CURRENT, PERMANENT, OFFICE
Kyc
object
3 properties
Email
string
Email address. This field is required if configured as Business Mandatory .
AccountNumber
string
Account number linked to the card.
EmploymentStatus
string
Status of Employment. This field is required if configured as Business Mandatory . Valid values are configured on 'Card Management Institution Parameter Setup…
Occupation
object
11 properties
ConditionalPhotoCode
string
Photo Code of client. Conditional Mandatory field - Required while applying 'Photo Card' card.
FreshDebitCard
object
Debit Card Details. card number or card id or card packId must exist while issuing existing non personalized card.
4 properties
NewClient
object
1 property
UpdateCard
object
6 properties
4 required
Error-InternalServerError
object
1 property
1 required
SearchCard
object
1 property
1 required
DonateGetAllCards
object
1 property
CardItems
object
2 properties
DonateCardUpdate
object
2 properties
Error-401
object
1 property
1 required
Error-403
object
1 property
1 required
cardExpiry
object
2 properties
AddCard
object
6 properties
4 required
DonateCard
object
2 properties
Error-AddCard
object
1 property
1 required
Error-InvalidProgramId
object
1 property
1 required
RetrieveNonMABrandCards
object
2 properties
Error-404
object
1 property
1 required
CardBillingAddress
object
7 properties
DonateCardRetrieve
object
10 properties
Error-500
object
1 property
1 required
Error
object
1 property
1 required
MedicareCardSourceVerificationRequestAttributes
object
11 properties
7 required
MedicareCardSourceVerificationResult
object
1 property
1 required
ApiError
object
1 property
1 required
Errors_2
object
List of Errors.
1 property
1 required
ErrorList
array
Error Details.
Error_2
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mastercard 12
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
#Cards
Where this information came from
This is an independent, third-party profile of Mastercard Cards 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.