Merchant Management API Specification

Merchant Management API

Get Merchant Portal Data

get /merchant-management/merchant-portal-settings/mid/{merchantId}

Get merchant portal settings by merchant ID (MID). Returns portal settings including loyalty program settings and Davo settings if applicable.

Parameters

merchantId required

Type

string

Minimum Length

Example

111222333444555

Example Response

200 OK - Success response.

400 Bad Request - Error response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.

Update Merchant Portal Data

patch /merchant-management/merchant-portal-settings/mid/{merchantId}

Update merchant portal settings by merchant ID (MID). Only fields provided in the request body will be updated; other fields will remain unchanged. To remove optional settings, set their values to null.

Parameters

merchantId required

Type

string

Minimum Length

Example

111222333444555

Request Schema

davoSettings

Type

object

loyaltyProgramSettings

Type

object

portalSettings

Type

object

Example Request

{
  "davoSettings": {
    "id": 0
  },
  "loyaltyProgramSettings": {
    "id": 0
  },
  "portalSettings": {
    "hasOptedOut": false,
    "programLevelId": 4
  }
}

Example Response

200 OK - Success response

400 Bad Request - Error response.

401 Unauthorized - Error response.

403 Forbidden - Error response.

500 Internal Server Error - Error response.