Initiate Merchant Query
Submit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.
This method validates the data in your request.
This is the first step in the process of querying the card networks about a potential new merchant. When this step is completed successfully, proceed to Retrieve Query Results.
partner_merchant_reference
ID of the merchant, defined by the partner.
Length: 0-60
Regex:
string/^[\w\s\!\@\#\$\%\^\&\*\(\)\_\+\-\=\[\]\{\}\;\:\'\"\,\.\/\\\?]{0,60}$/
queried_merchant
Information about the merchant who is the subject of the query.
search_criteria
Specifies search criteria for the query.
operation_id
ID of the query request operation. UUID.
/v1/cnl/termination_query
Initiate Merchant Query - Valid Request
curl -X post https://sandboxapi.rapyd.net/v1/cnl/termination_query -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -d '{ "partner_merchant_reference": "ABCDEFGH", "partner_query_reference": "12345678", "search_criteria": { "search_area": "global" }, "queried_merchant": { "legal_name": "Four Star Market, Ltd.", "dba_name": "Four Star Market", "address": { "address_line_1": "123 Main Street", "address_line_2": "", "city": "London", "country": "GB", "postal_code": "12345" }, "phone_numbers": [ "+445555555555" ], "business_category": "Merchant", "principals": [{ "first_name": "John", "middle_initial": "A", "last_name": "Doe", "email": "john.doe@fourstarmarket.net", "address": { "address_line_1": "123 First Street", "address_line_2": "", "postal_code": "12345", "city": "London", "country": "GB" }, "phone_number": "+449999999999" } ], "is_ecommerce": false, "email": "service@fourstarmarket.com", "url": [ "https://fourstarmarket.com" ] } } '
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "4998cec5-72ac-46d7-b3bd-65bd631a4e78" }, "data": { "status": "IN_PROGRESS", "operation_id": "4998cec5-72ac-46d7-b3bd-65bd631a4e78", "partner_query_reference": "12345678", "partner_merchant_reference": "ABCDEFGH" } }
Initiate Merchant Query - Invalid Request: Empty search_criteria
curl -X post https://sandboxapi.rapyd.net/v1/cnl/termination_query -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here' -d '{ "partner_merchant_reference": "ABCDEFGH", "partner_query_reference": "12345678", "search_criteria": {}, "queried_merchant": { "legal_name": "Four Star Market, Ltd.", "dba_name": "Four Star Market", "address": { "address_line_1": "123 Main Street", "address_line_2": "", "city": "London", "country": "GB", "postal_code": "12345" }, "phone_numbers": [ "+445555555555" ], "business_category": "Merchant", "principals": [{ "first_name": "John", "middle_initial": "A", "last_name": "Doe", "email": "john.doe@fourstarmarket.net", "address": { "address_line_1": "123 First Street", "address_line_2": "", "postal_code": "12345", "city": "London", "country": "GB" }, "phone_number": "+449999999999" } ], "is_ecommerce": false, "email": "service@fourstarmarket.com", "url": [ "https://fourstarmarket.com" ] } } '
{ "status": { "error_code": "INVALID_FIELDS", "status": "ERROR", "message": "The request attempted an operation, but one of the fields contained a value that is not valid. The request was rejected. Corrective action: The name of the field appears at the end of the response code. Use a valid value.", "response_code": "INVALID_FIELDS - [SEARCH_CRITERIA]", "operation_id": "28d623d8-89dd-43b7-aac4-4d07aea25072" } }