m2pfintech

Configure Low Balance Alert

Creates a new alert configuration for a corporate account. Currently supports CORPORATE_LOW_BALANCE_ALERT to notify when pool balance falls below a threshold.

Alert Types

TypeDescription
CORPORATE_LOW_BALANCE_ALERTTriggered when corporate pool balance drops below threshold

Notification Channels

  • Email (list of recipients)
  • SMS (list of mobile numbers)
POST
/v1/corporate-alert/configuration

Authorization

bearerAuth tenantId
AuthorizationBearer <token>

JWT Bearer token from the Authentication API

In: header

X-TENANT-ID<token>

Your unique tenant identifier assigned during onboarding

In: header

Header Parameters

X-TENANT-ID*string

Your unique tenant identifier

Request Body

application/json

corporateId?string

Corporate entity ID

accountNumber?string

Corporate pool account number

alertType?string

Type of alert

thresholdAmount?number

Amount threshold to trigger alert

emailRecipients?array<string>
mobileRecipients?array<string>

Response Body

application/json

application/json

curl -X POST "https://sandbox-api.m2pprepaid.com/prepaid/middleware/v1/corporate-alert/configuration" \  -H "X-TENANT-ID: ACME_CORP" \  -H "Content-Type: application/json" \  -d '{    "corporateId": "CORP123",    "accountNumber": "17568190551480014",    "alertType": "CORPORATE_LOW_BALANCE_ALERT",    "lowBalanceThreshold": 50000,    "notificationEmails": [      "finance@acme.com",      "treasury@acme.com"    ],    "notificationMobiles": [      "9876543210"    ]  }'
{
  "corporateId": "CORP123",
  "accountNumber": "17568190551480014",
  "alertType": "CORPORATE_LOW_BALANCE_ALERT",
  "thresholdAmount": 50000,
  "emailRecipients": [
    "finance@acme.com"
  ],
  "mobileRecipients": [
    "9876543210"
  ]
}
{
  "type": "https://www.m2pfintech.com/problem/problem-with-message",
  "title": "string",
  "status": 0,
  "detail": "string",
  "message": "error.http.400",
  "businessCode": "string",
  "fieldErrors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "cause": {},
  "errorCode": "string",
  "errors": [
    "string"
  ],
  "languageCode": "string",
  "localizedMessage": "string",
  "suppressed": [
    {}
  ]
}