Retrieve a specific notification by unique reference for a specific partner

get https://api-sandbox.modulrfinance.com/api-sandbox-token/partners/{partnerId}/notifications/{notificationId}

This allows you to see the settings for a particular notification that has been set up, for example if you want to check if it is active or the emails the notification is being sent to. It would be best practice to call this before updating a notification.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

required

Unique Identifier for the notification.

customerId

string

required

Unique Identifier for the customer of this notification.

type

string

required

Type of notification

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

channel

string

required

Channel used to send the notification.

EMAIL WEBHOOK

status

string

required

Status of notification.

ACTIVE INACTIVE

destinations

array of strings

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.

destinations*

config

object

required

Configuration information for this Notification entity.

threshold

number

≥ 0

Amount threshold which triggers the notification. This attribute only applies to 'EMAIL' notifications channel, of type 'PAYIN', 'PAYOUT'.

timesToRun

array of strings

Times of the day when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.

timesToRun

daysToRun

array of strings

Days of the week when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.

daysToRun

retry

boolean

Flag indicating whether failed webhooks should be retried. This attribute applies only to 'WEBHOOK' notifications channel.

secret

string

length between 32 and 32

Mandatory for webhook. Secret that is used in HMAC calculation, for webhooks. This attribute applies only to 'WEBHOOK' notifications channel.

hmacAlgorithm

string

Signing algorithm that is used in Webhook HMAC calculation. This attribute only applies to 'WEBHOOK' notifications channel.

hmac-sha1 hmac-sha256 hmac-sha384 hmac-sha512

Response body

object

string

required

Unique Identifier for the notification.

customerId

string

required

Unique Identifier for the customer of this notification.

type

string

required

Type of notification

channel

string

required

Channel used to send the notification.

EMAIL WEBHOOK

status

string

required

Status of notification.

ACTIVE INACTIVE

destinations

array of strings

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.

destinations*

config

object

required

Configuration information for this Notification entity.

threshold

number

≥ 0

Amount threshold which triggers the notification. This attribute only applies to 'EMAIL' notifications channel, of type 'PAYIN', 'PAYOUT'.

timesToRun

array of strings

Times of the day when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.

timesToRun

daysToRun

array of strings

Days of the week when to trigger the notification. This attribute applies only to 'EMAIL' notifications channel, of type 'BALANCE'.

daysToRun

retry

boolean

Flag indicating whether failed webhooks should be retried. This attribute applies only to 'WEBHOOK' notifications channel.

secret

string

length between 32 and 32

Mandatory for webhook. Secret that is used in HMAC calculation, for webhooks. This attribute applies only to 'WEBHOOK' notifications channel.

hmacAlgorithm

string

Signing algorithm that is used in Webhook HMAC calculation. This attribute only applies to 'WEBHOOK' notifications channel.

hmac-sha1 hmac-sha256 hmac-sha384 hmac-sha512

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.modulrfinance.com/api-sandbox-token/partners//notifications/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200OK

400Bad Request

404Not found