Mastercard Card API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Card. 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
28 operations
across 14 paths,
and defines 85 schemas.
It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.example.com.
The identity and technical contract details declared by the specification.
TransactionId
string
A unique ID associated with a payment transaction, For example, original payment transaction ID. The same ID will be returned in the response corresponding to…
X-MC-Correlation-ID
string
PaymentCard
object
The request object for registering a new Payment Card. This object will be encrypted before sending it to the server.
2 properties
2 required
PaymentCardEnrolment
object
The response object which contains Payment Card information.
5 properties
TransactionMetadata
object
Metadata about a transaction.
14 properties
10 required
PaymentCardId
string
Unique ID provided in the response while registering a payment card.
ErrorWrapper
object
The error response object gets returned in case of any error.
1 property
1 required
HistoricalTransactionFootprint
object
A single transaction footprint along with transaction info for a corresponding payment transaction.
2 properties
2 required
TransactionFootprint
object
A single transaction footprint calculated for a corresponding payment transaction.
2 required
Category
object
User understandable information about an MCC categorization.
4 properties
HistoricalTransactionFootprints
object
Response object which holds all the transaction footprints for historical transactions.
5 properties
CarbonUsage
object
Object to hold carbon usage data.
2 properties
Errors
object
Error object which returns a list of Error objects.
1 property
1 required
PaymentCardEnrolments
array
List of payment card enrolments corresponding to each of the payment cards. This information should be used to identify the success and failure enrolments and…
CurrencyCode
string
Currency code as per ISO 4217
Error
object
Error object which contains details about the error.
5 properties
4 required
AlertsCardAcceptorNameConfig
object
Card acceptor name configuration
5 properties
1 required
AcquirerReferenceId
string
The acquirer BINs that a partner currently services under their portfolio. This is represented by Mastercard DE 31 - Subfield 2 (Clearing), DE 32 (Authorizatio…
ResourceId
string
Unique identifier of resource
CardAcceptor
string
Merchant Card Acceptor
CardAcceptorDataResource
object
4 properties
4 required
CardAcceptorData
object
2 properties
2 required
PageableCardAcceptorNamesResource
object
Pageable card acceptor names resource with pagination metadata
2 properties
CardAcceptorRegion
string
A sub-element of the merchant descriptor indicating either the state, province, or region of the merchant as it appears on the cardholder's statement. Value is…
AlertsCardAcceptorIdConfig
object
Map of acquirer reference id and the corresponding card acceptor id
3 properties
2 required
LastName
string
The individual's last name
ResponseTime
string
Total response time in ms
AlertsMerchantConfigId
string
Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants configuration
ErrorResponse
object
Error Response object
1 property
1 required
Etag
string
Etag is a response header which is an identifier for a specific version of a resource.
AlertsMerchantIdentifierConfigIdOnly
object
Merchant identifier configuration Id (referring to card acceptor id or name configuration)
1 property
MerchantGuid
string
Consumer Clarity internal merchant's GUID
BulkOperationResource
object
Resource with responseCode and details
3 properties
1 required
Errors_2
object
Errors object
1 property
1 required
CardAcceptorCountry
string
A sub-element of the merchant descriptor indicating the country of the merchant as it appears on the cardholder's statement. Value is not case-sensitive and ca…
UserId
string
The user id of the submitter/technical contact.
AlertsMerchantMemberId
string
Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants
CardAcceptorName
string
A sub-element of the merchant descriptor that contains the merchant's name or doing business as name as it appears on the cardholder's billing statement.
FirstName
string
The individual's first name
AlertsCardAcceptorNameConfigs
object
Card acceptor name configurations for a merchant
2 properties
CardAcceptorCity
string
A sub-element of the merchant descriptor indicating the merchant city/location as it appears on the cardholder's billing statement.
CardAcceptorNamesBulkResource
object
Set of Card Acceptor Names resource
1 property
CardAcceptorId
string
Identifies the card acceptor ID assigned by the acquirer. This ID must represent a unique identifier for each merchant name/location within the acquirer BIN. T…
ResponseHeader
object
4 properties
AlertsCardAcceptorIdConfigs
object
Card acceptor id configurations for a merchant
2 properties
CardAcceptorNamesBulk
object
1 property
1 required
Error_2
object
Error object
5 properties
UpdateCard
object
6 properties
4 required
DonateCardUpdate
object
2 properties
Error-401
object
1 property
1 required
Error-403
object
1 property
1 required
cardExpiry
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_3
object
1 property
1 required
VelocityControl
object
The VelocityControl can limit the frequency, and the total cumulative amount of authorizations performed on the cardholders account within a specified time per…
8 properties
2 required
CurfewControl
object
Curfew Control
5 properties
4 required
Token
object
4 properties
TransactionLimitControl
object
The TransactionLimit control provides the ability to limit individual transaction authorizations to a maximum amount
2 properties
2 required
VirtualCardAccount
object
2 required
UpdateVirtualCardAccount
object
1 required
MerchantIdControl
object
The Merchant ID control provides the ability to limit authorizations to particular merchants
3 properties
3 required
ResourceIdentifier
string
A UUID which uniquely identifies a resource
ValidityPeriodControl
object
The ValidityPeriod control provides the ability to limit authorization activity to a defined time period
4 properties
3 required
MccControl
object
The Card Acceptor Business Codes (MCC) control can control the type of purchases for which a card is used
2 properties
2 required
Controls
array
In Control Card Controls
Card
object
2 properties
2 required
ErrorWrapper_2
object
1 property
1 required
AgeingVelocityControl
object
The AgingVelocityControl provides the requester with the ability to set a notional credit line through the CumulativeControl. This control keeps track of the c…
7 properties
4 required
AmountRangeControl
object
The exact amount range control will approve a transaction only if the requested amount is equal or greater than MinAmount and less than or equal to MaxAmount.…
6 properties
4 required
VcnUserDetail
object
3 properties
3 required
UpdateVCN
object
2 properties
TokenUpdate
object
1 property
TimeOfDayControl
object
The TimeOfDayControl provides the ability to limit authorization activity to defined time periods for each day
3 properties
3 required
Errors_3
object
1 property
1 required
Control
object
In Control Rule
12 properties
2 required
GeographyControl
object
The GeographicControl provides the ability to control where a card is physically used
2 properties
2 required
TimeOfDay
object
3 properties
3 required
Error_4
object
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mastercard publishes across the network.