Submit a batch of merchants to perform Merchant Discovery for.

Request
Security:
st_portal_auth
(write:merchantread:merchant)
query Parameters
sponsorId
integer <int64>

id of the sponsor which should be used to filter list

Example: sponsorId=1
Request Body schema: application/json
Array of objects (MerchantDetail)
callbackUrl
string (CallbackUrl)

The URL that the WRM system will call with the scan results once completed.

callbackAuthSignature
string (CallbackSignature)

An authentication signature that will be provided back to the callbackUrl endpoint once results are ready.

Responses
200

successful operation

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

405

Method Not Allowed. The API was accessed with the wrong method

429

Too Many Requests. The API is rate-limited. Wait and try your request again.

500

Internal Server Error. An unexpected error has occurred. This may be due to a transient error. Retry the request and if the issue persists, please contact support.

503

Service Unavailable. The service is temporarily unavailable. Try your request later.

Callbacks
postAsynchronous response with the results of the merchant discovery lookup process.
post/wrm/v1/merchants/discovery-lookup
Request samples
application/json
{
  • "merchants": [
    ],
  • "callbackUrl": "string",
  • "callbackAuthSignature": "string"
}
Response samples
application/json
{
  • "message": "Field \"name\" cannot be null",
  • "status": 400,
  • "error": "Bad Request",
  • "timestamp": 1413315159949,
  • "exception": "org.springframework.web.server.ResponseStatusException",
  • "path": "/merchants/1"
}
Callback payload samples
POST: Asynchronous response with the results of the merchant discovery lookup process.
application/json
{
  • "merchants": [
    ],
  • "requestStartDate": "2019-08-24",
  • "requestEndDate": "2019-08-24",
  • "jobId": "2019-08-24"
}