Payments API ReferenceNotifications

Send a notification for merchant

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

Path parameters

merchantIdstringRequired

Merchant identifier (e.g., ‘mer_def456’)

organizationIdstringRequired

Organization identifier (e.g., ‘org_abc123’)

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
typestringRequired
Notification type
messagestringRequired
Notification message
channelslist of enumsRequired
Channels to send the notification through
merchantIdstringOptional
Merchant ID
datamap from strings to anyOptional
Additional data for the notification

Response

Notification has been queued for processing
statusstring or null
Operation status

Errors