List Merchant Notifications

GET 
/notifications

This method is used by merchants to retrieve a list of created notifications. One request contains 100 notification results.

Request

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

Responses

200

Successful response

application/json

Schema

Schema

nextPointer uuid

The pointer to the next list of available queries. 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.

results

object[]

Array [

id uuid

The notification identifier.

createdAt date-time

Time of the creation in ISO format.

merchantKey uuid

Possible values: <= 36 characters

Merchant identifier.

httpCode string

Possible values: [processing, error, done]

An HTTP Code, which will be populated from the notification service based on the result of the webhook.

status string

Possible values: [processing, error, done]

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.

message string

This property contains monitoring information for administrative purposes. It can contain processing errors, merchant response or exceptions. Not sent to merchants.

sourceSystem string

Possible values: [smartpay, network-token-connector]

The source system of the notifications.

origin string

Possible values: [api, widget, automated]

Source system that is sending the notification.

eventType string

Possible values: [updated, created, deleted, status.updated, billing.expires, billing.updated, billing.scheduled]

Type of the event.

objectId uuid

ID of the referenced object

objectType string

Possible values: [subscription, subscription-plan, billing-cycle, payment-series, transactions, manual-retry, network-token]

Type of the event, mainly differentiating between "refund" and other transaction status changes under "payment". "prepayment" type provides prepayment specific status changes.

metadata

object

Object that is empty for all events for subscription module.

transactionId integernullable

Possible values: <= 36 characters

Unique Identifier of the transaction.

reconciliationId integernullable

Possible values: <= 64 characters

Merchant-defined identifier used for internal reconciliation process.

context string

Possible values: <= 10000 characters

This is the request body for api and widget events.

data object

Data of the object.

]

Example (from schema)

{
  "nextPointer": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "merchantKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "httpCode": "processing",
      "status": "processing",
      "message": "string",
      "sourceSystem": "smartpay",
      "origin": "api",
      "eventType": "updated",
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "objectType": "subscription",
      "metadata": {
        "transactionId": 0,
        "reconciliationId": 0
      },
      "context": "string",
      "data": {}
    }
  ]
}

Example

{
  "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
    }
  ]
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...