Mastercard Searches API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Searches. 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
11 operations
across 11 paths,
and defines 118 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.
Benefits
object
5 properties
1 required
Products
object
2 properties
1 required
SearchBenefits
object
1 property
CustomAttribute
object
2 properties
Benefit
object
The representation of a benefit provided by Mastercard to the cardholders. The details of the benefit are represented by means of various properties defined by…
57 properties
SearchProducts
object
8 properties
Product
object
2 properties
ErrorWrapper
object
A top level object for errors
1 property
1 required
Errors
object
Object that contains the list of errors
1 property
1 required
ErrorList
array
The list of errors
Error
object
A single error
5 properties
SearchByAccountRange
object
1 property
1 required
ErrorResponse
object
1 property
1 required
BinResource
object
23 properties
Error_2
object
5 properties
3 required
SearchCard
object
1 property
1 required
DonateGetAllCards
object
1 property
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
RPActivitySearch
object
5 properties
4 required
AddressData
object
6 properties
Selfie
object
2 properties
2 required
UserAccountActivitySearch
object
5 properties
4 required
RPActivityItems
object
4 properties
4 required
PDS
string
Encrypted Personal Device Storage (PDS) which hosts the users identity attributes. The PDS can be retrieved from the MIDS Core SDK, please refer to the SDK gui…
UserAccountActivities
object
2 properties
1 required
UserAccountActivityItemContents
object
4 properties
1 required
DateOfBirth
object
2 properties
2 required
MothersName
object
2 properties
2 required
Phone
object
2 properties
2 required
DriverLicenseCardNumber
string
Document number.
UserAccountActivityItems
object
3 properties
2 required
PassportIdentity
object
3 properties
RPActivities
object
2 properties
1 required
IdentityAttributesByName
object
Identity attributes keyed by IdentitySearch.scopedFields enum.
ErrorResponse_2
object
The error response model used by all the API endpoints.
1 property
1 required
IdentitySearch
object
4 properties
3 required
MobileIdEligibility
object
2 properties
2 required
SdkVersion
string
Mastercard SDK version integrated with TP App, it is a constant extracted from MIDS SDK Configurations (generated while bundling SDK artifacts). If the TP app…
UserConsent
string
Confirmation provided by the TP that the user has consented that the ID-Network can have access to their identity for the purposes of the API call. Should be A…
DriverLicenseDetails
object
3 properties
IdentityAttributesById
object
Identity attributes are keyed by attribute IDs.
VisaMatched
boolean
Flag indicating if the documentDetails are to be checked against a visa for a particular country.
Email
object
2 properties
2 required
Cpf
string
CPF Number. This will only be available when the Brazilian DL is scanned.
Rg
string
RG Number. This will only be available when the Brazilian DL is scanned.
LegalName
object
2 properties
2 required
ClientIdentities
object
2 properties
1 required
DriverLicenseIdentity
object
3 properties
PassportDetails
object
3 properties
DriverLicenseImage
object
Driver License Images.
2 properties
FathersName
object
2 properties
2 required
PassportImage
object
Passport License Images.
1 property
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.
duns
string
A unique identifier assigned by Dun and Bradstreet is used to identify a business.
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…
status
string
Status of request
MidDetail
object
Contains mid with status.
3 properties
2 required
limit
integer
The number of items you asked the list to be limited to.
wallet
object
Contains merchant wallet information.
3 properties
2 required
submitterICA
string
ICA(s) of partner(s) institution(s) who submitted this merchant participation.
errorReason
string
Reason for error.
MerchantMidSearchParameters
object
Parameters to search mid for a given merchant.
5 properties
3 required
MerchantSearchParameters
object
Parameters to search merchant objects. At least one parameter is required in the request.
5 properties
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.
websiteUrl
string
The URL of the merchant website.
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
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_2
object
The error response object which gets returned in case of any error.
1 property
1 required
mid
string
Merchant ID assigned by the acquirer.
MerchantSearches
array
List of Merchant objects
merchantParticipationStatus
string
Status of request
walletMerchantId
string
One or more wallet merchant IDs separated by the pipe symbol.
walletId
integer
Indicates the wallet, 1 for ApplePay, 2 for GooglePay, and 3 for SamsungPay.
dbaName
string
Trade name used by merchant to conduct business and is known to the consumer.
Errors_3
object
Error object which returns the list of Error objects.
1 property
1 required
searchMaidType
string
Flag to identify provided MAID type. This is mandatory for participation requests with MAID.
merchantLegalName
string
Legally registered name of the merchant.
total
integer
The total number of items in the collection.
nonMerchantNegotiatedParticipation
string
Merchant opt-in or opt-out preference for non-merchant negotiated product codes, such as, SPP, SPS, SBJ, and SBK.
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_2
object
The address of the merchant.
6 properties
count
integer
The number of items in this batch (the size of the item array).
wallets
array
Merchant wallets.
walletAcceptance
string
States whether the merchant accepts the wallet or not.
maid
string
Mastercard Assigned ID (MAID) as specified in Customer Interface Specification for ISO data element DE48 SE32.
Error_4
object
Error object which contains details about the Error.
5 properties
4 required
Atm
object
ATM detail information
30 properties
ErrorItems
object
1 property
1 required
ErrorItem
object
5 properties
ClaimSearch
object
3 properties
2 required
ErrorResponse_3
object
Only returned in the event of an error condition
1 property
1 required
ClaimFeature
object
4 properties
RequiredClaimDocuments
object
4 properties
AtmSearch
object
Atm Search Request Info
8 properties
Errors_4
object
Only returned in the event of an error condition
1 property
1 required
ClaimStatus
object
3 properties
Error_5
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Mastercard publishes across the network.
