Notifications

Send a notification for merchant

Send a notification on behalf of a specific merchant within an organization. Requires MERCHANT_NOTIFICATIONS_SEND permission.

post/api/v1/organizations/{organizationId}/merchants/{merchantId}/notifications

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/merchants/{merchantId}/notifications
  • Auth: HTTP bearer

Path parameters

merchantIdstring required
Example:mer_def456

Merchant identifier (e.g., 'mer_def456')

organizationIdstring required
Example:org_abc123

Organization identifier (e.g., 'org_abc123')

Request body

merchantIdstring

Merchant ID

typestring required

Notification type

messagestring required

Notification message

channelsstring[] required

Channels to send the notification through

dataobject

Additional data for the notification

Example request

{
  "merchantId": "mer_1234567890",
  "type": "payment_received",
  "message": "Payment of $100 received",
  "channels": [
    "email",
    "whatsapp"
  ],
  "data": {
    "amount": 100,
    "currency": "USD"
  }
}

Response

Notification has been queued for processing

statusstring

Operation status

Example response

{
  "status": "ok"
}

Changes

No recorded changes to this operation across all 1 revision of this API.