openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 55.9 kB
JSON
{"openapi":"3.0.0","info":{"description":"Helps acquirers identify potentially high-risk merchants before entering to a merchant agreement.","title":"MATCH API","version":"1.0.0","x-artifactId":"match","x-origin":[{"format":"swagger","url":"https://developer.mastercard.com/devzone/api/portal/swagger/match","version":"2.0"}],"x-providerName":"mastercard.com","x-serviceName":"MATCH"},"paths":{"/fraud/merchant/v3/add-merchant":{"post":{"description":"Used by Acquirers to add a terminated a merchant in the MATCH system. Merchant information, and up to five principal owners per merchant, can be provided by an acquiring bank as part of the listing.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTerminatedMerchantRequestSchema"}}},"description":"Body of the Add Terminated Merchant Request","required":true},"responses":{"200":{"description":"The add terminated merchant response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddTerminatedMerchantResponseSchema"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Used by Acquirers to add a terminated a merchant in the MATCH system. Merchant information, and up to five principal owners per merchant, can be provided by an acquiring bank as part of the listing.","tags":["Add Terminated Merchant"],"x-samples":[{"name":"example_add_terminated_merchant","request":{"application/json":"{\n \"AddMerchantRequest\": {\n \"AcquirerId\": \"1996\",\n \"Merchant\": {\n \"Name\": \"TEST TECHMERCHANT1\",\n \"DoingBusinessAsName\": \"TEST TECHMERCHANT1\",\n \"MerchantId\": \"@remember-integer[15]@\",\n \"MerchantCategory\": \"0742\",\n \"Address\": {\n \"Line1\": \"6700 Ben Nevis\",\n \"Line2\": \"\",\n \"City\": \"GLASGOW\",\n \"Province\": \"\",\n \"CountrySubdivision\": \"MA\",\n \"PostalCode\": \"93137\",\n \"Country\": \"USA\"\n },\n \"PhoneNumber\": \"5675542210\",\n \"AltPhoneNumber\": \"5672655441\",\n \"NationalTaxId\": \"56733\",\n \"CountrySubdivisionTaxId\": \"37354\",\n \"CATFlag\": \"N\",\n \"DateOpened\": \"04/12/2009\",\n \"DateClosed\": \"03/19/2013\",\n \"ServiceProvLegal\": \"TEST SVC PRVDER\",\n \"ServiceProvDBA\": \"JNL ASSOC\",\n \"Url\": [\n \"www.testjj.com\",\n \"www.jnltestjj.com\"\n ],\n \"Principal\": {\n \"FirstName\": \"PAUL\",\n \"LastName\": \"HEMINGHOFF\",\n \"MiddleInitial\": \"L\",\n \"Address\": {\n \"Line1\": \"2200 Shepley Drive\",\n \"Line2\": \"SUITE 789\",\n \"City\": \"BROWNSVILLE\",\n \"Province\": \"\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"89022\",\n \"Country\": \"USA\"\n },\n \"PhoneNumber\": \"3906541234\",\n \"AltPhoneNumber\": \"4567390234\",\n \"NationalId\": \"123456789\",\n \"DriversLicense\": {\n \"Number\": \"3K33094\",\n \"CountrySubdivision\": \"MS\",\n \"Country\": \"USA\"\n }\n },\n \"ReasonCode\": \"04\",\n \"Comments\": \"Added for test reasons\"\n }\n }\n}"},"response":{"application/json":"{\n \n}"}}]}},"/fraud/merchant/v3/common/contact-details":{"post":{"description":"Returns the contact information for the acquirer id requested. When MATCH returns a possible merchant match, this resource assists users by retrieving the contact information associated with the Acquirer ID/ICA that added the merchant to MATCH.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactRequestSchema"}}},"description":"The contact request object","required":true},"responses":{"200":{"description":"The acquirer contact response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponseSchema"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Returns the contact information for the acquirer id requested. When MATCH returns a possible merchant match, this resource assists users by retrieving the contact information associated with the Acquirer ID/ICA that added the merchant to MATCH.","tags":["Acquirer Contact Request"],"x-samples":[{"name":"example_contact_details","request":{"application/json":"{\n\n \"ContactRequest\": {\n \"AcquirerId\": \"12086\"\n }\n\n}"},"response":{"application/json":"{\n\n}"}}]}},"/fraud/merchant/v3/retro/retro-inquiry-details":{"post":{"description":"Returns detailed information about Merchants, URLs and up to five principal owners, that have been terminated by an acquiring bank after the inquiry was made. This MATCH resource assists acquirer's ability to consider the merchants terminated after the inquiry was made. If an initial inquiry does not result in a possible match, it is still possible that the merchant listing could appear sometime in the next 360 days. This may occur when another acquirer enters the merchant into the MATCH database. The system will automatically continue to search the MATCH system for 360 days. To view these notifications, acquirers must use the Retroactive Inquiry Summary service. This resource can be used to obtain detailed information, such as, if a Merchant or individual 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.\n","parameters":[{"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.","in":"query","name":"AcquirerId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetroInquiryRequestSchema"}}},"description":"The retro inquiry request object","required":true},"responses":{"200":{"description":"The retroactive inquiry response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetroInquiryResponseSchema"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Returns detailed information about Merchants, URLs and up to five principal owners, that have been terminated by an acquiring bank after the inquiry was made. This MATCH resource assists acquirer's ability to consider the merchants terminated after the inquiry was made. If an initial inquiry does not result in a possible match, it is still possible that the merchant listing could appear sometime in the next 360 days. This may occur when another acquirer enters the merchant into the MATCH database. The system will automatically continue to search the MATCH system for 360 days. To view these notifications, acquirers must use the Retroactive Inquiry Summary service. This resource can be used to obtain detailed information, such as, if a Merchant or individual 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.","tags":["Retroactive Inquiry Details Request"],"x-samples":[{"name":"example_retroactive_inquiry_details","request":{"application/json":"{\n \"AcquirerId\" : \" 1996\",\n \"RetroInquiryRequest\" : {\n \"InquiryReferenceNumber\" : \"19962014090200009\"\n }\n}"},"response":{"application/json":"{\n \n}"}}],"x-testable":false}},"/fraud/merchant/v3/retro/retro-list":{"post":{"description":"Returns the summary of Retro matches for the given Acquirer Id. This resource will return the summary of Retroactive Inquiry matches for the given Acquirer ID/ICA. If an initial inquiry does not result in a possible match, it is still possible that the merchant listing could appear sometime in the next 360 days. This may occur when another acquirer enters the merchant into the MATCH database. The system will automatically continue to search the MATCH system for 360 days. To view these notifications, acquirers must use the Retroactive Inquiry service.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetroRequestSchema"}}},"description":"The retro request object","required":true},"responses":{"200":{"description":"The retroactive request response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetroResponseSchema"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Returns the summary of Retro matches for the given Acquirer Id. This resource will return the summary of Retroactive Inquiry matches for the given Acquirer ID/ICA. If an initial inquiry does not result in a possible match, it is still possible that the merchant listing could appear sometime in the next 360 days. This may occur when another acquirer enters the merchant into the MATCH database. The system will automatically continue to search the MATCH system for 360 days. To view these notifications, acquirers must use the Retroactive Inquiry service.","tags":["Retroactive Inquiry Request"],"x-samples":[{"name":"example_retroactive_inquiry","request":{"application/json":"{\n \"RetroRequest\" : {\n \"AcquirerId\" : \"1996\"\n }\n}"},"response":{"application/json":"{\n \n}"}}],"x-testable":false}},"/fraud/merchant/v3/termination-inquiry":{"post":{"description":"Returns information on merchants that have been terminated and merchants which have been inquired upon. MATCH can provide the acquiring bank with information, such as, if a Merchant or individual 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 (If opted)\n","parameters":[{"description":"The zero-based offset to start at. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the PageLength option this allows pagination to be supported through the service requests.","in":"query","name":"PageOffset","required":true,"example":0,"schema":{"type":"number"}},{"description":"The maximum number of items to retrieve within the current \"page\" of results.","in":"query","name":"PageLength","required":true,"example":10,"schema":{"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminationInquiryRequestSchema"}}},"description":"Body of the Termination Inquiry Request","required":true},"responses":{"200":{"description":"The termination inquiry response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminationInquirySchema"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Returns information on merchants that have been terminated and merchants that have inquired upon. Provides the acquiring bank with information, such as, if a Merchant or individual 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 (if opted).","tags":["TerminationInquiryRequest"],"x-samples":[{"name":"example_termination_inquiry","request":{"application/json":"{\n \"PageOffset\" : \"0\",\n \"PageLength\" : \"10\",\n \"TerminationInquiryRequest\": {\n \"AcquirerId\": \"1996\",\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AltPhoneNumber\": \"3098876333\",\n \"Address\": {\n \"Line1\": \"88 Nounce World\",\n \"Line2\": \"APT 9009\",\n \"City\": \"MICKENVINCE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"66559\",\n \"Country\": \"USA\"\n },\n \"ServiceProvLegal\": \"JJC WORKSHIRE\",\n \"Principal\": \n [\n {\n \"FirstName\": \"PRINCE\",\n \"LastName\": \"HENREY\",\n \"PhoneNumber\": \"9983339923\",\n \"AltPhoneNumber\": \"6365689336\",\n \"Address\": {\n \"Line1\": \"42 ELM AVENUE\",\n \"City\": \"DALLAS\",\n \"CountrySubdivision\": \"IL\",\n \"PostalCode\": \"66579\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \n }\n }],\n \"SearchCriteria\": {\n \"SearchAll\": \"Y\",\n \"MinPossibleMatchCount\": \"1\"\n }\n }\n }\n}"},"response":{"application/json":"{\n \"TerminationInquiry\": {\n \"PageOffset\": 0,\n \"PossibleMerchantMatches\": [\n {\n \"TotalLength\": 14,\n \"TerminatedMerchant\": [\n {\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AddedByAcquirerID\": \"1996\",\n \"AddedOnDate\": \"10/13/2015\",\n \"PhoneNumber\": \"5675543210\",\n \"AltPhoneNumber\": \"5672655441\",\n \"Address\": {\n \"Line1\": \"6700 BEN NEVIS\",\n \"City\": \"GLASGOW\",\n \"CountrySubdivision\": \"MA\",\n \"PostalCode\": \"93137\",\n \"Country\": \"USA\"\n },\n \"CountrySubdivisionTaxId\": \"*****\",\n \"NationalTaxId\": \"*****\",\n \"ServiceProvLegal\": \"TESTXYZ SVC PRVDER\",\n \"ServiceProvDBA\": \"JNL ASSOC\",\n \"Principal\": [\n {\n \"FirstName\": \"PAUL\",\n \"LastName\": \"HEMINGHOFF\",\n \"NationalId\": \"*****\",\n \"PhoneNumber\": \"3906541234\",\n \"AltPhoneNumber\": \"4567390234\",\n \"Address\": {\n \"Line1\": \"2200 SHEPLEY DRIVE\",\n \"Line2\": \"SUITE 789\",\n \"City\": \"BROWNSVILLE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"89022\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \"Number\": \"*****\",\n \"CountrySubdivision\": \"MS\",\n \"Country\": \"USA\"\n }\n }\n ],\n \"UrlGroup\": [\n {\n \"NoMatchUrls\": {\n \"Url\": [\n \"WWW.TESTJJ.COM\",\n \"WWW.JNLTESTJJ.COM\"\n ]\n }\n }\n ],\n \"TerminationReasonCode\": \"04\"\n },\n \"MerchantMatch\": {\n \"Name\": \"M01\",\n \"DoingBusinessAsName\": \"M02\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"CountrySubdivisionTaxId\": \"M00\",\n \"NationalTaxId\": \"M00\",\n \"ServiceProvLegal\": \"M00\",\n \"ServiceProvDBA\": \"M00\",\n \"PrincipalMatch\": [\n {\n \"Name\": \"M00\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"NationalId\": \"M00\",\n \"DriversLicense\": \"M00\"\n }\n ]\n }\n },\n {\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AddedByAcquirerID\": \"1996\",\n \"AddedOnDate\": \"01/20/2016\",\n \"PhoneNumber\": \"5675543210\",\n \"AltPhoneNumber\": \"5672655441\",\n \"Address\": {\n \"Line1\": \"6700 BEN NEVIS\",\n \"City\": \"GLASGOW\",\n \"CountrySubdivision\": \"MA\",\n \"PostalCode\": \"93137\",\n \"Country\": \"USA\"\n },\n \"CountrySubdivisionTaxId\": \"*****\",\n \"NationalTaxId\": \"*****\",\n \"ServiceProvLegal\": \"TESTXYZ SVC PRVDER\",\n \"ServiceProvDBA\": \"JNL ASSOC\",\n \"Principal\": [\n {\n \"FirstName\": \"PAUL\",\n \"LastName\": \"HEMINGHOFF\",\n \"NationalId\": \"*****\",\n \"PhoneNumber\": \"3906541234\",\n \"AltPhoneNumber\": \"4567390234\",\n \"Address\": {\n \"Line1\": \"2200 SHEPLEY DRIVE\",\n \"Line2\": \"SUITE 789\",\n \"City\": \"BROWNSVILLE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"89022\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \"Number\": \"*****\",\n \"CountrySubdivision\": \"MS\",\n \"Country\": \"USA\"\n }\n }\n ],\n \"UrlGroup\": [\n {\n \"NoMatchUrls\": {\n \"Url\": [\n \"WWW.TESTJJ.COM\",\n \"WWW.JNLTESTJJ.COM\"\n ]\n }\n }\n ],\n \"TerminationReasonCode\": \"04\"\n },\n \"MerchantMatch\": {\n \"Name\": \"M01\",\n \"DoingBusinessAsName\": \"M02\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"CountrySubdivisionTaxId\": \"M00\",\n \"NationalTaxId\": \"M00\",\n \"ServiceProvLegal\": \"M00\",\n \"ServiceProvDBA\": \"M00\",\n \"PrincipalMatch\": [\n {\n \"Name\": \"M00\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"NationalId\": \"M00\",\n \"DriversLicense\": \"M00\"\n }\n ]\n }\n }\n ]\n }\n ]\n }\n}"}},{"name":"example_termination_inquiry_documentation","populateDefaults":{"application/json":"{\n \"PageOffset\" : true,\n \"PageLength\" : true,\n \"TerminationInquiryRequest\": {\n \"AcquirerId\": true,\n \"Merchant\": {\n \"Name\": true,\n \"DoingBusinessAsName\": true,\n \"AltPhoneNumber\": true,\n \"Address\": {\n \"Line1\": true,\n \"Line2\": true,\n \"City\": true,\n \"CountrySubdivision\": true,\n \"PostalCode\": true,\n \"Country\": true\n },\n \"ServiceProvLegal\": true,\n \"Principal\":\n {\n \"FirstName\": true,\n \"LastName\": true,\n \"PhoneNumber\": true,\n \"AltPhoneNumber\": true,\n \"Address\": {\n \"CountrySubdivision\": true,\n \"PostalCode\": true,\n \"Country\": true\n }\n }\n ,\n \"SearchCriteria\": {\n \"SearchAll\": true,\n \"MinPossibleMatchCount\": true\n }\n }\n }\n}"},"request":{"application/json":"{\n \"PageOffset\" : \"0\",\n \"PageLength\" : \"10\",\n \"TerminationInquiryRequest\": {\n \"AcquirerId\": \"1996\",\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AltPhoneNumber\": \"3098876333\",\n \"Address\": {\n \"Line1\": \"88 Nounce World\",\n \"Line2\": \"APT 9009\",\n \"City\": \"MICKENVINCE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"66559\",\n \"Country\": \"USA\"\n },\n \"ServiceProvLegal\": \"JJC WORKSHIRE\",\n \"Principal\": [\n {\n \"FirstName\": \"PRINCE\",\n \"LastName\": \"HENREY\",\n \"PhoneNumber\": \"9983339923\",\n \"AltPhoneNumber\": \"6365689336\",\n \"Address\": {\n \"Line1\": \"42 ELM AVENUE\",\n \"City\": \"DALLAS\",\n \"CountrySubdivision\": \"IL\",\n \"PostalCode\": \"66579\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \n }\n }\n ],\n \"SearchCriteria\": {\n \"SearchAll\": \"Y\",\n \"MinPossibleMatchCount\": \"1\"\n }\n }\n }\n}"},"response":{"application/json":"{\n \"TerminationInquiry\": {\n \"PageOffset\": 0,\n \"PossibleMerchantMatches\": [\n {\n \"TotalLength\": 14,\n \"TerminatedMerchant\": [\n {\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AddedByAcquirerID\": \"1996\",\n \"AddedOnDate\": \"10/13/2015\",\n \"PhoneNumber\": \"5675543210\",\n \"AltPhoneNumber\": \"5672655441\",\n \"Address\": {\n \"Line1\": \"6700 BEN NEVIS\",\n \"City\": \"GLASGOW\",\n \"CountrySubdivision\": \"MA\",\n \"PostalCode\": \"93137\",\n \"Country\": \"USA\"\n },\n \"CountrySubdivisionTaxId\": \"*****\",\n \"NationalTaxId\": \"*****\",\n \"ServiceProvLegal\": \"TESTXYZ SVC PRVDER\",\n \"ServiceProvDBA\": \"JNL ASSOC\",\n \"Principal\": [\n {\n \"FirstName\": \"PAUL\",\n \"LastName\": \"HEMINGHOFF\",\n \"NationalId\": \"*****\",\n \"PhoneNumber\": \"3906541234\",\n \"AltPhoneNumber\": \"4567390234\",\n \"Address\": {\n \"Line1\": \"2200 SHEPLEY DRIVE\",\n \"Line2\": \"SUITE 789\",\n \"City\": \"BROWNSVILLE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"89022\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \"Number\": \"*****\",\n \"CountrySubdivision\": \"MS\",\n \"Country\": \"USA\"\n }\n }\n ],\n \"UrlGroup\": [\n {\n \"NoMatchUrls\": {\n \"Url\": [\n \"WWW.TESTJJ.COM\",\n \"WWW.JNLTESTJJ.COM\"\n ]\n }\n }\n ],\n \"TerminationReasonCode\": \"04\"\n },\n \"MerchantMatch\": {\n \"Name\": \"M01\",\n \"DoingBusinessAsName\": \"M02\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"CountrySubdivisionTaxId\": \"M00\",\n \"NationalTaxId\": \"M00\",\n \"ServiceProvLegal\": \"M00\",\n \"ServiceProvDBA\": \"M00\",\n \"PrincipalMatch\": [\n {\n \"Name\": \"M00\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"NationalId\": \"M00\",\n \"DriversLicense\": \"M00\"\n }\n ]\n }\n },\n {\n \"Merchant\": {\n \"Name\": \"XYZTEST XYZTECHMERCHANT\",\n \"DoingBusinessAsName\": \"XYZTEST XYZTECHMERCHANT\",\n \"AddedByAcquirerID\": \"1996\",\n \"AddedOnDate\": \"01/20/2016\",\n \"PhoneNumber\": \"5675543210\",\n \"AltPhoneNumber\": \"5672655441\",\n \"Address\": {\n \"Line1\": \"6700 BEN NEVIS\",\n \"City\": \"GLASGOW\",\n \"CountrySubdivision\": \"MA\",\n \"PostalCode\": \"93137\",\n \"Country\": \"USA\"\n },\n \"CountrySubdivisionTaxId\": \"*****\",\n \"NationalTaxId\": \"*****\",\n \"ServiceProvLegal\": \"TESTXYZ SVC PRVDER\",\n \"ServiceProvDBA\": \"JNL ASSOC\",\n \"Principal\": [\n {\n \"FirstName\": \"PAUL\",\n \"LastName\": \"HEMINGHOFF\",\n \"NationalId\": \"*****\",\n \"PhoneNumber\": \"3906541234\",\n \"AltPhoneNumber\": \"4567390234\",\n \"Address\": {\n \"Line1\": \"2200 SHEPLEY DRIVE\",\n \"Line2\": \"SUITE 789\",\n \"City\": \"BROWNSVILLE\",\n \"CountrySubdivision\": \"MO\",\n \"PostalCode\": \"89022\",\n \"Country\": \"USA\"\n },\n \"DriversLicense\": {\n \"Number\": \"*****\",\n \"CountrySubdivision\": \"MS\",\n \"Country\": \"USA\"\n }\n }\n ],\n \"UrlGroup\": [\n {\n \"NoMatchUrls\": {\n \"Url\": [\n \"WWW.TESTJJ.COM\",\n \"WWW.JNLTESTJJ.COM\"\n ]\n }\n }\n ],\n \"TerminationReasonCode\": \"04\"\n },\n \"MerchantMatch\": {\n \"Name\": \"M01\",\n \"DoingBusinessAsName\": \"M02\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"CountrySubdivisionTaxId\": \"M00\",\n \"NationalTaxId\": \"M00\",\n \"ServiceProvLegal\": \"M00\",\n \"ServiceProvDBA\": \"M00\",\n \"PrincipalMatch\": [\n {\n \"Name\": \"M00\",\n \"Address\": \"M00\",\n \"PhoneNumber\": \"M00\",\n \"AltPhoneNumber\": \"M00\",\n \"NationalId\": \"M00\",\n \"DriversLicense\": \"M00\"\n }\n ]\n }\n }\n ]\n }\n ]\n }\n}"},"type":"documentation"}]}},"/fraud/merchant/v3/termination-inquiry/{IRN}":{"get":{"description":"Returns information about Merchants, URLs and up to five principal owners, that have been terminated by an acquiring bank from a previous inquiry. The Inquiry History Results resource displays the inquiry with the option to view either; Possible Merchant Matches or Possible Inquiry Matches.\n","parameters":[{"description":"The zero-based offset to start at. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the PageLength option this allows pagination to be supported through the service requests.","in":"query","name":"PageOffset","required":true,"example":0,"schema":{"type":"number"}},{"description":"The maximum number of items to retrieve within the current \"page\" of results.","in":"query","name":"PageLength","required":true,"example":10,"schema":{"type":"number"}},{"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.","in":"query","name":"AcquirerId","required":true,"example":1996,"schema":{"type":"string"}},{"description":"Inquiry Reference Number (IRN) A unique identifier generated by the MATCH 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.","in":"path","name":"IRN","required":true,"example":19962016070500348,"schema":{"type":"string"}}],"responses":{"200":{"description":"The termination inquiry history response object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminationInquirySchema"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorsResponse"}}}}},"summary":"Returns information about Merchants, URLs and up to five principal owners, that have been terminated by an acquiring bank from a previous inquiry. The Inquiry History Results resource displays the inquiry with the option to view either; Possible Merchant Matches or Possible Inquiry Matches.","tags":["Termination Inquiry History Request"],"x-samples":[{"name":"example_termination_history_inquiry","request":{"application/json":"{\n \"IRN\" : \"19962016070500348\",\n \"AcquirerId\" : \"1996\",\n \"PageOffset\" : \"0\",\n \"PageLength\" : \"10\"\n}\n inquiry/19962016070500348?id=&AcquirerId=1996&PageOffset=0&PageLength=10"},"response":{"application/json":"{\n \n}"}}],"x-testable":false}}},"servers":[{"url":"https://api.mastercard.com"}],"components":{"schemas":{"AddMerchantMerchant":{"properties":{"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number.","example":"6367558968","type":"string"},"CATFlag":{"description":"Cardholder-activated terminal indicator.","example":"Y","type":"string","x-explorer":true},"Comments":{"description":"Brief comments on why Merchant is added","example":"Added for reasons of fraud","type":"string"},"CountrySubdivisionTaxId":{"description":"The Merchant's state tax ID; for the U.S region only. Return value will be hidden.","example":"*****","type":"string","x-explorer":true},"DateClosed":{"description":"Date the agreement was terminated with the merchant","example":"10/12/2014","type":"string","x-explorer":true},"DateOpened":{"description":"Date the merchant entered into agreement with the acquirer","example":"12/31/2013","type":"string","x-explorer":true},"DoingBusinessAsName":{"description":"The name used by a merchant that could be different from the legal name of the business. Such as Bait R Us instead of the legal name, The Bait Shop","example":"BAIT R US","type":"string"},"MerchantCategory":{"description":"A classification code used in authorization, clearing, and other transactions or reports to identify the type of merchant.","example":"0742","type":"string","x-explorer":true},"MerchantId":{"description":"The identifier assigned to a merchant by an Acquirer. An Acquirer Id and Merchant Id combination must be unique.","example":"@random-string[14]@","type":"string","x-explorer":true},"Name":{"description":"The name of the Business which has been terminated.","example":"THE BAIT SHOP","type":"string","x-explorer":true},"NationalTaxId":{"description":"The National tax ID or business registration number. Return value will be hidden.","example":"*****","type":"string"},"PhoneNumber":{"description":"The Business or Merchant's phone number.","example":"6367558963","type":"string","x-explorer":true},"Principal":{"$ref":"#/components/schemas/Principal"},"ReasonCode":{"description":"A two digit numeric code indication why a particular merchant was terminated. 01 Account Data Compromise, 02 Common Points of Purchase, 03 Laundering, 04 Excessive Chargebacks, 05 Excessive Fraud, 06 Reserved for Future Use, 07 Fraud Conviction, 08 MasterCard Questionable Merchant Audit Program, 09 Bankruptcy/Liquidation/Insolvency, 10 Violation of MasterCard Standards, 11 Merchant collusion, 12 PCI Data Security Standard, Noncompliance, 13 Illegal Transactions, 14 Identity Theft","example":"13","type":"string","x-explorer":true},"ServiceProvDBA":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE","type":"string"},"ServiceProvLegal":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE INCORPORATED","type":"string"},"Url":{"items":{"description":"Website address of the merchant. A request may include multiple URLs . The total cumulative size of the URLs cannot exceed 20000 bytes.","example":"www.testmerchant.com ","type":"string"},"type":"array"}},"required":["MerchantId","Name","CountrySubdivisionTaxId","CATFlag","PhoneNumber","ReasonCode","MerchantCategory","DateOpened","DateClosed"]},"AddMerchantRequest":{"properties":{"AcquirerId":{"description":"The ID of the acquirer.","example":1996,"type":"string","x-explorer":true},"Merchant":{"$ref":"#/components/schemas/AddMerchantMerchant"}},"required":["AcquirerId"]},"AddMerchantResponse":{"properties":{"MerchantReferenceNumber":{"description":"A number assigned by the MATCH system to uniquely identify the newly added merchant. Return of this number indicates a successful add.","example":"19962015072000000","type":"string"},"Name":{"description":"Name of the merchant that was added to the MATCH system as verification of what was added.","example":"XYZTEST XYZTECHMERCHANT","type":"string"}}},"AddTerminatedMerchantRequestSchema":{"properties":{"AddMerchantRequest":{"$ref":"#/components/schemas/AddMerchantRequest"}}},"AddTerminatedMerchantResponseSchema":{"properties":{"AddMerchantResponse":{"$ref":"#/components/schemas/AddMerchantResponse"}}},"Address":{"properties":{"City":{"description":"The name of the city for a merchant location.","example":"DALLAS","type":"string","x-explorer":true},"Country":{"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":"USA","type":"string","x-explorer":true},"CountrySubdivision":{"description":"The abbreviated state or province code for a merchant location (only supported for US and Canada merchants).","example":"IL","type":"string","x-explorer":true},"Line1":{"description":"Line 1 of the street address for the merchant location. Usually includes street number and name.","example":"42 ELM AVENUE","type":"string","x-explorer":true},"Line2":{"description":"Line 2 of the street address,usually an apartment number or suite number.","example":"SUITE 201","type":"string"},"PostalCode":{"description":"The postal code for a merchant location (only supported for US and Canada merchants).","example":"66579","type":"string","x-explorer":true},"Province":{"description":"The name of the province for the location.","example":"","type":"string"}},"required":["Country","Line1","City","PostalCode","CountrySubdivision"]},"Contact":{"properties":{"BankName":{"description":"The name of acquiring bank.","example":"THE XYZ BANK","type":"string"},"EmailAddress":{"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","type":"string"},"FaxNumber":{"description":"The Fax Number of primary contact of acquiring bank. The results may return information for more than one Contact.","example":"6360000001","type":"string"},"FirstName":{"description":"The first name of primary contact of acquiring bank. The results may return information for more than one Contact.","example":"JACK","type":"string"},"LastName":{"description":"The last name of primary contact of acquiring bank. The results may return information for more than one Contact.","example":"SMITH","type":"string"},"PhoneNumber":{"description":"The Phone Number of primary contact of acquiring bank. The results may return information for more than one Contact.","example":"6360000000","type":"string"},"Region":{"description":"The region of acquiring bank. The results may return information for more than one Contact.","example":"UNITED STATES","type":"string"}}},"ContactRequest":{"properties":{"AcquirerId":{"description":"The acquiring bank ICA number whose contact information is to be fetched.","example":"12086","type":"string","x-explorer":true}},"required":["AcquirerId"]},"ContactRequestSchema":{"properties":{"ContactRequest":{"$ref":"#/components/schemas/ContactRequest"}}},"ContactResponse":{"properties":{"Contact":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}},"ContactResponseSchema":{"properties":{"ContactResponse":{"$ref":"#/components/schemas/ContactResponse"}}},"DriversLicense":{"properties":{"Country":{"description":"The three digit country code of the principal owner. Valid values are Three digit alpha country codes as defined in ISO 3166-1. Required when Drivers License Number is provided. Should not be provided if Drivers License Number is not provided.","example":"USA","type":"string"},"CountrySubdivision":{"description":"The abbreviated state or province code for a merchant location (only supported for US and Canada merchants). Required when Drivers License Country is 'USA' . Should not be provided for non-US Drivers License Country.","example":"IL","type":"string"},"Number":{"description":"The drivers license number of a principal owner.","example":"M15698025","type":"string"}}},"Error":{"properties":{"Description":{"description":"This is the text description of the error. This is optional and will only be displayed if more information is available than is stored in the data identifier and reason code.","example":"Unauthorized Access","type":"string"},"ReasonCode":{"description":"This will identify the reason for the error.","example":"AUTHENTICATION_FAILED","type":"string"},"Recoverable":{"description":"This is a true/false presentation to explain if the transaction was submitted again would it be successful or not.","example":true,"type":"boolean"},"Source":{"description":"This is the unique identifier that attempts to define the field in error when available. If a specific field cant be identified System will be returned.","example":"System","type":"string"}}},"Errors":{"properties":{"Error":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}}},"ErrorsResponse":{"properties":{"Errors":{"$ref":"#/components/schemas/Errors"}}},"InquiredMerchant":{"properties":{"Merchant":{"properties":{"AddedByAcquirerID":{"description":"The Member ICA that has added the merchant to the MATCH system","example":"1234","type":"string"},"AddedOnDate":{"description":"The date on which the merchant was added to the MATCH system. Format MM/DD/YYYY","example":"12/03/2009","type":"string"},"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number.","example":"6367558968","type":"string"},"CountrySubdivisionTaxId":{"description":"The Merchant's state tax ID; for the U.S region only. Return value will be hidden.","example":"*****","type":"string"},"DoingBusinessAsName":{"description":"The name used by a merchant that could be different from the legal name of the business. Such as Bait R Us instead of the legal name, The Bait Shop","example":"BAIT R US","type":"string"},"MerchantMatch":{"$ref":"#/components/schemas/MerchantMatch"},"Name":{"description":"The name of the Business which has been terminated.","example":"THE BAIT SHOP","type":"string"},"NationalTaxId":{"description":"The National tax ID or business registration number. Return value will be hidden.","example":"*****","type":"string"},"PhoneNumber":{"description":"The Business or Merchant's phone number.","example":"6367558963","type":"string"},"Principal":{"$ref":"#/components/schemas/Principal"},"ServiceProvDBA":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE","type":"string"},"ServiceProvLegal":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE INCORPORATED","type":"string"},"TerminationReasonCode":{"description":"A two digit numeric code indication why a particular merchant was terminated. 01 Account Data Compromise, 02 Common Points of Purchase, 03 Laundering, 04 Excessive Chargebacks, 05 Excessive Fraud, 06 Reserved for Future Use, 07 Fraud Conviction, 08 MasterCard Questionable Merchant Audit Program, 09 Bankruptcy/Liquidation/Insolvency, 10 Violation of MasterCard Standards, 11 Merchant collusion, 12 PCI Data Security Standard, Noncompliance, 13 Illegal Transactions, 14 Identity Theft","example":"13","type":"string"},"UrlGroup":{"$ref":"#/components/schemas/UrlGroup"}}}}},"Merchant":{"properties":{"AddedByAcquirerID":{"description":"The Member ICA that has added the merchant to the MATCH system","example":"1234","type":"string"},"AddedOnDate":{"description":"Date the merchant was added to the MATCH database.","example":"10/13/2015","type":"string"},"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number, including the area code. Within the USA, phone numbers have a length of 10, and for out outside the US, a max length of 25. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The number must be digits only, with no format characters such as parenthesis or dashes.","example":"3165557625","type":"string"},"CountrySubdivisionTaxId":{"description":"The Merchant Country Subdivision tax ID, leave blank if not in the U.S region.","example":"492321030","type":"string"},"DoingBusinessAsName":{"description":"The name used by a merchant that could be different from the legal name of the business. Such as Bait R Us instead of the legal name, The Bait Shop.","example":"BAIT R US","type":"string"},"Name":{"description":"The name of the business assigned by the principal owner(s)","example":"THE BAIT SHOP","type":"string"},"NationalTaxId":{"description":"The Merchant national tax ID, leave blank if not in the U.S region.","example":"888596927","type":"string"},"PhoneNumber":{"description":"The Business or Merchant's phone number, including the area code. Within the USA, phone numbers have a length of 10, and for outside the US, it can be any length with a maximum of 12 digits. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The phone number must be digits only, with no format characters such as parenthesis or dashes.","example":"3165557625","type":"string"},"Principal":{"description":"The details for the principal owner of the business. A maximum of 5 principals may be submitted.","items":{"$ref":"#/components/schemas/Principal"},"type":"array"},"SearchCriteria":{"$ref":"#/components/schemas/SearchCriteria"},"ServiceProvDBA":{"description":"The name of the service provider associated with the merchant listed in the MATCH","example":"XYZ FINANCIAL SERVICE","type":"string"},"ServiceProvLegal":{"description":"The name of the service provider associated with the merchant listed in the MATCH","example":"XYZ FINANCIAL SERVICE INCORPORATED","type":"string"},"TerminationReasonCode":{"description":"A two digit numeric code indication why a particular merchant was terminated. 01 Account Data Compromise, 02 Common Points of Purchase, 03 Laundering, 04 Excessive Chargebacks, 05 Excessive Fraud, 06 Reserved for Future Use, 07 Fraud Conviction, 08 MasterCard Questionable Merchant Audit Program, 09 Bankruptcy/Liquidation/Insolvency, 10 Violation of MasterCard Standards, 11 Merchant collusion, 12 PCI Data Security Standard, Noncompliance, 13 Illegal Transactions, 14 Identity Theft","example":"13","type":"string"},"Url":{"description":"Website address of the merchant. A request may include multiple URLs. The total cumulative size of the URLs cannot exceed 20,000 bytes.","example":"WWW.TESTMERCHANT.COM","type":"string"},"UrlGroup":{"items":{"$ref":"#/components/schemas/UrlGroup"},"type":"array"}},"required":["Name"]},"MerchantMatch":{"properties":{"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number.","example":"6367558968","type":"string"},"CountrySubdivisionTaxId":{"description":"The Merchant's state tax ID; for the U.S region only. Return value will be hidden.","example":"*****","type":"string"},"DoingBusinessAsName":{"description":"The name used by a merchant that could be different from the legal name of the business. Such as Bait R Us instead of the legal name, The Bait Shop","example":"BAIT R US","type":"string"},"Name":{"description":"The name of the Business which has been terminated.","example":"THE BAIT SHOP","type":"string"},"NationalTaxId":{"description":"The National tax ID or business registration number. Return value will be hidden.","example":"*****","type":"string"},"PhoneNumber":{"description":"The Business or Merchant's phone number.","example":"6367558963","type":"string"},"PrincipalMatch":{"items":{"$ref":"#/components/schemas/PrincipalMatch"},"type":"array"},"ServiceProvDBA":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE","type":"string"},"ServiceProvLegal":{"description":"The name of the service provider associated with the merchant listed in the MATCH.","example":"XYZ FINANCIAL SERVICE INCORPORATED","type":"string"}}},"PossibleInquiryMatches":{"properties":{"InquiredMerchant":{"items":{"$ref":"#/components/schemas/InquiredMerchant"},"type":"array"},"TotalLength":{"description":"The total length of the result set from possible merchant matches of inquiry.","example":"2","type":"string"}}},"PossibleMerchantMatches":{"properties":{"TerminatedMerchant":{"items":{"$ref":"#/components/schemas/TerminatedMerchant"},"type":"array"},"TotalLength":{"description":"The total length of the result set from possible merchant matches of inquiry.","example":"2","type":"string"}}},"Principal":{"properties":{"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number, including the area code. Within the USA, phone numbers have a length of 10, and for out outside the US, a max length of 25. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The number must be digits only, with no format characters such as parenthesis or dashes.","example":"3165557625","type":"string"},"DriversLicense":{"$ref":"#/components/schemas/DriversLicense"},"FirstName":{"description":"The first name of the principal owner of the business.","example":"DAVID","type":"string","x-explorer":true},"LastName":{"description":"The last name of the principal owner of the business.","example":"SMITH","type":"string","x-explorer":true},"MiddleInitial":{"description":"THe middle initial of the name of the principal owner of the business.","example":"P","type":"string"},"NationalId":{"description":"The Social Security number of a principal owner. If the principal owner is not from the U.S. Region, then use their national ID card number.","example":"541022104","type":"string"},"PhoneNumber":{"description":"The Business or Merchant's phone number, including the area code. Within the USA, phone numbers have a length of 10, and for outside the US, it can be any length with a maximum of 12 digits. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The phone number must be digits only, with no format characters such as parenthesis or dashes.","example":"3165557625","type":"string"},"SearchCriteria":{"$ref":"#/components/schemas/SearchCriteria"}},"required":["FirstName","LastName"]},"PrincipalMatch":{"properties":{"Address":{"$ref":"#/components/schemas/Address"},"AltPhoneNumber":{"description":"The Business or Merchant's alternate phone number, including the area code. Within the USA, phone numbers have a length of 10, and for out outside the US, a max length of 25. Within the U.S. phone numbers can not start with 0 or 1. If the number is outside the U.S. region; do not include the country code. The number must be digits only, with no format characters such as parenthesis or dashes.","example":"3165557625","type":"string"},"DriversLicense":{"$ref":"#/components/schemas/DriversLicense"},"FirstName":{"description":"The first name of the pri