Merchant Enrollment

POST /api/v3/merchant/retailer-site-enrollment

Creates a new retailer and retailer site under an existing merchant, provisions shield settings for the new site, and notifies operations by email.

---

Authorization

Requirement	Detail
Authorization	Bearer authentication header of the form Bearer <token>

---

Request

Content-Type: application/json

Field	Required	Type	Description
mid	Yes	int	Merchant ID. Provided by payshield
retailer_name	Yes	string	New retailer name
site_name	Yes	string	New retailer site name.
contact_email	No	string	Retailer contact email.
country	No	string	Two-letter country code (e.g. US).
site_url	No	string	Site URL
mcc	No	string	Merchant Category Code
remarks	No	string	Remarks
alert_notification_url	No	string	Url to receive webhook for new alert
token	No	string	Bearer token to be used in webhook
alert_status_update_url	No	string	Url to receive webhook for alert status update
email_for_alert_notification	No	string	Email to receive alert notification. Comma separated if there are more than one.

Example

{
  "mid": 10234,
  "retailer_name": "Acme West Retail",
  "site_name": "Acme West Online",
  "contact_email": "[e-mail]",
  "country": "US",
  "site_url": "https://shop.acmewest.com",
  "mcc": "5411",
  "alert_notification_url": "https://acmewest.com/webhooks/alerts",
  "token": "s3cr3t-token",
  "email_for_alert_notification": "[e-mail]"
}

Response

Success — 200

{
  "status": "ok",
  "rid": 5821,
  "sid": 9043,
  "msg": "Retailer and Site Created"
}

Error — 401

{
  "status": "EXC",
  "code": 401,
  "error_msg": {
    "msg": "retailer_name already exists."
  }
}

---