openapi: 3.0.3 info: title: Match Pro API description: Helps acquirers identify potentially high-risk merchants before entering to a merchant agreement. version: 3.0.17 contact: name: API Support email: apisupport@mastercard.com url: https://developer.mastercard.com/support servers: - url: https://sandbox.apiedge.mastercard.com/mcp/match/api description: Sandbox Environment. - url: https://apiedge.mastercard.com/mtf/mcp/match/api description: MTF Environment. - url: https://apiedge.mastercard.com/mcp/match/api description: Production Environment. tags: - name: acquirer-contact description: Provides acquirers contact informations. - name: merchant description: Adds a new terminated merchant - Involves the process of adding terminated merchants within the system. - name: termination-inquiry description: Termination Inquiry Request - Manages Inquiries related to terminated merchant. - name: performance-indicator description: Fetch performance indicators related to merchant. Retrieves the performance metrics based on National Tax ID of the merchant. - name: new-merchant-insights description: Retrieves merchant risk score and signals by Inquiry Reference Number. - name: retro-inquiry description: Enables the retrieval of the Inquiry retrospective data within the system, allowing users to access past Inquiries data through specific Inquiry-based APIs. - name: countries description: Countries API. - name: states description: State API. - name: cities description: Cities API. paths: /termination-inquiries: post: tags: - termination-inquiry operationId: createInquiry summary: 'Retrieves terminated merchant information based on the criteria defined in the API request.' description: | Returns information on merchants that have been terminated and merchants which have been inquired upon. MATCH Pro can provide the acquiring bank with information if a Merchant has been terminated by another acquirer already, the reason for termination, the history of fraudulent or risky business practices that led to that termination and the inquiry that was made already on the Merchant or individual by own or another acquiring bank.The response also includes an inquiry reference number to be used for future reference in Termination Inquiry History Request API. For further details refer the documentation on [Use Cases](/match/documentation/use-cases). parameters: - $ref: '#/components/parameters/pageLength' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/InternalInquiry' - $ref: '#/components/parameters/showPerformanceIndicators' requestBody: $ref: '#/components/requestBodies/TerminationInqReqBody' responses: '200': $ref: '#/components/responses/TerminatedInqResponse' '400': $ref: '#/components/responses/CreateInquiryBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /termination-inquiries/{inquiry_ref_num}: get: tags: - termination-inquiry summary: 'Retrieves historical termination Inquiry results.' description: | Returns information about Merchants, URLs and up to five principal owners, that have been terminated by an acquiring bank from a previous Inquiry.To access the Inquiry results of the past Inquiries, acquirer should pass the Inquiry reference number (IRN) received from the previous Inquiries(TerminationInquiryRequest).For further details refer the documentation on [Use Cases](/match/documentation/use-cases). operationId: getInquiryByInquiryRefNum parameters: - $ref: '#/components/parameters/pageLength' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/inquiryRefNum' responses: '200': $ref: '#/components/responses/SearchByInquiryRefNumResponse' '400': $ref: '#/components/responses/InquiryRefNumBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/InquiryRefNumNotFound' /merchants/add-merchants: post: tags: - merchant summary: 'Adds a new terminated merchant to MATCH Pro system.' description: | Used by Acquirers to add a terminated a merchant in the MATCH Pro system. Merchant information, and up to five principal owners per merchant, can be provided by an acquiring bank as part of the listing. For adding a terminated merchant, Acquirer Id and Merchant Id combination must be unique and Merchant Id should be less than 15 characters. For further details refer the documentation on [Use Cases](/match/documentation/use-cases). operationId: addTerminatedMerchant requestBody: $ref: '#/components/requestBodies/AddMerchantReqBody' responses: '200': $ref: '#/components/responses/AddMerchantResponse' '400': $ref: '#/components/responses/AddTerminatedMerchantBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /merchants/performance-indicators: post: tags: - performance-indicator summary: Return the Merchant's Performance Indicators. description: Returns performance metrics including aggregated value of global domestic volume, approval rates, chargebacks, and fraud metrics related to the merchant. Incorporates compliance program participation data from MCP applications (BRAM, EFM, ECM). For further details refer the documentation on [Use Cases](/match/documentation/use-cases). operationId: getMerchantPerformanceIndicators requestBody: $ref: '#/components/requestBodies/MerchantPerfIndicatorsReqBody' responses: '200': $ref: '#/components/responses/MerchantPerfIndicatorsDetails' '400': $ref: '#/components/responses/GetMerchantPerformanceIndicatorsBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/GetMerchantPerformanceIndicatorsNotFound' /merchants/new-merchant-insights/{inquiry_ref_num}: get: tags: - new-merchant-insights description: Retrieve a real-time merchant risk assessment powered by proprietary network data and digital signals. After receiving the Inquiry Reference Number (IRN), wait at least 60 seconds before requesting New Merchant Insights results. The score and insights are generated only for the merchant being inquired about. For further details refer to the documentation on [Use Cases](/match/documentation/use-cases). summary: Retrieves merchant risk signals by Inquiry Reference Number operationId: getMerchantRiskSignals parameters: - $ref: '#/components/parameters/inquiryRefNum' responses: '200': $ref: '#/components/responses/MerchantRiskAssessment' '400': $ref: '#/components/responses/InquiryRefNumBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/GetMerchantRiskSignalsNotFound' /contact-details: post: tags: - acquirer-contact summary: 'Retrieve contact information of another acquirer.' description: | Returns the contact information for the acquirer id requested. When MATCH Pro returns a possible merchant match, this resource assists users by retrieving the contact information associated with the Acquirer ID/interbank card association (ICA) number that added the merchant to MATCH Pro. For further details refer the documentation on [Use Cases](/match/documentation/use-cases). operationId: getContactDetailsByAcquirerId requestBody: $ref: "#/components/requestBodies/ContactReqBody" responses: '200': $ref: '#/components/responses/ContactDetails' '400': $ref: '#/components/responses/GetContactDetailsByAcquirerIdBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /retros/retro-lists: post: tags: - retro-inquiry summary: 'The retroactive Inquiry helps acquirer to retrieve list of termination Inquiry matches made within 360 days of Inquiry initiation.' operationId: getRetroInquiries description: Returns list of retro Inquiries. requestBody: $ref: '#/components/requestBodies/RetroListReq' parameters: - $ref: '#/components/parameters/pageLength' - $ref: '#/components/parameters/pageOffset' responses: '200': $ref: '#/components/responses/RetroResponse' '400': $ref: '#/components/responses/GetRetroInquiriesBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' parameters: - $ref: '#/components/parameters/correlationId' /retros/retro-inquiry-details/{inquiry_ref_num}: get: tags: - retro-inquiry summary: 'Retrieve retro Inquiry search results' description: | The acquirer uses the Retroactive Inquiry API to retrieve a list of Retroactive Inquiry Reference Numbers which matched the acquirer’s previous termination Inquiries. The acquirer then uses Retroactive Inquiry Details API to fetch details of the matches for each from previous Inquiries. Details about merchant match includes information, such as, if a Merchant has been terminated by another acquirer after an Inquiry was made, the reason for termination, and the history of fraudulent or risky business practices that led to that termination. operationId: getRetroInquiryByInquiryRefNum parameters: - $ref: '#/components/parameters/inquiryRefNum' responses: '200': $ref: '#/components/responses/RetroInquiryResponse' '400': $ref: '#/components/responses/InquiryRefNumBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/InquiryRefNumNotFound' /countries: get: tags: - countries summary: Retrieve a list of countries. description: | API to retrieve information about countries [Use Cases](/match/documentation/use-cases). operationId: getCountries responses: '200': $ref: '#/components/responses/CountriesResponse' '400': $ref: '#/components/responses/GetCountriesBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /countries/{country_code}/states: get: tags: - states summary: Retrieve a list of states for a given country. description: API to retrieve information about countries and their states. operationId: getStates parameters: - $ref: '#/components/parameters/countryCode' responses: '200': $ref: '#/components/responses/StateResponse' '400': $ref: '#/components/responses/GetStatesBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' /countries/{country_code}/cities: get: tags: - cities summary: Retrieve a list of cities for a given country. description: API to retrieve information about countries and their cities. operationId: getCities parameters: - $ref: '#/components/parameters/countryCode' - $ref: '#/components/parameters/stateCode' responses: '200': $ref: '#/components/responses/CityResponse' '400': $ref: '#/components/responses/GetCitiesBadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: countryCode: # Can be referenced via '#/components/parameters/countryCode' name: country_code in: path schema: type: string example: "USA" minLength: 3 maxLength: 3 required: true description: Country Code for the country. stateCode: name: state_code in: query description: StateDTO code to fetch state specific details. required: false schema: type: string example: 'AL' maxLength: 3 pageOffset: name: page_offset in: query schema: type: integer minimum: 0 maximum: 1000000000 format: int32 example: 0 default: 0 required: false description: Page offset for pagination. This parameter accepts only positive values. pageLength: name: page_length in: query schema: type: integer format: int32 minimum: 1 maximum: 100 example: 100 default: 100 required: false description: Page Length for pagination. This parameter accepts only positive values. InternalInquiry: name: internal_inquiry in: query schema: type: boolean example: false default: false required: false description: Internal Inquiry Flag showPerformanceIndicators: name: show_perf_indicators in: query schema: type: boolean example: false default: false required: false description: Show Performance Indicators Flag When true, response may include `merchantPerformanceIndicator` only if performance indicators data is available. When false, `merchantPerformanceIndicator` is omitted from the response. correlationId: # Can be referenced via '#/components/parameters/correlationId' name: X-MC-Correlation-ID in: header schema: type: string example: 237e9877-e79b-12d4-a765-321741963000 required: false description: Unique identifier value that is attached to request. Mastercard edge devices must generate a UUID(correlation-id) at the entry point and set in the HTTP header. inquiryRefNum: # Can be referenced via '#/components/parameters/inquiryRefNum' name: inquiry_ref_num in: path schema: type: string example: "1996-241205045628-MEVYLJWX" required: true description: Inquiry Reference Number (IRN) A unique identifier generated by the MATCH Pro system that is returned in the original, previously submitted POST request (contained within the "TerminationInquiry.Ref" response node). This unique identifier should be present as a URL parameter within all GET requests. requestBodies: ContactReqBody: description: The contact request object. required: true content: application/json: schema: $ref: '#/components/schemas/ContactReq' TerminationInqReqBody: description: Body of the Termination Inquiry Request. required: true content: application/json: schema: $ref: '#/components/schemas/TerminationInquiry' AddMerchantReqBody: required: true description: Body of the Add Terminated Merchant Request. content: application/json: schema: $ref: '#/components/schemas/AddTerminatedMerchantReq' RetroListReq: description: Retro list request body to retrieve a list of retros. required: true content: application/json: schema: $ref: '#/components/schemas/RetroList' MerchantPerfIndicatorsReqBody: description: The Merchant Performance Indicators request object. required: true content: application/json: schema: $ref: '#/components/schemas/MerchantPerfIndicatorsReq' responses: Unauthorized: description: You are not authorized to view the resource. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorizedAccess: value: Errors: Error: - Source: "access_denied" ReasonCode: "UNAUTHORIZED" Description: "access_denied" Recoverable: "true" details: "The operation included an invalid credentials or authorization" Forbidden: description: 403 Forbidden Request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: forbiddenAction: value: Errors: Error: - Source: "Authorization" ReasonCode: "MATCH-403-0001" Description: "Forbidden: Insufficient permissions" Recoverable: false Details: "The authenticated user does not have permission to access this resource" CreateInquiryBadRequest: description: Bad request for create termination inquiry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidCreateInquiryRequest: value: Errors: Error: - Source: "terminationInquiry.merchant.name" ReasonCode: "MATCH-400-1003" Description: "Merchant Name is required" Recoverable: true Details: "Merchant Name is required" InquiryRefNumBadRequest: description: Bad request for inquiry history lookup. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidInquiryRefNum: value: Errors: Error: - Source: "invalid_request" ReasonCode: "INVALID_INPUT_VALUE" Description: "IRN is Not present in DB" Recoverable: false Details: "IRN is Not present in DB" InquiryRefNumNotFound: description: Inquiry reference number not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: inquiryNotFound: value: Errors: Error: - Source: "invalid_request" ReasonCode: "INVALID_INPUT_VALUE " Description: "Invalid IRN" Recoverable: false Details: "Invalid IRN" AddTerminatedMerchantBadRequest: description: Bad request for add terminated merchant. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidAddMerchantRequest: value: Errors: Error: - Source: "addMerchantRequest.merchant.name" ReasonCode: "MATCH-400-1003" Description: "Merchant Name is required" Recoverable: true Details: "Merchant Name is required" GetMerchantPerformanceIndicatorsBadRequest: description: Bad request for merchant performance indicators. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidPerformanceIndicatorsRequest: value: Errors: Error: - Source: "performanceIndicator.acquirerId" ReasonCode: "MATCH-400-1202" Description: "Merchant Acquirer ID is required" Recoverable: true Details: "Merchant Acquirer ID is required" GetMerchantPerformanceIndicatorsNotFound: description: Merchant performance indicators not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: performanceIndicatorsNotFound: value: Errors: Error: - Source: "Request.Payload" ReasonCode: "MATCH-PI-404-001" Description: "No data found for Tax ID" Recoverable: true Details: "No data found for Tax ID" GetMerchantRiskSignalsNotFound: description: Merchant risk signals not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: riskSignalsNotFound: value: Errors: Error: - Source: "MRA_NOT_FOUND_FOR_IRN" ReasonCode: "MATCH-MRA-404-100001" Description: "MerchantRiskAssessment not found for the given IRN" Recoverable: false Details: "No MerchantRiskAssessment found for the received IRN" GetContactDetailsByAcquirerIdBadRequest: description: Bad request for contact details lookup. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidContactDetailsRequest: value: Errors: Error: - Source: "invalid_request" ReasonCode: "INVALID INPUT VALUE" Description: "Acquirer Id is required" Recoverable: false Details: "Acquirer Id is required" GetRetroInquiriesBadRequest: description: Bad request for retro inquiries list. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidRetroListRequest: value: Errors: Error: - Source: "retroInquiryRequest.acquirerId" ReasonCode: "MATCH-400-1000" Description: "Invalid Request Payload: retroInquiryRequest.acquirerId" Recoverable: true Details: "One or more fields in the request are either missing or do not have correct values" GetCountriesBadRequest: description: Bad request for countries list. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidCountriesRequest: value: Errors: Error: - Source: "countries" ReasonCode: "MATCH-400-COUNTRIES" Description: "Invalid countries request" Recoverable: "true" details: "Request parameters are invalid" GetStatesBadRequest: description: Bad request for states list. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidStatesRequest: value: Errors: Error: - Source: "countryCode" ReasonCode: "MATCH-400-1039" Description: "Country Code is not valid" Recoverable: true Details: "Country Code is not valid" GetCitiesBadRequest: description: Bad request for cities list. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidCitiesRequest: value: Errors: Error: - Source: "stateCode" ReasonCode: "MATCH-400-1040" Description: "State Code is not valid" Recoverable: true Details: "State Code is not valid" TerminatedInqResponse: description: The termination Inquiry response object. content: application/json: schema: $ref: '#/components/schemas/TerminationInquiryDtl' AddMerchantResponse: description: The add terminated merchant response object. content: application/json: schema: $ref: '#/components/schemas/AddTerminatedMerchantResp' ContactDetails: description: The contact details response object. content: application/json: schema: $ref: '#/components/schemas/ContactDetailsRes' SearchByInquiryRefNumResponse: description: The search Inquiry by reference number response object. content: application/json: schema: $ref: '#/components/schemas/TerminationInquiryHistoryRes' RetroInquiryResponse: description: The retroactive Inquiry response object. content: application/json: schema: $ref: '#/components/schemas/RetroActiveInquiryRes' RetroResponse: description: Retro Inquiry list response object. content: application/json: schema: $ref: '#/components/schemas/RetroInquiry' CountriesResponse: description: The countries response object. content: application/json: schema: $ref: '#/components/schemas/CountriesRes' StateResponse: description: The State API response object. content: application/json: schema: $ref: '#/components/schemas/StateRes' CityResponse: description: The City API response object. content: application/json: schema: $ref: '#/components/schemas/CityRes' MerchantPerfIndicatorsDetails: description: Merchant Performance Indicators Response. content: application/json: schema: $ref: '#/components/schemas/MerchantPerfIndicators' MerchantRiskAssessment: description: Merchant Risk Assessment Response. content: application/json: schema: $ref: '#/components/schemas/MerchantRiskAssessment' schemas: ContactReq: required: - contactRequest type: object properties: contactRequest: $ref: '#/components/schemas/contactDetail' contactDetail: required: - acquirerId type: object properties: acquirerId: type: string pattern: ^[0-9]*$ description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. minLength: 1 maxLength: 11 example: 12086 ContactDetailsRes: type: object properties: contactDetails: $ref: '#/components/schemas/ContactRes' ContactRes: type: array items: $ref: '#/components/schemas/Contact' Contact: type: object properties: bankName: type: string description: The name of acquiring bank. example: THE XYZ BANK region: type: string description: The region of acquiring bank. The results may return information for more than one Contact. example: UNITED STATES firstName: type: string description: The first name of primary contact of acquiring bank. The results may return information for more than one Contact. example: JACK lastName: type: string description: The last name of primary contact of acquiring bank. The results may return information for more than one Contact. example: SMITH phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "6360000000" faxNumber: type: string description: The Fax Number of primary contact of acquiring bank. The results may return information for more than one Contact. example: "6360000001" emailAddress: type: string description: The Email address of primary contact of acquiring bank. The results may return information for more than one Contact. example: JACK_SMITH@XYZ.COM AddTerminatedMerchantReq: required: - addMerchantRequest type: object properties: addMerchantRequest: $ref: '#/components/schemas/AddMerchantReq' AddMerchantReq: required: - acquirerId - merchant type: object properties: acquirerId: type: string pattern: ^[0-9]+$ description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. minLength: 1 maxLength: 11 example: "1996" merchant: $ref: '#/components/schemas/AddMerchant' AddMerchant: required: - name - merchantId - address - phoneNumber - merchantCategory - dateClosed - dateOpened - principals - reasonCode - isProprietorship - isTransactionLaundering type: object properties: isProprietorship: type: string description: Flag indicates merchant is a sole proprietorship.It contains either 'Y' for "yes" or 'N' for "no". maxLength: 1 example: N pattern: ^[Y|N]$ name: type: string description: The name of the Business which has been terminated. example: THE BAIT SHOP minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9!@#$&*(){}\\`':^_\-;|.+?,\/\[\] ]+$ doingBusinessAsName: type: string description: The name used by a merchant that may differ from the merchant name, such as 'Bait R Us' differs from the merchant name 'The Bait Shop'. example: BAIT R US maxLength: 255 pattern: ^[a-zA-Z0-9!@#$&*(){}\\`':^_\-;|.+?,\/\[\] ]+$ merchantId: type: string description: The identifier assigned to a merchant by an Acquirer. example: 'ABED-1234' minLength: 1 maxLength: 25 pattern: ^[a-zA-Z0-9-]+$ subMerchantId: type: string description: The Business or Merchant's Sub Merchant Id. example: 'ABED-1234-1' maxLength: 25 pattern: ^[a-zA-Z0-9-]+$ address: allOf: - $ref: '#/components/schemas/Address' - type: object required: - addressLineOne - city - country - isOtherCity properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. minLength: 1 maxLength: 100 example: 42 ELM AVENUE pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 maxLength: 100 pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y pattern: ^[Y|N]$ maxLength: 1 city: type: string description: The name of the city for a merchant location. example: Fayzabad minLength: 1 maxLength: 30 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_ (),-./'+&#?$`]*[a-zA-Z0-9])?$ countrySubdivision: type: string description: The abbreviated state or province code for the merchant's location. Required only for merchants in the United States and Canada. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ province: type: string description: The name of the province for the merchant location. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ country: type: string description: The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. example: AFG minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]+$ postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" maxLength: 10 phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "6367558963" minLength: 1 maxLength: 25 pattern: ^[0-9]+$ altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "6367558968" maxLength: 25 pattern: ^[0-9]*$ merchantCategory: type: string description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant. example: '0742' maxLength: 4 pattern: ^[0-9]+$ nationalTaxId: type: string description: The merchant’s national tax identification number or business registration number. Required for Brazil. example: "NT_123456789/01" maxLength: 35 pattern: ^[A-Za-z0-9-_/. ]*$ countrySubdivisionTaxId: type: string description: The merchant’s state-level tax identification number. example: "12345/0001-23" maxLength: 35 pattern: ^[A-Za-z0-9-_/. ]*$ dateOpened: type: string format: date description: The date on which the merchant entered into an agreement with the acquirer must be provided in the format 'yyyy-MM-dd'. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" dateClosed: type: string format: date description: The date on which the agreement was terminated with the merchant must be provided in the format 'yyyy-MM-dd'. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" urls: type: array maxItems: 100 description: The website address of the merchant. Multiple URLs may be included in a single request. The total combined size of all URLs must not exceed 20,000 bytes. items: type: string example: [ 'www.merchant.com' ] maxLength: 1000 pattern: ^(?:(https?|ftp)://)?(?!(10|127)(\.\d{1,3}){3})(?!(169\.254|192\.168)(\.\d{1,3}){2})(?!172\.(1[6-9]|2\d|3[0-1])(\.\d{1,3}){2})((([a-zA-Z0-9\-]+\.)+[a-zA-Z]{2,})|((?!0)(25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d{2}|\d{1,2})){3}))(\:\d{2,5})?(\/[^\s]*)?$ isTransactionLaundering: type: string description: Indicates is Merchant involved in transaction laundering. maxLength: 1 example: N pattern: ^[Y|N]$ principals: type: array minItems: 1 maxItems: 5 description: Principal data. items: allOf: - $ref: '#/components/schemas/Principal' - type: object required: - firstName - lastName - address - phoneNumber - email - dateOfBirth properties: firstName: type: string description: The first name of the principal owner of the business. minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9-'. ]+$ example: DAVID middleInitial: type: string description: The middle initial of the name of the principal owner of the business. maxLength: 1 pattern: ^[a-zA-Z0-9]+$ example: P lastName: type: string description: The last name of the principal owner of the business. minLength: 1 maxLength: 255 example: SMITH pattern: ^[a-zA-Z0-9-'. ]+$ address: allOf: - $ref: '#/components/schemas/PrincipalAddress' - type: object required: - addressLineOne - city - country - isOtherCity properties: addressLineOne: type: string description: Line one of the street address for the principal owner location. Usually includes street number and name. minLength: 1 maxLength: 100 example: 42 ELM AVENUE pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 maxLength: 100 pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y pattern: ^[Y|N]$ maxLength: 1 city: type: string description: The name of the city for a principal owner location. example: Fayzabad minLength: 1 maxLength: 30 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_ (),-./'+&#?$`]*[a-zA-Z0-9])?$ countrySubdivision: type: string description: The abbreviated state or province code for the principal owner's location. Supported only for principal owner's in the United States and Canada. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ province: type: string description: The name of the province for the principal owner location. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" maxLength: 10 country: type: string description: The three digit country code of the principal owner. Valid values are three digit alpha country codes as defined in ISO 3166-1. example: AFG minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]+$ phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). minLength: 1 maxLength: 25 example: "3165557625" pattern: ^[0-9]+$ altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). maxLength: 25 pattern: ^[0-9]*$ example: "3165557625" email: type: string description: Email Id of a principal owner of the business. example: "Abc@xxx.com" maxLength: 100 pattern: ^[a-zA-Z0-9!#$&*+/\?`@{|}~^.\-_]+(\.com|\.net|\.org|\.edu)?$ driversLicense: allOf: - $ref: '#/components/schemas/DriversLicense' - type: object properties: number: type: string description: The driver’s license number of the principal owner. Provide this only if you are also providing the country or countrySubdivision fields. If neither the country nor the country subdivision is provided, do not provide this number. maxLength: 35 pattern: ^[A-Za-z0-9-_/ ]*$ example: "123/4567-89" countrySubdivision: type: string description: The two-letter state or province code where the principal owner is located. Only supported for principal owners in the United States or Canada. Use standard two-letter codes, for example - US - CA for California, NY for New York, for Canada - ON for Ontario, QC for Quebec. If the country is not the US or Canada, this field must not be provided. maxLength: 3 pattern: ^[a-zA-Z0-9]*$ example: "BDS" country: type: string description: The three-letter ISO 3166-1 alpha‑3 country code for the principal owner’s driver’s license. Example - USA for United States, CAN for Canada, MEX for Mexico. Required if the driver’s license number (number) is provided. Do not provide this field if the driver’s license number is not provided. minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]*$ example: "AFG" dateOfBirth: type: string description: The date of birth must be provided in the format 'yyyy-MM-dd'. It represents the principal owner of the business birth date. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" nationalId: type: string description: The National ID card number. Leave blank if not in Brazil. maxLength: 35 example: "123456-789" pattern: ^[A-Za-z0-9-]*$ reasonCode: type: string description: The reason code for terminating a merchant, a two digit numeric code indication why a particular merchant was terminated. Allowed values include 01 - Account Data Compromise, 03 - Transaction Laundering, 04 - Excessive Chargebacks, 05 - Excessive Fraud, 06 - Coercion, 08 - Mastercard Questionable Merchant Audit Program, 09 - Liquidation/Insolvency, 10 - Violation of Standards, 12 - PCI Data Security Standard Noncompliance, 13 - Illegal Transactions, 14 - Identity Theft example: '01' maxLength: 2 pattern: ^[0-9]+$ adcEventCaseId: type: string description: Account Data Compromise (ADC) Event Case ID. The value of this field is only required for 01 - ACCOUNT DATA COMPROMISE reason code, for all other reason codes, this field is optional example: ADC-76 maxLength: 20 pattern: ^[a-zA-Z0-9-]+$ AddTerminatedMerchantResp: type: object properties: addMerchantResponse: $ref: '#/components/schemas/AddMerchantResp' AddMerchantResp: type: object properties: merchantReferenceNumber: type: string description: A number assigned by the MATCH Pro system to uniquely identify the newly added merchant. Return of this number indicates a successful merchant addition in the MATCH Pro. example: "1996-250812084304-KJMLJ4I0" name: type: string description: Name of the merchant that was added to the MATCH Pro system as verification of what was added. example: "Merchant" TerminationInquiry: type: object required: - terminationInquiryRequest properties: terminationInquiryRequest: $ref: '#/components/schemas/TerminationInquiryReq' TerminationInquiryReq: required: - acquirerId - merchant type: object properties: acquirerId: type: string pattern: ^[0-9]*$ description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. minLength: 1 maxLength: 11 example: "1996" merchant: $ref: '#/components/schemas/TerminationInquiryMerchant' TerminationInquiryMerchant: required: - name - address - phoneNumber - merchantCategory - principals type: object properties: name: type: string description: The name of the business assigned by the principal owner(s). example: THE BAIT SHOP pattern: ^[a-zA-Z0-9!@#$&*(){}\\`':^_\-;|.+?,\/\[\] ]+$ minLength: 1 maxLength: 255 doingBusinessAsName: type: string description: The name used by a merchant that may differ from the merchant name, such as 'Bait R Us', differs from the merchant name 'The Bait Shop'. example: BAIT R US pattern: ^[a-zA-Z0-9!@#$&*(){}\\`':^_\-;|.+?,\/\[\] ]+$ maxLength: 255 merchantId: type: string description: The identifier assigned to a merchant by an Acquirer. example: 'ABED-1234' pattern: ^[A-Za-z0-9-]+$ maxLength: 25 subMerchantId: type: string description: The Business or Merchant's Sub Merchant Id. example: 'ABED-1234-1' pattern: ^[A-Za-z0-9-]+$ maxLength: 25 address: allOf: - $ref: '#/components/schemas/InquiryAddress' - type: object required: - addressLineOne - city - country properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. minLength: 1 maxLength: 100 example: 42 ELM AVENUE pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 maxLength: 100 pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y pattern: ^[Y|N]$ maxLength: 1 city: type: string description: The name of the city for a merchant location. example: Fayzabad minLength: 1 maxLength: 30 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_ (),-./'+&#?$`]*[a-zA-Z0-9])?$ countrySubdivision: type: string description: The abbreviated state or province code for the merchant's location. Required only for merchants in the United States and Canada. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ country: type: string description: The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. example: AFG minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]+$ postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" minLength: 1 maxLength: 10 phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" minLength: 1 maxLength: 25 pattern: ^[0-9]+$ altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" maxLength: 25 pattern: ^[0-9]+$ merchantCategory: type: string description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant. example: '0742' maxLength: 4 pattern: ^[0-9]+$ nationalTaxId: type: string description: The merchant’s national tax identification number or business registration number. Required for Brazil. example: "NT_123456789/01" maxLength: 35 pattern: ^[A-Za-z0-9-_/. ]*$ countrySubdivisionTaxId: type: string description: The merchant’s state-level tax identification number. example: "12345/0001-23" maxLength: 35 pattern: ^[A-Za-z0-9-_/. ]*$ urls: type: array description: The website address of the merchant. Multiple URLs may be included in a single request. The total combined size of all URLs must not exceed 20,000 bytes. items: maxItems: 100 type: string example: [ 'www.merchant.com' ] maxLength: 1000 pattern: ^(?:(https?|ftp)://)?(?!(10|127)(\.\d{1,3}){3})(?!(169\.254|192\.168)(\.\d{1,3}){2})(?!172\.(1[6-9]|2\d|3[0-1])(\.\d{1,3}){2})((([a-zA-Z0-9\-]+\.)+[a-zA-Z]{2,})|((?!0)(25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d{2}|\d{1,2})){3}))(\:\d{2,5})?(\/[^\s]*)?$ principals: type: array description: The details for the principal owner of the business. A maximum of 5 principals may be submitted. items: $ref: '#/components/schemas/TerminationInquiryPrincipal' searchCriteria: allOf: - $ref: '#/components/schemas/SearchCriteria' - type: object properties: minPossibleMatchCount: type: string description: Determines how many minimum phonetic matches present for a merchant or Inquiry to appear in the results. Value must be between 1 and 9 maxLength: 1 example: "3" InquiryAddress: type: object properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. example: 42 ELM AVENUE addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 city: type: string description: The name of the city for a merchant location. example: Fayzabad isOtherCity: type: string maxLength: 1 description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y countrySubdivision: type: string description: The abbreviated state or province code for the merchant's location. Required only for merchants in the United States and Canada. example: BDS country: type: string description: The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. example: AFG postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" TerminationInquiryPrincipal: type: object required: - firstName - lastName - address - phoneNumber - email properties: firstName: type: string description: The first name of the principal owner of the business. example: DAVID minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9-'. ]+$ middleInitial: type: string description: The middle initial of the name of the principal owner of the business. example: P maxLength: 1 pattern: ^[a-zA-Z0-9]+$ lastName: type: string description: The last name of the principal owner of the business. example: SMITH minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9-'. ]+$ address: $ref: '#/components/schemas/InquiryPrincipalAddress' phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" minLength: 1 maxLength: 25 pattern: ^[0-9]+$ altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" maxLength: 25 pattern: ^[0-9]+$ email: type: string description: Email Id of a principal. example: "Abc@xxx.com" maxLength: 100 pattern: ^[a-zA-Z0-9!#$&*+/\?`@{|}~^.\-_]+(\.com|\.net|\.org|\.edu)?$ driversLicense: allOf: - $ref: '#/components/schemas/DriversLicense' - type: object properties: number: type: string description: The driver’s license number of the principal owner. Provide this only if you are also providing the country or countrySubdivision fields. If neither the country nor the country subdivision is provided, do not provide this number. maxLength: 35 pattern: ^[A-Za-z0-9-_/ ]*$ example: "123/4567-89" countrySubdivision: type: string description: The two-letter state or province code where the principal owner is located. Only supported for principal owners in the United States or Canada. Use standard two-letter codes, for example - US - CA for California, NY for New York, for Canada - ON for Ontario, QC for Quebec. If the country is not the US or Canada, this field must not be provided. maxLength: 3 pattern: ^[a-zA-Z0-9]*$ example: "BDS" country: type: string description: The three-letter ISO 3166-1 alpha‑3 country code for the principal owner’s driver’s license. Example - USA for United States, CAN for Canada, MEX for Mexico. Required if the driver’s license number (number) is provided. Do not provide this field if the driver’s license number is not provided. minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]*$ example: "AFG" dateOfBirth: type: string description: The date of birth must be provided in the format 'yyyy-MM-dd'. It represents the principal owner of the business birth date. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" nationalId: type: string description: National Tax ID is required for Brazil. Leave blank for countries where it is not applicable. example: "123456-789" maxLength: 35 pattern: ^[a-zA-Z0-9-]+$ InquiryPrincipalAddress: type: object required: - addressLineOne - country - city properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. example: 42 ELM AVENUE minLength: 1 maxLength: 100 pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 maxLength: 100 pattern: ^[!@#&\\$\^*_\|:}{\[\]\-=,.'\s/~`A-Za-z0-9()]*$ city: type: string description: The name of the city for a merchant location. example: Fayzabad minLength: 1 maxLength: 30 pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_ (),-./'+&#?$`]*[a-zA-Z0-9])?$ isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y maxLength: 1 pattern: ^[Y|N]$ countrySubdivision: type: string description: The abbreviated state or province code for the merchant's location. Required only for merchants in the United States and Canada. example: BDS maxLength: 3 pattern: ^[a-zA-Z0-9]*$ postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" maxLength: 10 country: type: string description: The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. example: AFG minLength: 3 maxLength: 3 pattern: ^[a-zA-Z0-9]+$ TerminationInquiryMerchantHis: type: object required: - name - phoneNumber - merchantCategory properties: name: type: string description: The name of the business assigned by the principal owner(s). example: THE BAIT SHOP doingBusinessAsName: type: string description: The name used by a merchant that may differ from the merchant name, such as 'Bait R Us', differs from the merchant name 'The Bait Shop'. example: BAIT R US merchantId: type: string description: The identifier assigned to a merchant by an Acquirer. example: 'ABED-1234' nullable: true subMerchantId: type: string description: The Business or Merchant's Sub Merchant Id. example: 'ABED-1234-1' address: allOf: - $ref: '#/components/schemas/InquiryAddress' - type: object required: - addressLineOne - city - country properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. city: type: string description: The name of the city for a merchant location. example: Fayzabad phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" merchantCategory: type: string description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant. example: '0742' nationalTaxId: type: string description: The merchant’s national tax identification number or business registration number. Required for Brazil. example: "NT_123456789/01" countrySubdivisionTaxId: type: string description: The merchant’s state-level tax identification number. example: "12345/0001-23" urls: type: array description: The website address of the merchant. Multiple URLs may be included in a single request. The total combined size of all URLs must not exceed 20,000 bytes. items: maxItems: 100 type: string example: [ 'www.merchant.com' ] maxLength: 1000 principals: type: array description: The details for the principal owner of the business. A maximum of 5 principals may be submitted. items: $ref: '#/components/schemas/Principal' searchCriteria: $ref: '#/components/schemas/SearchCriteria' Merchant: type: object required: - name - merchantId - phoneNumber - merchantCategory - dateOpened - dateClosed - addedByAcquirerId - reasonCodeDesc - createdDate - merchRefNum - reasonCode properties: name: type: string description: The name of the business assigned by the principal owner(s). example: THE BAIT SHOP doingBusinessAsName: type: string description: The name used by a merchant that may differ from the merchant name, such as 'Bait R Us', differs from the merchant name 'The Bait Shop'. example: BAIT R US merchantId: type: string description: The identifier assigned to a merchant by an Acquirer. example: 'ABED-1234' subMerchantId: type: string description: The Business or Merchant's Sub Merchant Id. example: 'ABED-1234-1' address: allOf: - $ref: '#/components/schemas/Address' - type: object required: - addressLineOne - city - isOtherCity - country properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. example: 42 ELM AVENUE city: type: string description: The name of the city for a merchant location. example: Fayzabad phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" merchantCategory: type: string description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant. example: '0742' nationalTaxId: type: string description: The merchant’s national tax identification number or business registration number. Required for Brazil. example: "NT_123456789/01" countrySubdivisionTaxId: type: string description: The merchant’s state-level tax identification number. example: "12345/0001-23" dateOpened: type: string format: date description: The date on which the merchant entered into an agreement with the acquirer must be provided in the format 'yyyy-MM-dd'. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" dateClosed: type: string format: date description: The date opened must be provided in the format yyyy-MM-dd, It represents the date on which the agreement was terminated with the merchant. example: "2021-07-14" reasonCodeDesc: type: string description: The reason code description for terminating a merchant. example: Merchant involved in laundering activity addedByAcquirerId: type: string pattern: ^[0-9]*$ description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. example: "1996" reasonCode: type: string description: The reason code for terminating a merchant, a two digit numeric code indication why a particular merchant was terminated. Allowed values include 01 - Account Data Compromise, 03 - Transaction Laundering, 04 - Excessive Chargebacks, 05 - Excessive Fraud, 06 - Coercion, 08 - Mastercard Questionable Merchant Audit Program, 09 - Liquidation/Insolvency, 10 - Violation of Standards, 12 - PCI Data Security Standard Noncompliance, 13 - Illegal Transactions, 14 - Identity Theft example: "01" createdDate: type: string format: date example: "2021-07-14" description: The created date must be provided in the format 'yyyy-MM-dd', It represents the merchant termination added date in the MATCH Pro. comments: type: string description: Brief comments on why Merchant is added in the MATCH Pro. example: Added for reasons of fraud merchRefNum: type: string description: This is merchant reference number assigned to each merchant record. example: "1996-220406041727-AK45CD85" principals: type: array description: The details for the principal owner of the business. A maximum of 5 principals may be submitted. items: allOf: - $ref: '#/components/schemas/Principal' - type: object required: - dateOfBirth urlGroups: type: array items: $ref: '#/components/schemas/UrlGroup' Address: type: object properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. example: 42 ELM AVENUE addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y city: type: string description: The name of the city for a merchant location. example: Fayzabad countrySubdivision: type: string description: The abbreviated state or province code for the merchant's location. Required only for merchants in the United States and Canada. example: BDS province: type: string description: The name of the province for the merchant location. example: BDS country: type: string description: The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. example: AFG postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" Principal: type: object required: - firstName - lastName - phoneNumber - email properties: firstName: type: string description: The first name of the principal owner of the business. example: DAVID middleInitial: type: string description: The middle initial of the name of the principal owner of the business. example: P lastName: type: string description: The last name of the principal owner of the business. example: SMITH address: allOf: - $ref: '#/components/schemas/PrincipalAddress' - type: object required: - addressLineOne - city - country properties: addressLineOne: type: string description: Line one of the street address for the merchant location. Usually includes street number and name. example: 42 ELM AVENUE city: type: string description: The name of the city for a merchant location. example: Fayzabad phoneNumber: type: string description: The merchant’s business phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" altPhoneNumber: type: string description: The merchant’s business alternate phone number, including area code. - For U.S. numbers - Must be exactly 10 digits and cannot start with 0 or 1. - For non-U.S. numbers - Can be up to 25 digits. Do not include the country code. - Formatting - Digits only. Do not use symbols or formatting characters (e.g., parentheses, spaces, or dashes). example: "3165557625" email: type: string description: Email Id of a principal owner of the business. example: "Abc@xxx.com" driversLicense: $ref: '#/components/schemas/DriversLicense' dateOfBirth: type: string description: The date of birth must be provided in the format 'yyyy-MM-dd'. It represents the principal owner of the business birth date. This field should comply with the ISO 8601 standard date representation. example: "2021-07-14" nullable: true nationalId: type: string description: National Tax ID is required for Brazil. Leave blank for countries where it is not applicable. example: "123456-789" PrincipalAddress: type: object properties: addressLineOne: type: string description: Line one of the street address for the principal owner location. Usually includes street number and name. example: 42 ELM AVENUE addressLineTwo: type: string description: Line two of the street address,usually an apartment number or suite number. example: SUITE 201 isOtherCity: type: string description: If a city is not available in Cities API, the "isOtherCity" field value should be specified as "Y" and If a city is available in the Cities API, the “isOtherCity” field value should be specified as “N” and the city field should be used to pass the name of the city. example: Y city: type: string description: The name of the city for a principal owner location. example: Fayzabad countrySubdivision: type: string description: The abbreviated state or province code for the principal owner's location. Supported only for principal owner's in the United States and Canada. example: BDS province: type: string description: The name of the province for the principal owner location. example: BDS postalCode: type: string description: The postal code for a merchant location. This field is required for merchants in the US and Canada, but optional for other countries. For US postal codes, Must be exactly 5 digits are allowed ^[0-9]*$ . For other countries, including Canada, alphanumeric characters, spaces, and hyphens are allowed ^[A-Za-z0-9- ]*$ and can be up to 10 characters. example: "66579" country: type: string description: The three digit country code of the principal owner. Valid values are three digit alpha country codes as defined in ISO 3166-1. example: AFG PrincipalMatch: type: object description: The principal owner fields with matching code. properties: name: type: string description: The matching code for the principal owner name that has been terminated. example: "M01" address: type: string description: The matching code for the principal owner address. example: "M01" phoneNumber: type: string description: The matching code for the principal owner phone number. example: "M01" altPhoneNumber: type: string description: The matching code for the principal owner alternate phone number. example: "M01" nationalId: type: string description: The matching code for the principal owner social security number. example: "M01" driversLicense: type: string description: The matching code for the principal owner driver's license number.If the principal owner is not from the U.S. Region, then matching code for the principal owner national ID card number. example: "M01" email: type: string description: The matching code for the principal owner email ID. example: "M01" dateOfBirth: type: string description: The matching code for the principal owner date of birth. example: "M01" DriversLicense: type: object properties: number: type: string description: The driver’s license number of the principal owner. Provide this only if you are also providing the country or countrySubdivision fields. If neither the country nor the country subdivision is provided, do not provide this number. example: "123/4567-89" countrySubdivision: type: string description: The two-letter state or province code where the principal owner is located. Only supported for principal owners in the United States or Canada. Use standard two-letter codes, for example - US - CA for California, NY for New York, for Canada - ON for Ontario, QC for Quebec. If the country is not the US or Canada, this field must not be provided. example: "BDS" country: type: string description: The three-letter ISO 3166-1 alpha‑3 country code for the principal owner’s driver’s license. Example - USA for United States, CAN for Canada, MEX for Mexico. Required if the driver’s license number (number) is provided. Do not provide this field if the driver’s license number is not provided. example: "AFG" SearchCriteria: type: object properties: minPossibleMatchCount: type: string description: Determines how many minimum phonetic matches present for a merchant or Inquiry to appear in the results. Value must be between 1 and 9 example: "3" TerminationInquiryDtl: type: object properties: terminationInquiryResponse: $ref: '#/components/schemas/terminationInquiryDTO' terminationInquiryDTO: type: object properties: pageOffset: type: integer description: PageOffset for the Inquiry done. example: 0 ref: type: string description: Reference Number to get the Inquiry. example: "1996-250516085206-J9ZHK5KT" possibleMerchantMatches: type: array description: This is possible terminated merchant match array. items: $ref: '#/components/schemas/PossibleMerchantMatches' merchantPerformanceIndicator: $ref: '#/components/schemas/MerchantPerfIndicators' PossibleMerchantMatches: type: object description: This is possible merchant match object. properties: totalMerchantMatches: type: integer description: The total length of the result set from possible merchant matches of Inquiry. example: 2 terminatedMerchants: type: array description: This is terminated merchant Array. items: $ref: '#/components/schemas/TerminatedMerchantSchemas' TerminatedMerchantSchemas: type: object properties: merchant: $ref: '#/components/schemas/Merchant' merchantMatch: $ref: '#/components/schemas/MerchantMatch' Url: type: object properties: urls: type: array items: type: string description: The URL of Merchant Website. example: [ 'WWW.SHOESHOP.COM' ] UrlGroup: type: object description: This is url group object. properties: exactMatchUrls: $ref: '#/components/schemas/Url' closeMatchUrls: $ref: '#/components/schemas/Url' noMatchUrls: $ref: '#/components/schemas/Url' MerchantMatch: type: object description: The merchant fields with matching code. properties: name: type: string description: The matching code for the merchant name that has been terminated. example: "M01" doingBusinessAsName: type: string description: The matching code for the merchant business name. example: "M01" phoneNumber: type: string description: The matching code for the merchant phone number. example: "M01" address: type: string description: The matching code for the merchant address. example: "M01" altPhoneNumber: type: string description: The matching code for the merchant alternate phone number. example: "M01" countrySubdivisionTaxId: type: string description: The matching code for the merchant state tax ID. example: "M01" nationalTaxId: type: string description: The matching code for the merchant national tax ID. example: "M01" principalMatches: type: array description: This is principal match array. items: $ref: '#/components/schemas/PrincipalMatch' ErrorResponse: type: object required: - Errors properties: Errors: type: object required: - Error properties: Error: $ref: '#/components/schemas/Errors' Errors: type: array minItems: 1 items: $ref: '#/components/schemas/Error' Error: type: object properties: Source: type: string example: "Error Source" description: "The source of the error." ReasonCode: type: string example: "4XX" description: "The reason code for the error." Description: type: string example: "Error description." description: "A detailed description of the error." Recoverable: type: boolean example: false description: "Indicates whether the error is recoverable." Details: type: string example: "Error details." description: "Additional details about the error, often including stack trace information." TerminationInquiryHistoryRes: type: object properties: terminationInquiryHistory: $ref: '#/components/schemas/TerminationInquiryHistory' TerminationInquiryHistory: type: object properties: terminationInquiryRequest: allOf: - $ref: '#/components/schemas/TerminationInquiryReq' - type: object required: - acquirerId properties: acquirerId: type: string description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. example: "1996" merchant: $ref: '#/components/schemas/TerminationInquiryMerchantHis' terminationInquiryResponse: $ref: '#/components/schemas/terminationInquiryDTO' RetroActiveInquiryRes: type: object properties: retroInquiryResponse: type: object properties: possibleMerchantMatches: type: array description: This is possible terminated merchant match array. items: $ref: '#/components/schemas/PossibleMerchantMatches' RetroList: type: object properties: retroInquiryRequest: $ref: '#/components/schemas/RetroInquiryReq' RetroInquiryReq: type: object required: - acquirerId properties: acquirerId: type: string pattern: ^[0-9]*$ description: The Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. minLength: 1 maxLength: 11 example: "1996" RetroInquiry: type: object properties: retroResponse: $ref: '#/components/schemas/RetroListRes' RetroListRes: type: object properties: totalRetroInquiries: type: number description: The count of the total retro inquiries. example: 1234 retroInquiries: type: array description: This is retro Inquiry list data. items: $ref: '#/components/schemas/RetroDetail' RetroDetail: type: object properties: inquiryRefNum: type: string description: The Inquiry reference number of the Inquiry. example: 1996220406041727K485 merchantName: type: string description: The name of the business assigned by the principal owner(s). example: The BAIT SHOP city: type: string description: The city address used by a merchant. example: Fayzabad state: type: string description: The state address used by a merchant. example: BDS country: type: string description: The country name where merchant resides. example: AFG createdDate: type: string format: date example: "2021-07-14" description: The created date must be provided in the format 'yyyy-MM-dd',It represents the retro Inquiry creation date. inquiryCreatedDate: type: string format: date example: "2021-07-14" description: The Inquiry created date must be provided in the format 'yyyy-MM-dd',It represents the Inquiry creation date. acquirerId: type: string example: "1996" description: he Member interbank card association (ICA) number which is used to validate that the application has permission to hit the MATCH Pro database. This number must be obtained from a participating MATCH Pro acquiring bank or entity before a developer can access the MATCH Pro resource. CountriesRes: type: object properties: countries: $ref: '#/components/schemas/Countries' Countries: type: array minItems: 1 items: $ref: '#/components/schemas/Country' Country: type: object properties: countryCode: type: string description: The country code. example: USA regionCode: type: string description: The region code. example: US name: type: string description: Name of the country. example: United States isStatesAvailable: type: boolean description: Flag indicates country has states or not. example: true StateRes: type: object properties: states: $ref: '#/components/schemas/States' States: type: array minItems: 1 items: $ref: '#/components/schemas/State' State: type: object properties: stateCode: type: string description: The state code. example: AK name: type: string description: Name of the state. example: Alaska CityRes: type: object properties: cities: $ref: '#/components/schemas/cities' cities: type: array minItems: 1 items: $ref: '#/components/schemas/City' City: type: string example: "New York" description: City name. MerchantPerfIndicatorsReq: type: object required: - acquirerId - criteria properties: acquirerId: type: string description: The Member ICA number which is used to validate that the application has permission to hit the MATCH database. This number must be obtained from a participating MATCH acquiring bank or entity before a developer can access the MATCH resource. example: "1996" criteria: type: array items: $ref: '#/components/schemas/MerchantPerfIndicatorsCriteria' betweenCriteria: type: array items: $ref: '#/components/schemas/MerchantPerfIndicatorsCriteriaBetween' example: acquirerId: "1996" criteria: - field: "NATIONALTAXID" value: "NT_123456789/01" betweenCriteria: - field: "PI_DATE" operator: "BETWEEN" from: "2026-01" to: "2026-03" MerchantPerfIndicatorsCriteria: type: object description: The search criteria for merchant performance indicators retrieval. required: - field - value properties: field: type: string description: Name of the merchant attribute used as an exact-match filtering criterion. The value must be one of the supported searchable fields for the endpoint. enum: [ 'ACQUIRERID','NATIONALTAXID', 'PI_DATE' ] default: "NATIONALTAXID" example: "NATIONALTAXID" value: type: string description: Search value associated with the specified criterion field. The value must conform to the expected format for the selected field. minLength: 1 example: "NT_123456789/01" MerchantPerfIndicatorsCriteriaBetween: type: object description: | Search field criteria which will be used to get a search list. This schema is for filtering by date using the BETWEEN operator. required: - field - operator - from - to properties: field: type: string description: Name of the attribute on which a range-based filter is applied. Allowed value is PI_DATE. enum: - PI_DATE default: PI_DATE example: PI_DATE operator: type: string description: Logical operator used to evaluate the range condition for the selected field. Allowed value is BETWEEN. enum: - BETWEEN default: BETWEEN example: BETWEEN from: type: string pattern: '^\d{4}-(0[1-9]|1[0-2])$' description: Inclusive lower boundary of the range filter. Format must align with the selected field type. Format must be in ISO 8601 format (YYYY-MM). example: "2026-01" to: type: string pattern: '^\d{4}-(0[1-9]|1[0-2])$' description: Inclusive upper boundary of the range filter. Must be greater than or equal to from. Format must be in ISO 8601 format (YYYY-MM). example: "2026-03" MerchantPerfIndicators: type: object properties: noOfAcquirer: type: integer description: Total number of distinct acquiring institutions associated with the matched merchant records. example: "3" merchants: type: array description: List of merchants matching the search criteria. items: $ref: '#/components/schemas/MerchantDetails' performance: $ref: '#/components/schemas/MerchantPerformance' merchantInquiryTerminationStats: $ref: '#/components/schemas/InquiryTerminationStatsResp' MerchantDetails: type: object properties: firstTransactionDate: type: string description: Earliest transaction date available for the merchant. Format must be in ISO 8601 format (YYYY-MM-DD). example: 2023-01-01 pattern: '^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$' merchantName: type: string description: The name of the Business. example: "THE BAIT SHOP" minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9!@#$&*(){}\\`':^_\-;|.+?,\/\[\] ]+$ businessType: type: string description: Business activity classification associated with the merchant, when available. example: "RETAIL OPERATING COMPANY" maxLength: 255 pattern: ^[A-Z][A-Z0-9 _]*$ recommendedMcc: type: string description: A classification code used in authorization, clearing and other transactions or reports to identify the type of merchant. example: "5814" maxLength: 4 pattern: ^[0-9]+$ recommendedMccDataSource: type: string description: Source used to derive the recommended MCC. example: "CNPJ" pattern: ^[A-Z][A-Z0-9_]*$ recommendedMccDescription: type: string description: The Recommended Merchant category code (MCC) Description. example: "GIFT SHOP" additionalFields: type: array items: $ref: '#/components/schemas/PerformanceIndicatorAdditionalField' description: The list of additional fields that are associated with this merchant. Each additional field provides the name and value for a specific field, such as tax assessment year, legal entity type, etc. PerformanceIndicatorAdditionalField: type: object properties: field: type: string example: "BUSINESS STATUS" description: The name of the additional field, such as tax assessment year, legal entity type, etc. value: type: string example: "ACTIVE" description: The value of the additional field, such as 2024-25 for tax assessment year, partnership for legal entity type, etc. MerchantPerformance: type: object properties: categoryDefinitions: type: array items: $ref: '#/components/schemas/CategoryDef' description: The list of category definitions that are associated with the performance indicators. Each category definition provides the code and label for a specific category, such as card present, card not present, overall etc. indicatorDefinitions: type: array items: $ref: '#/components/schemas/IndicatorDef' description: The list of indicator definitions that are associated with the performance indicators. Each indicator definition provides details about a specific performance indicator, such as gross domestic volume, approval rate, fraud, chargeback etc. indicators: type: array items: $ref: '#/components/schemas/Indicator' description: The list of performance indicators for this merchant. Each indicator provides the category code, indicator type, and the corresponding value for that indicator. compliances: type: array items: $ref: '#/components/schemas/Compliance' description: The list of compliance items associated with this merchant. Each compliance item provides details about a specific compliance program, such as ECM, EFM, BRAM etc. CategoryDef: type: object properties: code: type: string example: cp description: The code of the category, such as cp for card present, cnp for card not present, total for overall. label: type: string example: Card Present description: The label of the category, such as Card Present, Card Not Present, Overall etc. IndicatorDef: type: object properties: type: type: string example: FRAUD description: The type of the indicator, such as GROSS_DOMESTIC_VOLUME, APPROVAL_RATE, FRAUD, CHARGEBACK etc. intervalUnit: type: string example: BASIS_POINTS description: The unit of the interval, such as BASIS_POINTS for fraud and chargeback related indicators, PERCENT for approval rate and gross domestic volume related indicators. intervalType: type: string example: Monthly description: > The type of the interval, such as Monthly, Quarterly, Yearly etc. Transaction Tier can be another type of interval which is based on the gross domestic volume level. Volume tiers are defined as follows: | Tier | Range (R$) | Range ($) | |-------------------------|-----------------------------|---------------------------| | Micro | Up to R$50,000 | Up to $10,000 | | Small | R$50,000 - R$500,000 | $10,000 - $100,000 | | Medium | R$500,000 - R$5,000,000 | $100,000 - $1,000,000 | | Large | R$5,000,000 - R$25,000,000 | $1,000,000 - $5,000,000 | | Corporate/Institutional | Above R$25,000,000 | Above $5,000,000 | recommendedChart: type: string example: BAR description: The recommended chart type for this indicator, such as BAR, LINE, PIE etc. isParent: type: boolean example: true description: Indicates whether this indicator is a parent indicator, which means it has child indicators that provide more detailed insights related to this indicator. childIndicators: type: array items: type: string description: The list of child indicators that are associated with this parent indicator. Each child indicator provides more detailed insights related to the parent indicator. Indicator: type: object properties: type: type: string example: GROSS_DOMESTIC_VOLUME description: The type of the indicator, such as GROSS_DOMESTIC_VOLUME, APPROVAL_RATE, FRAUD, CHARGEBACK etc. categories: type: array items: $ref: '#/components/schemas/Category' description: The list of categories that are associated with this indicator. Each category provides the category code and the corresponding value for that category. Category: type: object properties: code: type: string example: cp description: The code of the category, such as cp for card present, cnp for card not present, total for overall. summary: $ref: '#/components/schemas/Summary' intervalMetrics: type: array items: $ref: '#/components/schemas/IntervalMetric' description: The list of interval metrics that are associated with this category. Each interval metric provides the month, value and performance level for a specific month within the requested month range from the last 24 months. Summary: type: object description: The summary of a specific indicator for a specific category, which includes the value of the indicator and the performance level of the merchant for that indicator and category. properties: min: type: number format: float example: 1.0 description: The minimum value of the indicator for requested month range from the last 24 months. minMonth: type: string pattern: ^\d{4}-(0[1-9]|1[012])$ example: "2024-01" description: The month (in 'YYYY-MM' format) of the minimum value of the indicator for requested month range from the last 24 months. max: type: number format: float example: 1.0 description: The maximum value of the indicator for requested month range from the last 24 months. maxMonth: type: string pattern: ^\d{4}-(0[1-9]|1[012])$ example: "2024-01" description: The month (in 'YYYY-MM' format) of the maximum value of the indicator for requested month range from the last 24 months. avg: type: number format: float example: 1.0 description: The average value of the indicator for requested month range from the last 24 months. IntervalMetric: type: object properties: interval: type: string example: "2024-01" description: Interval value for given indicator and category, such as month in 'YYYY-MM' format for monthly interval type and such as tier (micro|small|medium|large|corporate) for Gross Domestic Volume. value: type: number format: float example: 1.0 description: The value of the indicator for a specific month within the requested month range from the last 24 months. Compliance: properties: programName: type: string enum: [ "ECM", "EFM", "BRAM" ] example: "ECM" description: 'The name of the compliance program. Allowed values are ECP, EFM and BRAM. ECP = Excessive Chargeback Merchant, EFM = Emerging Fraud Monitoring, BRAM = Business Risk Assessment Management.' previousState: type: string enum: [ "Compliant", "Non-Compliant" ] example: "Non-Compliant" description: 'Indicates whether the merchant was compliant with the specified compliance program during the previous month. Allowed values are Compliant, Non-Compliant. "Compliant" means the merchant was compliant, while "Non-Compliant" means the merchant was not compliant.' currentState: type: string enum: [ "Compliant", "Non-Compliant" ] example: "Compliant" description: 'Indicates whether the merchant is compliant with the specified compliance program during the current month. Allowed values are Compliant, Non-Compliant. "Compliant" means the merchant is compliant, while "Non-Compliant" means the merchant is not compliant.' previousReferenceNumber: type: string example: "CASE-1234" description: 'The reference number for the merchant’s previous enrollment in the specified compliance program, if applicable.' pattern: ^[A-Z0-9-]+$ currentReferenceNumber: type: string example: "CASE-5678" description: 'The reference number for the merchant’s current enrollment in the specified compliance program, if applicable.' pattern: ^[A-Z0-9-]+$ additionalFields: type: array items: $ref: '#/components/schemas/PerformanceIndicatorAdditionalField' description: The list of additional fields that are associated with this merchant. Each additional field provides the name and value for a specific field, such as tax assessment year, legal entity type, etc. InquiryTerminationStatsResp: type: object description: Response containing merchant inquiry and termination statistics properties: inquiryStat: $ref: '#/components/schemas/InquiryStat' merchantTerminationStats: type: array description: The merchant terminations statistics. items: $ref: '#/components/schemas/MerchantTerminationStats' InquiryStat: type: object description: Inquiry statistics for given criteria properties: totalInquiries: type: integer format: int32 description: The count of total inquiries for the given criteria. example: 123 intervalType: type: string example: Monthly description: The type of the interval, such as Monthly, Quarterly, Yearly etc. pattern: ^[a-zA-Z]+$ intervalMetrics: type: array items: $ref: '#/components/schemas/IntervalMetric' description: The list of interval metrics that are associated with this category. Each interval metric provides the month, value and performance level for a specific month within the requested month range from the last 24 months. MerchantTerminationStats: type: object description: Termination statistics for a specific date and reason code properties: count: type: integer format: int64 description: The count of total inquiries. example: 1 reason: type: string description: The reason of merchant termination. example: "04 - EXCESSIVE CHARGEBACKS" pattern: ^[A-Z0-9_ -]*$ dateTerminated: type: string pattern: '^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$' description: The date on which merchant got terminated. example: "2025-09-24" MerchantRiskAssessment: type: object properties: merchantProfileRefId: type: string nullable: true description: A Mastercard assigned identifier that uniquely references a merchant profile. example: MPRID-4564742-01ARZ3NDEKTSV4RRFFQ69G5FBW inquiryRefNumber: type: string nullable: true description: The associated Inquiry Reference Number. example: 7fa19080-85f1-4389-8940-5aeaa5b04826 insightId: type: string description: The unique identifier of merchant insight record in the Merchant Risk Assessment. example: 6b018553-96eb-46f1-b45f-72e165512544 merchantRiskScore: $ref: '#/components/schemas/RiskScore' networkAssessment: $ref: '#/components/schemas/NetworkAssessment' digitalPresenceAssessment: $ref: '#/components/schemas/DigitalPresenceAssessment' assessmentStatus: type: string description: Indicates the current state of the merchant insight, specifying whether the risk score calculation is still in progress or has been completed and is available in the Merchant Risk Assessment. Possible values are IN_PROGRESS, FAILED or COMPLETED. example: "COMPLETED" assessmentTimestamp: type: string description: The date and time when the assessment was completed. example: "2026-06-29T07:20:50.52Z" warnings: $ref: '#/components/schemas/Warnings' RiskScore: type: object properties: score: type: number nullable: true description: A score that combines proprietary network data observed across acquirers with digital presence signals that evaluate a prospective merchant’s online footprint, to indicate a merchant’s propensity for fraud at onboarding. example: 0.351 reasonCode: type: string nullable: true description: Reason codes explain the key factors driving a merchant's risk score. example: 'LF, LE, LI' reasonDescription: type: string nullable: true description: Human-readable description of the risk reason code(s). example: 'LF - Low Inquiry Attribute Consistency Risk, LE - Low Inquiry Attribute Completeness Risk, LI - Low Inquiry Attribute Volatility Risk' riskClass: type: string nullable: true description: Categorical risk classification for the merchant. example: 'LOW' NetworkAssessment: type: object required: - inquiryInsights - networkInsights properties: inquiryInsights: $ref: '#/components/schemas/InquiryInsights' networkInsights: $ref: '#/components/schemas/NetworkInsights' InquiryInsights: type: object properties: isValidMerchantPhone: type: boolean nullable: true description: Indicates whether the merchant phone number appears valid. example: true sameMerchantLocationPrincipalLocation: type: number nullable: true description: The fraction of principals who are located in the same general area as the merchant. example: 0 uniqueAcquirersPerMerchantAddress: type: integer nullable: true description: The number of unique acquirers associated with the merchant address in MATCH inquiries over the past 180 days. example: 0 numPerPrincipal: type: integer nullable: true description: The number of MATCH inquiries for the principal name in the past 180 days. example: 0 numPerMerchantPrincipalPair: type: integer nullable: true description: The number of MATCH inquiries for the merchant name and principal name pair in the past 180 days. example: 1 numPerMerchantPhone: type: integer nullable: true description: The number of MATCH inquiries for the merchant phone in the past 180 days. example: 0 numPerMerchantAddress: type: integer nullable: true description: The number of MATCH inquiries for the merchant address in the past 180 days. example: 0 uniqueMerchantPhonePerMerchantAddress: type: integer nullable: true description: The number of unique merchant phone numbers associated with the merchant address in MATCH inquiries over the past 180 days. example: 0 uniqueMerchantAddressPerMerchantPhone: type: integer nullable: true description: The number of unique merchant addresses associated with the merchant phone number in MATCH inquiries over the past 180 days. example: 0 uniqueMerchantPhonePerMerchantPrincipalPair: type: integer nullable: true description: The number of unique merchant phone numbers associated with the merchant name and principal name in MATCH inquiries over the past 180 days. example: 0 NetworkInsights: type: object properties: hasEntityMatch: type: boolean nullable: true description: Indicates whether a matching entity was found in the Mastercard Network based on the merchant or principal phone number, address, email and/or url. example: true entityFirstSeenDays: type: integer nullable: true description: The number of days since the matched entity was first seen on the Mastercard network. example: 197 entityLastSeenDays: type: integer nullable: true description: The number of days since the matched entity was last seen on the Mastercard network. example: 3 entityMCCCount: type: integer nullable: true description: The number of merchant category codes associated with the entity on the Mastercard network. example: 1 entityMerchantCount: type: integer nullable: true description: The number of merchants associated with the entity on the Mastercard network. example: 1 hasMerchantMatch: type: boolean nullable: true description: Indicates whether an exact merchant match was found on the Mastercard network. example: false merchantChargebackRate: type: number nullable: true description: The chargeback rate for the matched merchant over the past 12 months of activity in the Mastercard network. example: 10 merchantRefundRate: type: number nullable: true description: The merchant refund rate for the matched merchant over the past 12 months of activity in the Mastercard network. example: 10 merchantAuthorizationRate: type: number nullable: true description: The merchant authorization approval rate for the matched merchant over the past 12 months of activity in the Mastercard network. example: 10 merchantFirstSeenDays: type: integer nullable: true description: The number of days since the matched merchant was first seen on the Mastercard network. example: 10 merchantLastSeenDays: type: integer nullable: true description: The number of days since the matched merchant was last seen on the Mastercard network. example: 5 merchantNumPastAcquirers: type: integer nullable: true description: The number of acquirers previously associated with the matched merchant over the past 12 months of activity in the Mastercard network. example: 1 DigitalPresenceAssessment: type: object properties: businessInsights: $ref: '#/components/schemas/BusinessInsights' domainInsights: $ref: '#/components/schemas/DomainInsights' websiteInsights: $ref: '#/components/schemas/WebsiteInsights' BusinessInsights: type: object properties: hasSocialMedia: type: boolean nullable: true description: Indicates whether a social media profile was discovered for this merchant. example: true socialMediaEngagement: type: string nullable: true description: The level of social media engagement associated with the business. example: low negativeReviewPresence: type: string nullable: true description: The level of negative review presence associated with the business. example: low hasFootTraffic: type: boolean nullable: true description: Indicates whether physical foot traffic is observed at the business based on online sources. example: false DomainInsights: type: object properties: numAssociatedRedirects: type: integer nullable: true description: The number of domains that redirect into or out of the business site. example: 0 daysSinceRegistration: type: integer nullable: true description: The number of days since the domain was registered. example: 71 hasHijackingProtection: type: boolean nullable: true description: Indicates whether the domain has hijacking protection enabled. example: false isResolvable: type: boolean nullable: true description: Indicates whether the domain can be resolved to a host IP. example: true WebsiteInsights: type: object properties: hasMaliciousActivity: type: boolean nullable: true description: Indicates whether the website has malicious code embedded or has been observed in malicious activity. example: false hasReplicatedContent: type: boolean nullable: true description: Indicates whether replicated or duplicated content was detected on the website. example: false numIPs: type: integer nullable: true description: The number of IP addresses associated with the website. example: 2 hasMinimalContent: type: boolean nullable: true description: Indicates whether the website appears to contain minimal content. example: false hasStrongEncryption: type: boolean nullable: true description: Indicates whether the website's encryption is up to date with industry standards. example: true redirectsToExternalSite: type: boolean nullable: true description: Indicates whether the website automatically redirects visitors to an external site. example: false refundsProhibited: type: boolean nullable: true description: Indicates that a policy is in place which prohibits refunds. example: false Warnings: type: array description: List of warnings generated during the insight processing. example: [] items: $ref: '#/components/schemas/Warning' Warning: type: object description: Represents a single warning encountered during insight processing. properties: code: type: string description: A unique constant identifying the warning case. example: FAILED_NORMALIZATION detail: type: string description: Human-readable details describing the warning. example: "Fields excluded during normalization: altPhoneNumber"