API Reference

Clients can use the Notification API to send notifications to end-users using different channels.

Notification delivery is currently limited to SMS only.

Notifications API

The Notifications API is used to send notifications to end-users via different channels.

Notifications API

post

The notification API may be used by clients to send notifications to their customers using different channels

Authorizations

BearerAuth & X-API-Ke

Body

application/json

channelRouteIdstringOptional

destinationIdentifierstring · max: 128Required

The unique identifier for the intended recipient (or target/destination) of the notification message. If the channel is SMS then the identifier should be a MSISDN in international format, no leading zeros or + symbol.

Example: 2341234567899Pattern: ^[0-9]*$

channelIdinteger · int32 · max: 2Required

The platform through which the message will be delivered to the end user, currently on the SMS channel is available

Example: 6

messagestring · max: 1024Required

The notification message

Example: MSG test

transactionRefstring · max: 64Required

Unique reference to the transaction the notification is linked to.

Example: seo8w3-3wsf8c-ffdd34-f58l

clientNotificationRefstring · max: 64Required

Unique reference generated by the client for the notification, i.e. UUID format

Example: 1111-2222-3333-1230

clientIdinteger · int32 · max: 20Required

This is your unique client ID assigned by Clickatell during the integration process

Example: 200

sourceIdentifierstring · max: 64Required

The unique identifier for the source, as recognized by the bank. This is typically the mobile phone number (MSISDN) but can be another unique identifier recognised by the bank.

Example: 2341234567899

Responses

202

Successful response

application/json

400

Error response

application/json

post

/notification-api/1.0

HTTPcURLJavaScriptPython

POST /apiman-gateway/PaydServices/notification-api/1.0 HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "channelRouteId": "text",
  "destinationIdentifier": "2341234567899",
  "channelId": 6,
  "message": "MSG test",
  "transactionRef": "seo8w3-3wsf8c-ffdd34-f58l",
  "clientNotificationRef": "1111-2222-3333-1230",
  "clientId": 200,
  "sourceIdentifier": "2341234567899"
}

[
  {
    "notificationRef": "45148314459c49669292ffdc7194520a"
  }
]