---
title: "Set up a Notification for a Customer"
method: POST
path: "/customers/{customerId}/notifications"
tags: ["Notification"]
---

# Set up a Notification for a Customer

`POST /customers/{customerId}/notifications`

Sets up a new notification for a customer using the customer's ID as a reference. Returns a notification ID that should be saved if the notification needs to be amended in the future

## Path parameters

- `customerId` string, required

## Request body

- NotificationNotificationRequest
  - `type` 'PAYIN' | 'PAYOUT' | 'BALANCE_LOW' | 'BALANCE_HIGH' | 'BALANCE' | 'DDMANDATE' | 'CUSTVSTAT' | 'ACCOUNT_STATEMENT' | 'PENDING_PAYMENTS' | 'DD_INCOMING_DEBIT' | 'DD_FAILED_CLAIM' | 'DD_FUNDS_RETURNED' | 'CARD_AUTH' | 'CARD_AUTH_OFFLINE' | 'CARD_CREATION' | 'UPCOMING_CREDIT' | 'UPCOMING_COLLECTION_CREDIT' | 'UPCOMING_COLLECTION_DEBIT' | 'CARD_STATUS_UPDATE' | 'CARD_TOKEN_PROVISIONING' | 'PAYMENT_COMPLIANCE_STATUS' | 'DD_COLLECTION_STATUS' | 'ACCOUNT_SWITCH_UPDATE' | 'PAYMENT_FILE_UPLOAD' | 'ACCOUNT_STATUS_CHANGE' | 'PAYMENT_APPROVAL_STATUS_CHANGE' | 'CUSTOMER_BATCH_PAYMENT_APPROVAL_STATUS_CHANGE' | 'CARD_BULK_OPS_COMPLETED' | 'CUSTOMER_STATUS' | 'CREDIT_AUTH' | 'DD_INDEMNITY_CLAIM_STATUS' | 'APPLICATION_STATUS_CHANGE' | 'CUSTOMER_CREATED', required — Type of the notification.
  - `channel` 'EMAIL' | 'WEBHOOK', required — Channel used for sending the notification
  - `destinations` string[], required — The list of emails or url(webhook) used for sending the notification. For 'EMAIL' channel this can be a list of comma separated email addresses. For 'WEBHOOK' channel this should be a single URL.
  - `config` NotificationNotificationConfig, required
    - `threshold` number — Amount threshold which triggers the notification. This attribute only applies to 'EMAIL' notifications channel, of type 'PAYIN', 'PAYOUT'.
    - `timesToRun` string[] — Times of the day when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.
    - `daysToRun` string[] — Days of the week when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.
    - `retry` boolean — Flag indicating whether failed webhooks should be retried. This attribute applies only to 'WEBHOOK' notifications channel.
    - `secret` string — Mandatory for webhook. Secret that is used in HMAC calculation, for webhooks. This attribute applies only to 'WEBHOOK' notifications channel.
    - `hmacAlgorithm` 'hmac-sha1' | 'hmac-sha256' | 'hmac-sha384' | 'hmac-sha512' — Signing algorithm that is used in Webhook HMAC calculation. This attribute only applies to 'WEBHOOK' notifications channel.

## Response `201`

Created

- NotificationNotificationResponse
  - `id` string, required — Unique Identifier for the notification.
  - `customerId` string, required — Unique Identifier for the customer of this notification.
  - `type` 'PAYIN' | 'PAYOUT' | 'BALANCE_LOW' | 'BALANCE_HIGH' | 'BALANCE' | 'DDMANDATE' | 'CUSTVSTAT' | 'ACCOUNT_STATEMENT' | 'PENDING_PAYMENTS' | 'DD_INCOMING_DEBIT' | 'DD_FAILED_CLAIM' | 'DD_FUNDS_RETURNED' | 'CARD_AUTH' | 'CARD_AUTH_OFFLINE' | 'CARD_CREATION' | 'UPCOMING_CREDIT' | 'UPCOMING_COLLECTION_CREDIT' | 'UPCOMING_COLLECTION_DEBIT' | 'CARD_STATUS_UPDATE' | 'CARD_TOKEN_PROVISIONING' | 'PAYMENT_COMPLIANCE_STATUS' | 'DD_COLLECTION_STATUS' | 'ACCOUNT_SWITCH_UPDATE' | 'PAYMENT_FILE_UPLOAD' | 'ACCOUNT_STATUS_CHANGE' | 'PAYMENT_APPROVAL_STATUS_CHANGE' | 'CUSTOMER_BATCH_PAYMENT_APPROVAL_STATUS_CHANGE' | 'CARD_BULK_OPS_COMPLETED' | 'CUSTOMER_STATUS' | 'CREDIT_AUTH' | 'DD_INDEMNITY_CLAIM_STATUS' | 'APPLICATION_STATUS_CHANGE' | 'CUSTOMER_CREATED', required — Type of notification
  - `channel` 'EMAIL' | 'WEBHOOK', required — Channel used to send the notification.
  - `status` 'ACTIVE' | 'INACTIVE', required — Status of notification.
  - `destinations` string[], required — A list of emails or url(webhook) used to send the notification. For 'EMAIL' channel this can be a list of comma separated email addresses. For 'WEBHOOK' channel this will be a single URL.
  - `config` NotificationNotificationConfig, required
    - `threshold` number — Amount threshold which triggers the notification. This attribute only applies to 'EMAIL' notifications channel, of type 'PAYIN', 'PAYOUT'.
    - `timesToRun` string[] — Times of the day when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.
    - `daysToRun` string[] — Days of the week when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.
    - `retry` boolean — Flag indicating whether failed webhooks should be retried. This attribute applies only to 'WEBHOOK' notifications channel.
    - `secret` string — Mandatory for webhook. Secret that is used in HMAC calculation, for webhooks. This attribute applies only to 'WEBHOOK' notifications channel.
    - `hmacAlgorithm` 'hmac-sha1' | 'hmac-sha256' | 'hmac-sha384' | 'hmac-sha512' — Signing algorithm that is used in Webhook HMAC calculation. This attribute only applies to 'WEBHOOK' notifications channel.

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)