Provides status of merchant participation updates
GET {{baseUrl}}/merchants/participations?request_id=7223372036854776000&offset=100&limit=100
Allows registered partners to fetch a list of merchants with participation details whose participation request is completed successfully. If query parameter 'request_id' is supplied then the response will be limited to only those merchant objects with any status (PENDING, COMPLETED, or ERROR) that were part of that particular request. In the case of countries where merchant data is classified as PII, the API response contains encryptedValues field which is encrypted values of merchantLegalName, dbaNames, and address. For countries where merchant data is not classified as PII, the API response contains individual fields, namely merchantLegalName, dbaNames, and address.
Please refer to request and response specification for more details. The encryption needs to be performed using JWE payload encryption. Please refer to the Securing Sensitive Data Using Payload Encryption sections for implementation details.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
request_id | number | The request ID is obtained by calling POST /merchants/participations API. | |
offset | number | Determines the number of items needed in the start of the list, to retrieve the list starting from the offset. | |
limit | number | Controls the maximum number of items in the list. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"merchantLegalName":"Example Mart","countryCode":"USA","acquirerICA":"00689425761","submitterICA":"12689425746","dbaNames":["ACME"],"nonMerchantNegotiatedParticipation":"Y","merchantNegotiatedProductCodes":["ETA","ETB"],"status":"COMPLETED","duns":"879847426","websiteUrl":"https://www.example.com","wallets":[{"walletId":1,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"},{"walletId":2,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"},{"walletId":3,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"}],"address":{"addressLine1":"600 WEST","addressLine2":"SECTOR 5","addressLine3":"SUITE 775","city":"St Peters","state":"QLD","postalCode":"85001"}},{"merchantLegalName":"Example Mart2","countryCode":"USA","acquirerICA":"00689425761","submitterICA":"12689425746","dbaNames":["ACME2"],"nonMerchantNegotiatedParticipation":"Y","merchantNegotiatedProductCodes":["ETA","ETB"],"status":"COMPLETED","duns":"879847436","websiteUrl":"https://www.example.com","wallets":[{"walletId":1,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"},{"walletId":2,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"},{"walletId":3,"walletAcceptance":"Y","walletMerchantId":"235346356234 | 125346356236 | 125446356237"}],"address":{"addressLine1":"600 WEST","addressLine2":"SECTOR 5","addressLine3":"SUITE 775","city":"St Peters","state":"QLD","postalCode":"85001"}}]