Credit Limit Notification

POST

/v1/notifications/opt-in

Receive notifications regarding your credit limit as it reaches specific thresholds. You have
the flexibility to opt-in for various levels based on your requirements. For instance, you can
choose to receive notifications at 90% of your credit limit or select multiple thresholds such
as 50%, 70%, and 90%. These notifications can be delivered either to your webhook or your
company email address.

Parameters

"type": "webhook_credit_limit", - use this value to receive notification via webhook

"email_credit_limit" use this value to receive notification via email

"webhook_url": "https://example.com" - in case of notification to be
delivered via your webhook implementation, provide your webhook
implementation url

“email” – email address is case of notification via company email address

“language” – “en” – in case of email based notification

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/notifications/opt-in' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "webhook_credit_limit",
    "webhook_url": "https://example.com",
    "levels": [
        50,
        70,
        80,
        90
    ]
}'

Response Example

200 - Get the webhook based notification - Get the webhook based notification

{
  "data": {
    "notification": {
      "type": "webhook_credit_limit",
      "contact_point": "https://example.com",
      "levels": [
        50,
        70,
        80,
        90
      ]
    }
  },
  "meta": {
    "message": "success"
  }
}

Request

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Body Params application/json

type

string

required

webhook_url

string

required

levels

array[integer]

required

Examples

Responses

🟢200Get the webhook based notification

text/plain

Body

data

object

required

notification

object

required