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

The Guid API from Mastercard — 15 operation(s) for guid.

Mastercard Guid API is one of 172 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 12 operations across 5 paths, and defines 64 schemas. It is described by OpenAPI 3.2.0, at version 1.6.0.

Requests are made against 2 base URLs: https://api.ethocaweb.com/ethoca/merchant-self-services, https://sandbox.api.ethocaweb.com/ethoca/merchant-self-services.

12 operations 5 paths 64 schemas 2 DELETE4 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.0
Base URL
https://api.example.com
Resource Areas
1

Paths & Operations 12

Across 5 paths, the API surfaces 12 operations — 2 DELETE, 4 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

GUID 12
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
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

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are TermsConditionsConsent (8 properties), BaseMerchant (8 properties), SanctionScreening (8 properties), BeneficialOwner (7 properties). Each schema is shown below with its type and property counts.

LocaleResource
CrmResource
Customer Relationship Management Response
Merchant
Base merchant request schema
3 required
CountryCode
stringnull
The [ISO 3166-1](https://www.iso.org/obp/ui/search) alpha-3 compliant country code.
FirstPartyTrustEnrollmentType
string
Type of First Party Trust Enrollment
ResponseTime
string
Total response time in ms
SubMerchant
Schema for a sub-merchant
Errors
object
Errors object
1 property 1 required
CardAcceptor
string
Merchant Card Acceptor
FirstName
stringnull
The individual's first name
Address
Address entity associated to merchant's location and legal address.
1 required
LocationWithoutCardAcceptors
object
1 required
FirstPartyTrustEnrollment
object
1 property 1 required
BulkOperationResource
object
Resource with responseCode and details
3 properties 1 required
MerchantLogo
object
logo request schema for merchants
1 property 1 required
SanctionScreening
object
8 properties 3 required
LogoResource
object
Schema for a sub-merchant logo status
2 properties 1 required
ResourceId
stringnull
Unique identifier of resource
BaseMerchant
object
Base merchant model schema
8 properties 4 required
UserId
string
The user id of the submitter/technical contact.
ShortEmail
stringnull
Email address
MerchantGuid
string
Consumer Clarity internal merchant's GUID
CardAcceptors
arraynull
List of merchant card acceptors
SubMerchantResource
Sub-Merchant Response
CardTypesResource
array
A list of all of the card types that are accepted as a form of payment.
SearchFieldResource
object
Merchant Api Search Field
3 properties
Location
object
2 required
SubMerchantIdentifier
string
The alphanumeric ID of the sub-merchant associated with the purchase details. Required for channel partner.
PercentOwnership
stringnull
Percent Ownership.
LocationsBulkResource
object
List of locations resource
1 property
SearchFieldsResource
arraynull
Search Field
LocationWithoutCardAcceptorsResource
object
MerchantResource
Base merchant response schema
3 required
SubMerchantState
object
2 properties 1 required
PageableLocationsResource
object
Pageable locations resource with pagination metadata
2 properties
Error
object
Error object
5 properties
SecondName
stringnull
The individual's second name
LocationCount
integer
PrimaryContact
object
Primary contact details of the merchant
5 properties 4 required
LegalAddress
Legal address of the merchant.
6 required
LocationsBulk
object
1 property 1 required
ImageBase64Encoded
string
Base 64 encoded image (JPG or PNG)
LegalEntity
object
Legal entity owning the merchant.
5 properties
BeneficialOwner
object
Individual owning the merchant.
7 properties
ValidationStatus
objectnull
Status of created Merchant
2 properties
ResponseHeader
object
4 properties
SearchField
object
Schema for a Search Field
3 properties 1 required
MerchantName
string
Merchant's partial or full name.
TermsConditionsConsent
object
8 properties 8 required
Locale
object
Merchant Locale details
3 properties 3 required
EntityName
stringnull
The entity's legal or business name.
Etag
string
Etag is a response header which is an identifier for a specific version of a resource.
SearchFields
arraynull
SearchFields is an array of SearchField objects. The following validations apply: If the searchFields array contains both TRANSACTIONAMOUNT and TRANSACTIONCURR…
LogoImageResource
Schema for a sub-merchant logo including image binary
ClarityResponseHeader
Email
stringnull
Email address
Crm
objectnull
Customer Relationship Management
3 properties
CardTypes
array
A list of all of the card types that are accepted as a form of payment.
ErrorResponse
object
Error Response object
1 property 1 required
LastName
stringnull
The individual's last name
LocationResource
ShortAddress
object
Address.
6 properties
FirstPartyTrustEnrollmentResource
object
1 property 1 required
SalesforceAccountNumber
string
Unique identifier for a merchant in sales force system.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-guid-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 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.