Event Notification API documentation version v1
API to get and read notifications
/notifications
Get filtered notifications with resolved data
get /notifications
Get filtered notifications with resolved data
Query Parameters
- limit: (integer - default: 20 - minimum: 1 - maximum: 200)
Example:
25 - offset: (integer - default: 0 - minimum: 0)
Example:
25 - order_by: (createdAt)
Example:
createdAt - order_direction: (one of desc, asc - default: desc)
Example:
desc - status: (string)
Example:
new
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- items: required (array of ResolvedNotification)
Items: ResolvedNotification
- id: required (string)
unique hash of notification
- event: required (string)
event name(key)
- data: required (object)
resolved data, which may vary depending on event
- id: required (string)
Example:
{
"items": [
{
"id": "ZA36418283",
"event": "something_happened",
"data": {
"payment_request":{
"id": "request1",
"info": "Lorem ipsum",
"orderId": "order1"
}
}
},
{
"id": "ZA19389044",
"event": "something_happened_2",
"data": {
"payment_request":{
"id": "request2",
"info": "Lorem ipsum",
"orderId": "order2"
}
}
}
],
"_metadata": {
"total": 2,
"limit": 20,
"offset": 0,
"has_next": false,
"has_previous": false
}
}HTTP status code 401
Body
Media type: application/json
Type: object
Example:
{
"error": "unauthorized",
"error_description": "You have not provided any credentials or they are invalid"
}
HTTP status code 500
Body
Media type: application/json
Type: object
Example:
{
"error": "internal_server_error",
"error_description": "Unexpected internal system error"
}
Get notification with resolved data
get /notifications/{notificationId}
Get notification with resolved data
URI Parameters
- notificationId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required (string)
unique hash of notification
- event: required (string)
event name(key)
- data: required (object)
resolved data, which may vary depending on event
Example:
{
"id": "ZA07723659",
"event": "something_happened",
"data": {
"payment_request":{
"id": "request1",
"info": "Lorem ipsum",
"orderId": "order1"
}
}
}HTTP status code 401
Body
Media type: application/json
Type: object
Example:
{
"error": "unauthorized",
"error_description": "You have not provided any credentials or they are invalid"
}
HTTP status code 404
Body
Media type: application/json
Type: object
Example:
{
"error": "not_found",
"error_description": "Could not resolve entity from request attributes"
}
HTTP status code 500
Body
Media type: application/json
Type: object
Example:
{
"error": "internal_server_error",
"error_description": "Unexpected internal system error"
}
Mark(read) notification as processed
put /notifications/{notificationId}/read
Mark(read) notification as processed
URI Parameters
- notificationId: required (string)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- id: required (string)
unique hash of notification
- event: required (string)
event name(key)
- data: required (object)
resolved data, which may vary depending on event
Example:
{
"id": "ZA07723659",
"event": "something_happened",
"data": {
"payment_request":{
"id": "request1",
"info": "Lorem ipsum",
"orderId": "order1"
}
}
}HTTP status code 401
Body
Media type: application/json
Type: object
Example:
{
"error": "unauthorized",
"error_description": "You have not provided any credentials or they are invalid"
}
HTTP status code 404
Body
Media type: application/json
Type: object
Example:
{
"error": "not_found",
"error_description": "Could not resolve entity from request attributes"
}
HTTP status code 500
Body
Media type: application/json
Type: object
Example:
{
"error": "internal_server_error",
"error_description": "Unexpected internal system error"
}