Push Notifications
Users can receive push notifications for:
- Deposits (incoming transactions to their crypto wallet).
- Withdrawals (outgoing transactions from their crypto wallet).
Notifications are supported on mobile clients with iOS or Android operating systems.
Before you begin
- Integrate with Firebase and create the account.
- Check the Firebase Cloud Messaging Service documentation for more details about push notification set up.
- Configure the sender name within the Firebase account and provide the account credentials to our technical support team for further backend setup.
- Complete registration and authentication in Vault System — the request can only be triggered by registered and logged-in users.
Check Push Notification Permission Status
POST /notification/push/registerDevice
The endpoint is designed to retrieve the latest authorization status for push notification delivery.
Headers:
| Name | Type | Required | Description |
|---|---|---|---|
X-Platform | string | ✅ | Parameter specifying the device's operating platform (iOS, Android). |
Body Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
deviceId | string | ✅ | A unique identifier for the user’s device. |
registrationToken | string | ➖ | A platform-specific identifier issued by a push notification service to deliver push notifications to a specific device. |
pushEnabled | boolean | ✅ | Specifies whether the user has permitted push notifications on the device. |
Response Example:
{
"deviceId": "string",
"registrationToken": "string",
"pushEnabled": true
}
Push Notification Status Payload
Allowed Notifications
If the user grants push notification permissions, the response should include:
deviceId;registrationToken;- status:
TRUE.
Blocked Notifications
If the user denies permissions, the response should contain:
deviceId;- status:
FALSE.
Updated 2 days ago