Notifications

Server

List notifications

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications

List notifications › query Parameters

since

string · date-time

limit

integer

Default: 30

List notifications › Responses

200

Notifications and serverTime cursor.

No data returned

Unread notification count

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/unread-count

Unread notification count › Responses

200

Unread count.

No data returned

Mark notifications seen in bulk

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/seen

Mark notifications seen in bulk › Request Body

ids

string[] · required

Mark notifications seen in bulk › Responses

Marked.

No data returned

Mark every notification seen

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/read-all

Mark every notification seen › Responses

Marked.

No data returned

Mark one notification seen

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/{id}/seen

Mark one notification seen › path Parameters

id

string · uuid · required

Mark one notification seen › Responses

Marked.

No data returned

Notification preferences

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/preferences

Notification preferences › Responses

200

Preferences.

No data returned

Update notification preferences

PUT

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/preferences

Update notification preferences › Request Body

Update notification preferences › Responses

200

Updated preferences.

No data returned

Documents Devices

HeritagePay API

Notifications

Server

List notifications

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications

List notifications › query Parameters

since

string · date-time

limit

integer

Default: 30

List notifications › Responses

200

Notifications and serverTime cursor.

No data returned

Unread notification count

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/unread-count

Unread notification count › Responses

200

Unread count.

No data returned

Mark notifications seen in bulk

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/seen

Mark notifications seen in bulk › Request Body

ids

string[] · required

Mark notifications seen in bulk › Responses

Marked.

No data returned

Mark every notification seen

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/read-all

Mark every notification seen › Responses

Marked.

No data returned

Mark one notification seen

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/{id}/seen

Mark one notification seen › path Parameters

id

string · uuid · required

Mark one notification seen › Responses

Marked.

No data returned

Notification preferences

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/preferences

Notification preferences › Responses

200

Preferences.

No data returned

Update notification preferences

PUT

https://sandbox-heritagepay-api.paypm.net/api/v1

/notifications/preferences

Update notification preferences › Request Body

Update notification preferences › Responses

200

Updated preferences.

No data returned

Documents Devices