Qodex.ai

Get a list of sub-merchants.

GET {{baseUrl}}/alerts/merchants/:member_id/sub-merchants?name=TEST&offset=25&page_number=1

Returns sub-merchants matching multiple criteria.

Request Params

KeyDatatypeRequiredDescription
namestring(Required) Merchant's name
statusstringMerchant's status
offsetnumberNumber of items per page
page_numbernumberCurrent page number

HEADERS

KeyDatatypeRequiredDescription
User-Idstring(Required) The user id of the submitter/technical contact.
Submitter-First-Namestring(Required) The first name of the submitter/technical contact.
Submitter-Last-Namestring(Required) The last name of the submitter/technical contact.
Acceptstring

RESPONSES

status: OK

{"responseHeader":{"totalRecords":500,"totalPages":10,"currentPage":2,"responseTime":"300 ms"},"subMerchants":[{"subMerchantId":"99ca4b15-72a6-41dd-8127-573d4b07669c","name":"Merchant 1","merchantType":"SUBMERCHANT","status":"ACTIVATED","parentMemberId":"99ca4b15-72a6-41dd-8127-573d4b07669c","merchantCategoryCode":"3002","createdBy":{"timestamp":"2023-04-28T10:30:00.000Z","user":"John Doe"},"modifiedBy":{"timestamp":"2023-04-28T10:30:00.000Z","user":"John Doe"},"statusUpdateTs":"2023-04-28T10:30:00.000Z"},{"subMerchantId":"22ca4b15-72a6-41dd-8127-573d4b07662c","name":"Merchant 2","merchantType":"SUBMERCHANT","status":"ACTIVATED","parentMemberId":"99ca4b15-72a6-41dd-8127-573d4b07669c","merchantCategoryCode":"3003","createdBy":{"timestamp":"2023-02-02T10:30:00.000Z","user":"John Doe"},"modifiedBy":{"timestamp":"2023-02-02T10:30:00.000Z","user":"John Doe"},"statusUpdateTs":"2023-02-02T10:30:00.000Z"}]}