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

The Merchants API from Mastercard — 22 operation(s) for merchants.

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

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

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

43 operations 22 paths 171 schemas 7 DELETE15 GET13 POST8 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
Resource Areas
1

Paths & Operations 43

Across 22 paths, the API surfaces 43 operations — 7 DELETE, 15 GET, 13 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Merchants 43
GET
/supported-merchant-categories
Provide Supported MCCs
GetSupportedMerchantCategories → 200
POST
/merchants/participations
Allows a registered partner to create or update merchant participation details
postMerchantParticipations body → 202400401403406
GET
/merchants/participations
Provides status of merchant participation updates
getMerchantParticipations 3 params → 200400401403404406
POST
/merchants/searches
Allows registered partners to search merchant participation information.
postMerchantSearches 2 params body → 200400401403406
POST
/merchants/mids/searches
Allows registered partners (Acquirers only) to search only specific merchant participation information.
postMerchantMidSearches 2 params body → 200400401403406
PUT
/merchants/{guid}/logos
Mastercard Update a Logo for an Existing Merchant.
updateMerchantLogoByGuid 4 params body → 200400404default
POST
/merchants/{guid}/logos
Mastercard Create a Logo for an Existing Merchant.
createMerchantLogo 4 params body → 200400404default
DELETE
/merchants/{guid}/logos
Mastercard Delete a Logo for an Existing Merchant.
deleteLogoByMerchantGuid 4 params → 204400404default
GET
/merchants/{guid}/logos
Mastercard Get the Logo for an Existing Merchant.
getLogoByMerchantGuid 4 params → 200400404default
POST
/sub-merchants
Mastercard Create a Sub-merchant.
createSubMerchant 3 params body → 200400404default
PUT
/sub-merchants/{guid}
Mastercard Update a Sub-merchant.
updateSubMerchant 5 params body → 200400404412428default
GET
/sub-merchants/{guid}
Mastercard Get Sub-merchant by Guid.
getSubMerchantByGuid 4 params → 200400404default
PUT
/sub-merchants/{guid}/states
Mastercard Activate/deactivate a Sub-merchant.
changeSubMerchantState 4 params body → 204400404default
POST
/sub-merchants/{guid}/locations
Mastercard Add a Unique Set of Sub-merchant's Locations
addLocations 4 params body → 200400default
GET
/sub-merchants/{guid}/locations
Mastercard Get Sub-merchant's Locations
getAllLocations 9 params → 200400404default
GET
/sub-merchants/{guid}/locations/{location_id}
Mastercard Get Location by Id
getLocationById 5 params → 200400404default
PUT
/sub-merchants/{guid}/locations/{location_id}
Mastercard Update an Existing Location
updateLocation 6 params body → 200400404default
DELETE
/sub-merchants/{guid}/locations/{location_id}
Mastercard Delete an Existing Location
deleteLocation 5 params → 204400404default
GET
/alerts/merchants/org-profiles
Mastercard Get Details of Organization Profiles.
getAlertsOrgProfiles 3 params → 200400401404default
POST
/alerts/merchants/{member_id}/acquirer-reference-ids
Mastercard Create Acquirer Reference Id Config.
createAlertsAcquirerReferenceIdConfig 4 params body → 200400401403404422default
PUT
/alerts/merchants/{member_id}/acquirer-reference-ids
Mastercard Update Acquirer Reference Id Config.
updateAlertsAcquirerReferenceIdConfig 5 params body → 200400401403404422default
GET
/alerts/merchants/{member_id}/acquirer-reference-ids
Mastercard Get Acquirer Reference Id Configs.
getAlertsAcquirerReferenceIdConfigs 8 params → 200400401403404default
DELETE
/alerts/merchants/{member_id}/acquirer-reference-ids
Mastercard Delete Acquirer Reference Id Config.
deleteAlertsAcquirerReferenceIdConfig 5 params → 200400401403404default
POST
/alerts/merchants/{member_id}/sub-merchants
Mastercard Create a Sub-merchant.
createAlertsSubMerchant 4 params body → 200400401403404422default
GET
/alerts/merchants/{member_id}/sub-merchants
Mastercard Get a List of Sub-merchants.
getAlertsSubMerchants 12 params → 200400401403404default
PUT
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}
Mastercard Update a Sub-merchant.
updateAlertsSubMerchantDetails 5 params body → 200400401403404422default
GET
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}
Mastercard Get a Sub-merchant.
getAlertsSubMerchantByGuid 5 params → 200400401403404default
PUT
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/status-changes
Mastercard Change Sub-merchant Status.
updateAlertsSubMerchantStatus 5 params body → 200400401403404422default
POST
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-ids
Mastercard Create Sub-merchant Card Acceptor Id Config.
createAlertsCardAcceptorIdConfig 5 params body → 200400401403404422default
GET
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-ids
Mastercard Get Sub-merchant Card Acceptor Id Configs.
getAlertsCardAcceptorIdConfigs 9 params → 200400401403404default
DELETE
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-ids
Mastercard Delete Sub-merchant Card Acceptor Id Config.
deleteAlertsCardAcceptorIdConfig 6 params → 200400401403404default
POST
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-names
Mastercard Create Sub-merchant Card Acceptor Name Config.
createAlertsCardAcceptorNameConfig 5 params body → 200400401403404422default
GET
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-names
Mastercard Get Sub-merchant Card Acceptor Name Configs.
getAlertsCardAcceptorNameConfigs 8 params → 200400401403404default
DELETE
/alerts/merchants/{member_id}/sub-merchants/{sub_merchant_id}/card-acceptor-names
Mastercard Delete Sub-merchant Card Acceptor Name Config.
deleteAlertsCardAcceptorNameConfig 6 params → 200400401403404default
POST
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names
Mastercard Add Card Acceptor Names
addCardAcceptorNames 5 params body → 200400default
GET
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names
Mastercard Get Card Acceptor Names
getCardAcceptorNames 10 params → 200400404default
GET
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Get Card Acceptor Name by Id
getCardAcceptorNameById 6 params → 200400404default
PUT
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Update Card Acceptor Name by Id
updateCardAcceptorNameById 7 params body → 200400404default
DELETE
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Delete Existing Card Acceptor Name
deleteCardAcceptorById 6 params → 204400404default
POST
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids
Mastercard Add Acquirer Reference Id and Card Acceptor Id Pairs
addAcquirerMerchantIds 5 params body → 200400default
GET
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids
Mastercard Get Accepted Acquirer Reference Id and Card Acceptor Id Pairs
getAcceptedAcquirerMerchantIds 10 params → 200400404default
DELETE
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids/{acquirer_merchant_id}
Mastercard Delete Existing Acquirer Reference Id and Card Acceptor Id Pair
deleteAcceptedAcquirerMerchantId 6 params → 204400404default
POST
/searches
Mastercard Get a List of Merchant Details
getMerchants 4 params body → 200400401403

