List merchant notifications

This method is used by merchants to retrieve a list of created notifications.

List notification request

Path:

GET {Base URL}/notifications

Header:

Content-Type: application/json
Accept-Language: en-US

List notification response

Payload parameters

Field	Description	Type	Format
nextPointer	The pointer to the next list of available queries. One request contains 100 notification results. The nextPointer contains the 'notificationId' of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If 'nextPointer' is empty, then the 'last page' of results has been processed and there is no more data to be retrieved.	String	UUID
id	The notification identifier.	String	UUID
createdAt	Time of the creation in ISO format.	String	YYYY-MM-DD'T'HH:mm:ss.SSZ
merchantKey	Merchant identifier.	String	UUID
httpCode	An HTTP Code, which will be populated from the notification service based on the result of the webhook.	String	processing, "error", "done"
status	Status of the notification processing. It will be updated by the notification result job based on the result of the processing within the notification service. Possible values are: "processing" - used when the notification is submitted to the SQS service and is waiting for a reply from the notification service. "error" - the processing of the notification failed within notification service and NOTHING IS SENT to the merchant "done" - notification is successfully processed in the notification service. In order to understand if it was delivered, check the httpCode along with message for additional details.	String
message	This property contains monitoring information for administrative purposes. It can contain processing errors, merchant response or exceptions. Not send to merchants.	String
sourceSystem	The source system of the notifications.	String	smartpay
origin	Source system that is sending the notification.	String	Enum: "api", "widget", "automated"
eventType	Type of the event.	String	Enum: "updated", "created", "deleted", "status.updated", "billing.expires", "billing.updated", "billing.scheduled"
objectId	ID of the referenced object	String	UUID
objectType	Type of the event, mainly differentiating between "refund" and other transaction status changes under "payment". "prepayment" type provides prepayment specific status changes.	String	Enum: "subscription", "plan", "billing-cycle", "payment-series", "transactions" "manual-retry"
metadata	Object that is empty for all events for "subscription" module.	Dictionary	key, value pairs
context	This is the request body for "api" and "widget" events.	String	maxLength: 10000
data	Data of the object.	Object

Response sample

Status Code:

200 (OK)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "nextPointer": "12489512t139bf1ef0n01ebg1h3",
    "results": [
        {
            "id": "784c93b5-026c-4863-95d0-b89e76caefa7",
            "createdAt": "2023-08-15T09:23:41.87Z",
            "sourceSystem": "smartpay",
            "origin": "automated",
            "eventType": "status.updated",
            "objectId": "ff87e17f-97f2-4bf4-adfe-a50517bb411f",
            "objectType": "transactions",
            "metadata": {
                "transactionId": 102957125651,
                "reconciliationId": 102957125651
            },
            "data": null,
            "context": null
        },
        {
            "id": "1t01ot9-026c-1225-5521-193gy1ge1",
            "createdAt": "2023-08-22T09:23:41.87Z",
            "sourceSystem": "network-token-connector",
            "origin": "automated",
            "eventType": "status.updated",
            "objectId": "ff87e17f-97f2-4bf4-adfe-a50517bb411f",
            "objectType": "network-token",
            "metadata": {
                "transactionId": 102957125651,
                "reconciliationId": 102957125651
            },
            "data": null,
            "context": null
        }
    ]
}