POST/api/v2/loyalty/merchants/{merchantId}/loyalty-rules

Create a new merchant loyalty rule

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
merchantId (path)	unknown	Yes	The unique identifier of the merchant

Request body

application/json

Request body fields
Field	Type	Required
RuleName	string	Yes
PointsPerUnit	unknown	Yes
Multiplier	unknown	No
MinTransactionAmount	unknown	No
MaxTransactionAmount	unknown	No
IsActive	boolean	No
ValidFrom	string (date-time)	No
ValidUntil	string (date-time)	No

Responses

201 — Created

Response 201 fields
Field	Type	Required
Id	unknown	No
RuleName	string	No
PointsPerUnit	unknown	No
Multiplier	unknown	No
MinTransactionAmount	unknown	No
MaxTransactionAmount	unknown	No
IsActive	boolean	No
ValidFrom	string (date-time)	No
ValidUntil	string (date-time)	No
CreatedAt	string (date-time)	No
UpdatedAt	string (date-time)	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/loyalty/merchants/{merchantId}/loyalty-rules" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"RuleName":"…","PointsPerUnit":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.