Limits and availability
Check your limits, today's usage and whether a service is up before sending a payment.
Your configuration
GET /api/v1/configuration returns, for the environment of the credential you call it with,
every service your account can use:
{
"environment": 1,
"currency": "XAF",
"balance": 250000,
"dailyLimitResetsAt": "2026-10-31T00:00:00+00:00",
"services": [
{
"serviceCode": "MOMO_WITHDRAWAL",
"name": "MTN MoMo disbursement (withdrawal)",
"availability": "OPERATIONAL",
"availabilityMessage": null,
"amountLimitsApply": true,
"minAmount": 100,
"maxAmount": 500000,
"dailyLimit": 2000000,
"usedToday": 350000,
"remainingToday": 1650000,
"feePercent": 1.5,
"feeFlat": 0,
"rateLimitPerMinute": 60
}
]
}environmentis0for Sandbox,1for Live. Sandbox and Live have separate balances and limits.balanceis what payouts (withdrawals, refunds, crypto sells) can draw on.- Amount limits (
minAmount,maxAmount,dailyLimit) apply to money out only: withdrawals, refunds, crypto sells and bulk payouts. For every other service (deposits, KYC lookups, status checks)amountLimitsApplyisfalseand those fields,usedTodayandremainingTodayarenull; only the rate limit applies. Where they do apply,nullmeans no such limit. usedTodaycounts the day's pending and successful transactions of that service, the same total the daily limit is checked against. Daily limits reset at midnight UTC (dailyLimitResetsAt).
Use it to show a customer the amounts you can accept, or to hold back a payout you know would be refused.
Availability
Each service is in one of four states, also shown on the status page:
| Status | Meaning |
|---|---|
OPERATIONAL | Working normally. |
DEGRADED | Working, but some recent payments failed at the operator, or the operator is slow to confirm them. Expect more failures or longer waits. |
MAINTENANCE | Paused by us. Requests are refused until it's back. |
DOWN | The operator can't be reached, or nearly all recent payments failed there. Hold requests and try later. |
It is worked out from the gateway's own Live traffic, refreshed every 30 seconds:
- Down when the gateway can't reach the operator, or when, of 5 or more Live payments that
finished in the last 15 minutes, at least 80% failed at the operator (
PROVIDER_ERRORThe operator had a technical problem. Nothing moved; try again later.,NOT_CREATEDThe operator never received this payment, so nothing moved.). - Degraded when 3 or more such failures make up at least 30%, or when more than half of 5 or more Live payments created 10 to 60 minutes ago are still pending.
Customer outcomes (declined, not enough money, wrong number) never count, and Sandbox traffic is ignored.
GET /api/v1/status returns the same data with no credentials, so you can point a monitor at it:
{
"status": "OPERATIONAL",
"services": [
{ "serviceCode": "MOMO_DEPOSIT", "name": "MTN MoMo collection (deposit)", "status": "OPERATIONAL", "message": null }
],
"checkedAt": "2026-10-30T14:05:12+00:00"
}status is the worst status of any service.
