Register a device push token to enable push notifications for a customer's account.
Push Token Setup
This endpoint registers a mobile device's push notification token with the Netevia Banking platform. Once registered, the platform can deliver real-time push notifications for account activity, transaction alerts, and other events to the specified device. This is typically called during app initialization or when a device token is refreshed by the mobile OS.
Endpoint
POST /settings/setup
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Call this endpoint when a user installs or opens a partner mobile application for the first time to enable push notifications. It should also be called whenever the mobile OS issues a new push token for the device (e.g., after an app reinstall or token rotation). Keeping the token current ensures uninterrupted delivery of account alerts and transactional notifications.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| pushToken | string | Yes | The push notification token issued by the mobile platform (APNs for iOS, FCM for Android). Minimum length: 1 character. |
| deviceId | string | Yes | A unique identifier for the device being registered. Used to associate the push token with a specific device. Minimum length: 1 character. |
{
"pushToken": "fCM_or_APNs_token_string_here",
"deviceId": "device-uuid-1234-abcd-5678-efgh"
}Response
200 OK
A 200 response indicates the push token was successfully registered. No response body is returned.
{}Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields (pushToken or deviceId) or values fail minimum length validation |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions |
| 404 | Resource not found |
| 500 | Internal server error |
Common Mistakes
- Sending an empty string for
pushTokenordeviceId— both fields require a minimum length of 1 character and will fail validation if blank. - Not refreshing the push token registration after the mobile OS rotates the device token, causing push notifications to fail silently.
- Using a stale Bearer token (lifetime is 10 minutes); always refresh before calling this endpoint.
Related Endpoints
POST /api/auth/v2— Obtain a Bearer authentication tokenPOST /api/auth/refresh— Refresh an existing Bearer token
Example
curl -X POST https://api.banking.netevia.dev/settings/setup \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pushToken": "fCM_or_APNs_token_string_here",
"deviceId": "device-uuid-1234-abcd-5678-efgh"
}'Success