Payments API ReferenceNotifications

Send a notification to authenticated user

Send a notification to the currently authenticated user. No additional permissions required beyond authentication.

Authentication

AuthorizationBearer

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
Operation status

Errors

400
Send to User Request Bad Request Error
401
Send to User Request Unauthorized Error
422
Send to User Request Unprocessable Entity Error
500
Send to User Request Internal Server Error