v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Notification

Set up a Notification for a Partner

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

post/partners/{partnerId}/notifications

Path parameters

partnerIdstring required

Request body

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

destinationsstring[] 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.

Response

Created

idstring required

Unique Identifier for the notification.

customerIdstring 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.

destinationsstring[] 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.