API to get the status of the enrollment
GET {{baseUrl}}/merchants?transaction_id=c4c3a330-251f-42cd-8aef-662524215b84&offset=0&limit=4
This API is used to get the information about merchants that are added or deleted through merchants POST endpoint. Due to the large number of merchants in a single transaction, 'transaction_id', 'offset' and 'limit' needs to be provided in the request. Limit should be less than or equal to 1000. This API returns the records that are already processed at the time of calling though the overall status of the upload is still under processing.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
transaction_id | string | (Required) transaction_id is the transactionID that is returned from the addOrDeleteMerchants post response. | |
offset | number | (Required) Offset of the records to be returned. This number must be equal or greater than zero. | |
limit | number | (Required) No. of records to fetch per request. This number should be less than or equal to the configured limit on API side which is 1000. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept-Version | string | (Required) Version of API | |
Accept | string |
RESPONSES
status: OK
{"messageType":"MerchantStatusResponse","totalRecords":1,"offset":1,"limit":1,"transactionID":"dbce6d4f-d632-481f-a413-3e8ac1d49304","processorName":"MPGS","reportStatus":"COMPLETED","successRecords":1,"failedRecords":0,"merchantData":[{"acquirerBIN":"12356","acquirerCID":"10","acquirerICA":"123","acquirerName":"Test Acquirer","deleteReason":"Error due data entry","merchantID":"123","merchantName":"Test Merchant","identityCheckExpress":"Y","status":"Successful","reason":"AcquirerBIN not valid"},{"acquirerBIN":"12356","acquirerCID":"10","acquirerICA":"123","acquirerName":"Test Acquirer","deleteReason":"Error due data entry","merchantID":"123","merchantName":"Test Merchant","identityCheckExpress":"Y","status":"Successful","reason":"AcquirerBIN not valid"}]}