Mastercard Guid API
The Guid API from Mastercard — 15 operation(s) for guid.
Mastercard Guid API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include GUID. 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 33 operations across 15 paths, and defines 105 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.example.com.
33 operations
15 paths
105 schemas
8 DELETE11 GET6 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 33
Across 15 paths, the API surfaces 33 operations — 8 DELETE, 11 GET, 6 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Guid 33
PUT
/merchants/{guid}/logos
Mastercard Update a Logo for an Existing Merchant.
POST
/merchants/{guid}/logos
Mastercard Create a Logo for an Existing Merchant.
DELETE
/merchants/{guid}/logos
Mastercard Delete a Logo for an Existing Merchant.
GET
/merchants/{guid}/logos
Mastercard Get the Logo for an Existing Merchant.
PUT
/sub-merchants/{guid}
Mastercard Update a Sub-merchant.
GET
/sub-merchants/{guid}
Mastercard Get Sub-merchant by Guid.
PUT
/sub-merchants/{guid}/states
Mastercard Activate/deactivate a Sub-merchant.
POST
/sub-merchants/{guid}/locations
Mastercard Add a Unique Set of Sub-merchant's Locations
GET
/sub-merchants/{guid}/locations
Mastercard Get Sub-merchant's Locations
GET
/sub-merchants/{guid}/locations/{location_id}
Mastercard Get Location by Id
PUT
/sub-merchants/{guid}/locations/{location_id}
Mastercard Update an Existing Location
DELETE
/sub-merchants/{guid}/locations/{location_id}
Mastercard Delete an Existing Location
POST
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names
Mastercard Add Card Acceptor Names
GET
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names
Mastercard Get Card Acceptor Names
GET
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Get Card Acceptor Name by Id
PUT
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Update Card Acceptor Name by Id
DELETE
/sub-merchants/{guid}/locations/{location_id}/card-acceptor-names/{id}
Mastercard Delete Existing Card Acceptor Name
POST
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids
Mastercard Add Acquirer Reference Id and Card Acceptor Id Pairs
GET
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids
Mastercard Get Accepted Acquirer Reference Id and Card Acceptor Id Pairs
DELETE
/sub-merchants/{guid}/locations/{location_id}/acquirer-merchant-ids/{acquirer_merchant_id}
Mastercard Delete Existing Acquirer Reference Id and Card Acceptor Id Pair
GET
/users/{user_guid}/virtual-card-accounts
Retrieve a list of all virtual cards linked to a user
POST
/users/{user_guid}/virtual-card-accounts
Register a virtual card linked to a user
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}
Retrieve virtual card account details linked to a user
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}
Update virtual card account details linked to a user
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}
Delete a virtual card account linked to a user
GET
/users/{user_guid}
Retrieve user details
PUT
/users/{user_guid}
Update a user
DELETE
/users/{user_guid}
Delete a user
DELETE
/real-card-accounts/{account_guid}
Delete all virtual cards linked to a real card
POST
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens
Register a token linked to a user and a virtual card
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Retrieve token details linked to a user and a virtual card
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Update a token linked to a user and a virtual card
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Delete a token linked to a user and a virtual card
Schemas 105
The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are Control (12 properties), SanctionScreening (8 properties), VelocityControl (8 properties), TermsConditionsConsent (8 properties). Each schema is shown below with its type and property counts.
PercentOwnership
string
Percent Ownership.
AcquirerMerchantIdsResource
object
Set of acquirer reference ID & card acceptor ID pairs resource
2 properties
SanctionScreening
object
8 properties
3 required
ShortEmail
string
Email address
ImageBase64Encoded
string
Base 64 encoded image (JPG or PNG)
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
LocaleResource
PageableLocationsResource
object
Pageable locations resource with pagination metadata
2 properties
AcquirerMerchantId
object
Acquirer reference ID & card acceptor ID pair
3 properties
2 required
CardAcceptors
array
List of merchant card acceptors
LocationsBulkResource
object
List of locations resource
1 property
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
LocationResource
ResponseTime
string
Total response time in ms
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
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
Base merchant request schema
3 required
Errors
object
Errors object
1 property
1 required
BeneficialOwner
object
Individual owning the merchant.
7 properties
Address
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.
TermsConditionsConsent
object
8 properties
8 required
SubMerchantResource
Sub-Merchant Response
FirstPartyTrustEnrollment
object
1 property
1 required
MerchantLogo
object
logo request schema for merchants
1 property
1 required
LocationCount
integer
UserId
string
The user id of the submitter/technical contact.
ClarityResponseHeader
FirstName
string
The individual's first name
CardAcceptorNamesBulkResource
object
Set of Card Acceptor Names resource
1 property
SearchFields
array
SearchFields is an array of SearchField objects. The following validations apply: If the searchFields array contains both TRANSACTIONAMOUNT and TRANSACTIONCURR…
ShortAddress
object
Address.
6 properties
MerchantName
string
Merchant's partial or full name.
SalesforceAccountNumber
string
Unique identifier for a merchant in sales force system.
Locale
object
Merchant Locale details
3 properties
3 required
FirstPartyTrustEnrollmentResource
object
1 property
1 required
LocationsBulk
object
1 property
1 required
ValidationStatus
object
Status of created Merchant
2 properties
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
SearchField
object
Schema for a Search Field
3 properties
1 required
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
object
Error object
5 properties
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
Vcn
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
Error_2
object
5 properties
UpdateVirtualCardAccount
object
1 required
VirtualCardAccount
object
2 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
UserDetail
object
4 properties
4 required
Card
object
2 properties
2 required
ErrorWrapper
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_2
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
ErrorList
array
TimeOfDay
object
3 properties
3 required
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
#GUID
Where this information came from
This is an independent, third-party profile of Mastercard Guid 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.