My notifications
/v1/my_notifications
Target audience: Developers
My notifications¶
Introduction¶
This endpoint is used to fetch the current customer notifications. This may include, but is not limited to creditcard expiration warnings, pending package shares, and more.
Note that the response from this endpoint may change, depending on what notifications the customer currently has.
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v1/me/my_notifications |
| Production | https://backend.worldoftulo.com/external/api/v1/me/my_notifications |
Requirements¶
| Identity | Scope |
|---|---|
| Yes | /external/me/r |
Curl example¶
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v1/me/my_notifications \
--header 'accept: application/json' \
--header 'authorization: Bearer <token-with-identity>' \
--header 'content-type: application/json'
Example response for expiring creditcard¶
| Field | Description |
|---|---|
| id | Id of the user product |
| product_name | Name of the subscription |
| masked_number | Id of the payment |
| expires | Expire date of the creditcard |
| type | The type of notification |
| category | The category of the notification |
HTTP 200
{
"items": [
{
"id": "665f2974b84731fce262b3a5",
"product_name": "Adeprimo Digital",
"masked_number": "123*****123",
"expires": "2024-06-30T15:00:00.000+02:00",
"type": "expiring_creditcard_notification",
"category": "warning"
}
]
}
Errors¶
This API uses the common error conventions of the Payway API