Skip to main content

NotificationRequest

Main container for notification requests with transaction context and recipient targeting

requestIdentifierstring

Unique transaction identifier used for tracking and reconciliation

Example: VCC25169C_ADRIA
notificationCodestring

Predefined notification type that determines content template and delivery rules

Possible values: [SEND_VERIFICATION_OTP, ACTIVATE_ACCOUNT, HANDLE_FORGET_PASSWORD, SEND_RIB_BY_EMAIL, NOTIFY_BO_CHEQUEBOOK_REQUEST, SEND_MAIL_ACTIVATION_BO, SEND_MAIL_ACTIVATION_ADMIN, ONBOARDING_VERIFICATION_OTP, SEND_OTP_ACTIVATION_SUBSCRIBER]

Example: PAYMENT_SUCCESS
segmentTypestring

User segment that will receive the notification

Possible values: [P_SegmentClientContrat, E_SegmentClientContrat]

Example: P_SegmentClientContrat
usersIdstring[]

List of target user IDs who should receive the notification

Example: ["2c91808890a622100190b759b0780002","2c91808890a622100190c03511ee0004"]
additionalData object

Optional context-specific data that will be interpolated into notification templates

property name*object

Optional context-specific data that will be interpolated into notification templates

Example: {"amount":250.75,"currency":"USD","recipientName":"John Doe","referenceNumber":"INV-2023-0456"}
NotificationRequest
{
"request": {
"requestIdentifier": "VCC25169C_ADRIA",
"notificationCode": "PAYMENT_SUCCESS",
"segmentType": "P_SegmentClientContrat",
"usersId": [
"2c91808890a622100190b759b0780002",
"2c91808890a622100190c03511ee0004"
],
"additionalData": {
"amount": 250.75,
"currency": "USD",
"recipientName": "John Doe",
"transactionDate": "2023-05-15T14:30:00Z"
}
}
}