Read the balance, currency and payment-terms value of the account represented by your API credentials. This is a balance lookup; it does not add funds or place an order.
Request
Use server-side API credentials over HTTPS. The examples read credentials from environment variables; they contain no working credentials. Inspect status.code in the JSON body as well as the HTTP status. These legacy handlers do not consistently set an HTTP error status for an application error.
curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
"https://api.multitel.net/v3/getbalance"No path, query or body parameters are required.
Response
This is an illustrative response shape, not account data or a current price quote.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "125.50",
"currency": "USD",
"terms": "prepaid"
}
}| Field | Meaning |
|---|---|
balance | The stored account balance. Preserve decimal precision when consuming monetary values. |
currency | The currency value stored for this account. |
terms | The account’s stored payment-terms value. The handler does not enumerate or normalize it; do not assume the example exhausts the possible values. |
Errors and use
Authentication failure uses the shared API authentication response. This handler defines no separate missing-balance error or pagination. A returned balance is not a reservation of funds and does not guarantee that a later order will succeed.