Schemas 171

The contract defines 171 schemas that model the data the API accepts and returns. The most detailed are Merchant_2 (30 properties), Merchant (21 properties), MerchantSearch (16 properties), MerchantParticipation (14 properties). Each schema is shown below with its type and property counts.

MerchantCategory
object
Information for a supported merchant category.
2 properties 2 required
X-MC-Correlation-ID
string
SupportedMerchantCategories
array
List of supported merchant categories.
Category
object
User understandable information about an MCC categorization.
4 properties
acceptorId
string
Mastercard assigned ID.
submitterICA
string
ICA(s) of partner(s) institution(s) who submitted this merchant participation.
mids
array
Merchant IDs assigned by the acquirer.
MerchantSearches
array
List of Merchant objects
walletId
integer
Indicates the wallet, 1 for ApplePay, 2 for GooglePay, and 3 for SamsungPay.
total
integer
The total number of items in the collection.
ErrorList
array
duns
string
A unique identifier assigned by Dun and Bradstreet is used to identify a business.
httpErrorStatusCode
integer
HTTP error code of original POST /merchants/participations API.
MerchantMidSearchParameters
object
Parameters to search mid for a given merchant.
5 properties 3 required
dbaName
string
Trade name used by merchant to conduct business and is known to the consumer.
Merchant
object
Merchant object
21 properties
Errors
object
Error object which returns the list of Error objects.
1 property 1 required
merchantLegalName
string
Legally registered name of the merchant.
optIn
string
Merchant opt-in or opt-out preference for non-merchant negotiated product codes, such as, SPP, SPS, SBJ, and SBK or GCS.
Address
object
The address of the merchant.
6 properties
maid
string
Mastercard Assigned ID (MAID) as specified in Customer Interface Specification for ISO data element DE48 SE32.
acquirerICA
string
ICA of acquirer which will be part of auth transaction. Insert leading zeros to ensure that the acquirerICA is either 6, 9, or 11 characters in length.
status
string
Status of request
wallet
object
Contains merchant wallet information.
3 properties 2 required
limit
integer
The number of items you asked the list to be limited to.
requestId
integer
The request ID is obtained by calling POST /merchants/participations API.
MerchantParticipations
array
List of merchant participation reference objects.
websiteUrl
string
The URL of the merchant website.
MidDetailsPage
object
Contains mids of a merchant.
7 properties 5 required
countryCode
string
Legally registered country code of merchant. Refer to (https://www.iso.org/obp/ui/search) for ISO 3166 alpha 3 code values.
dbaNames
array
mid
string
Merchant ID assigned by the acquirer.
searchMaidType
string
Flag to identify provided MAID type. This is mandatory for participation requests with MAID.
maidType
string
Flag to identify provided MAID type. This is mandatory for participation requests with MAID.
walletAcceptance
string
States whether the merchant accepts the wallet or not.
Merchants
array
List of Merchant objects
MidDetails
array
API will return a list of wallet name, wallet acceptance, and wallet merchant id.
merchantGroup
string
Merchant Group. An identifier used to determine the merchant category type to qualify for the right MAID (MAID is assigned internally by Mastercard). It is imp…
MidDetail
object
Contains mid with status.
3 properties 2 required
errorReason
string
Reason for error.
errors
array
Error object which contains a list of error objects.
1 required
MerchantSearchParameters
object
Parameters to search merchant objects. At least one parameter is required in the request.
5 properties
offset
integer
The number of items you asked for at the start of the list to be offset from.
MerchantSearch
object
Merchant object
16 properties
acceptorIds
array
MAID IDs assigned by Mastercard.
maids
array
Mastercard Assigned ID (MAID). Adding a MAID based merchant object requires the mandatory provision of maids, while updating a merchant does not necessitate it.
ErrorWrapper
object
The error response object which gets returned in case of any error.
1 property 1 required
MerchantParticipation
object
Merchant participation reference
14 properties 3 required
merchantParticipationStatus
string
Status of request
walletMerchantId
string
One or more wallet merchant IDs separated by the pipe symbol.
requestEndpoint
string
original request endpoint
nonMerchantNegotiatedParticipation
string
Merchant opt-in or opt-out preference for non-merchant negotiated product codes, such as, SPP, SPS, SBJ, and SBK.
count
integer
The number of items in this batch (the size of the item array).
wallets
array
Merchant wallets.
Error
object
Error object which contains details about the Error.
5 properties 4 required
Error_2
object
Details of the error condition such as the source of the error, reason code for the error, if the error is recoverable, and details about the error
5 properties 4 required
PercentOwnership
string
Percent Ownership.
User
string
Username for the user creating or modifying a resource
SanctionScreening
object
8 properties 3 required
AlertsCardAcceptorNameConfig
object
Card acceptor name configuration
5 properties 1 required
AcquirerMerchantIdsResource
object
Set of acquirer reference ID & card acceptor ID pairs resource
2 properties
ShortEmail
string
Email address
ImageBase64Encoded
string
Base 64 encoded image (JPG or PNG)
AlertsSubMerchantResource
object
Response containing a specific sub-merchant with details
9 properties
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
LocationWithoutCardAcceptorsResource
object
CardAcceptorDataResource
object
4 properties 4 required
SearchFieldResource
object
Merchant Api Search Field
3 properties
AcquirerMerchantIdResource
object
Acquirer reference ID & card acceptor ID resource
1 required
CardAcceptorData
object
2 properties 2 required
PageableCardAcceptorNamesResource
object
Pageable card acceptor names resource with pagination metadata
2 properties
AlertsAcquirerReferenceIdConfig
object
Acquirer reference id configuration
4 properties 2 required
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…
MerchantStatus
string
Merchant Status must be one of - ACTIVATED, DEACTIVATED
AlertsCardAcceptorIdConfig
object
Map of acquirer reference id and the corresponding card acceptor id
3 properties 2 required
LocaleResource
PageableLocationsResource
object
Pageable locations resource with pagination metadata
2 properties
AcquirerMerchantId
object
Acquirer reference ID & card acceptor ID pair
3 properties 2 required
AlertsSubMerchantCreate
object
Request used to create sub-merchants
2 properties 2 required
CardAcceptors
array
List of merchant card acceptors
LocationsBulkResource
object
List of locations resource
1 property
Errors_2
object
Only returned in the event of an error condition
1 property 1 required
LastName
string
The individual's last name
SubMerchantState
object
2 properties 1 required
LogoImageResource
Schema for a sub-merchant logo including image binary
SearchFieldsResource
array
Search Field
SecondName
string
The individual's second name
PrimaryContact
object
Primary contact details of the merchant
5 properties 4 required
ResponseTime
string
Total response time in ms
AlertsMerchantConfigId
string
Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants configuration
LocationResource
AcquirerMerchantIds
array
Set of acquirer reference ID & card acceptor ID pairs
LocationWithoutCardAcceptors
object
1 required
AcquirerMerchant
object
Acquirer & Merchant IDs information
1 property 1 required
SubMerchant
Schema for a sub-merchant
BaseMerchant
object
Base merchant model schema
8 properties 4 required
FirstPartyTrustEnrollmentType
string
Type of First Party Trust Enrollment
AcceptedAcquirerMerchantIdsResource
array
Accepted acquirer reference ID & card acceptor ID pairs
Crm
object
Customer Relationship Management
3 properties
EntityName
string
The entity's legal or business name.
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.
MerchantGuid
string
Consumer Clarity internal merchant's GUID
AlertsMerchantIdentifierConfigIdOnly
object
Merchant identifier configuration Id (referring to card acceptor id or name configuration)
1 property
LogoResource
object
Schema for a sub-merchant logo status
2 properties 1 required
BulkOperationResource
object
Resource with responseCode and details
3 properties 1 required
Merchant_3
Base merchant request schema
3 required
Errors_3
object
Errors object
1 property 1 required
BeneficialOwner
object
Individual owning the merchant.
7 properties
Address_2
Address entity associated to merchant's location and legal address.
1 required
LegalEntity
object
Legal entity owning the merchant.
5 properties
CardTypes
array
A list of all of the card types that are accepted as a form of payment.
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…
TermsConditionsConsent
object
8 properties 8 required
CreatedOrModifiedBy
object
Timestamp and user responsible for creation or modification of the resource
2 properties
SubMerchantResource
Sub-Merchant Response
ErrorResponse_2
object
Only returned in the event of an error condition
1 property 1 required
FirstPartyTrustEnrollment
object
1 property 1 required
AlertsAcquirerReferenceIdConfigs
array
Acquirer reference id configurations
MerchantLogo
object
logo request schema for merchants
1 property 1 required
LocationCount
integer
UserId
string
The user id of the submitter/technical contact.
ClarityResponseHeader
CardScheme
string
Name of card scheme may be one of - MASTERCARD, VISA or any other supported schemes
AlertsMerchantMemberId
string
Internal Universally Unique Identifier (UUID) which uniquely identifies the merchants
AlertsSubMerchantStatusUpdate
object
Request used to update sub-merchant status
1 property 1 required
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.
MCMerchantCategory
object
This object represents one merchant category information.
1 property 1 required
MCSupportedMerchantCategories
object
The response object that contains a list of supported merchant categories.
1 property 1 required
MerchantCategoryCode
string
A four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides.
CardAcceptorNamesBulkResource
object
Set of Card Acceptor Names resource
1 property
MerchantType
string
Merchant Type must be one of - PARTNER, ACQUIRER, SUBMERCHANT
SearchFields
array
SearchFields is an array of SearchField objects. The following validations apply: If the searchFields array contains both TRANSACTIONAMOUNT and TRANSACTIONCURR…
Timestamp
string
Timestamp of the creation or modification of the resource
ShortAddress
object
Address.
6 properties
MerchantName
string
Merchant's partial or full name.
Merchant_2
object
Merchant detail information
30 properties
SalesforceAccountNumber
string
Unique identifier for a merchant in sales force system.
AlertsPageableAcquirerReferenceIdConfigs
object
Pageable response containing acquirer reference id configurations
2 properties
Merchants_2
object
5 properties
Locale
object
Merchant Locale details
3 properties 3 required
FirstPartyTrustEnrollmentResource
object
1 property 1 required
AlertsSubOrgProfile
object
Sub organization member details containing member name, id and type
4 properties
LocationsBulk
object
1 property 1 required
ValidationStatus
object
Status of created Merchant
2 properties
AlertsPageableSubMerchantResource
object
Pageable response containing sub-merchants with their details
2 properties
AlertsAcquirerReferenceIdConfigUpdate
object
Acquirer reference id configuration for update
1 property 1 required
BinOnlyMatch
boolean
Indicates whether to use only acquirer reference ID (Acquirer BIN) for merchant matching
AlertsSubMerchantDetailsUpdate
object
Request used to update sub-merchant details
2 properties 2 required
MerchantResource
Base merchant response schema
3 required
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…
CrmResource
Customer Relationship Management Response
ResponseHeader
object
4 properties
MerchantSearch_2
object
Merchant Search Request Info
11 properties
SearchField
object
Schema for a Search Field
3 properties 1 required
AlertsCardAcceptorIdConfigs
object
Card acceptor id configurations for a merchant
2 properties
AlertsOrgProfile
object
Details of organization profiles containing member name, id and type
5 properties
SubMerchantIdentifier
string
The alphanumeric ID of the sub-merchant associated with the purchase details. Required for channel partner.
Email
string
Email address
PageableAcceptedAcquirerMerchantIdsResource
object
Pageable accepted acquirer reference ID & card acceptor ID pairs resource with pagination metadata
2 properties
CardAcceptorNamesBulk
object
1 property 1 required
CardTypesResource
array
A list of all of the card types that are accepted as a form of payment.
CountryCode
string
The [ISO 3166-1](https://www.iso.org/obp/ui/search) alpha-3 compliant country code.
LegalAddress
Legal address of the merchant.
6 required
Location
object
2 required
Error_3
object
Error object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-merchants-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 Merchants 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.