Payouts · Payout Wallet

Payout Balance

Your payout wallet balance, and the payout minimum and fee.

GET request

URL: https://uat-api.vizodigital.com/api/v1/payouts/balance

Include a valid Bearer token with every request

Code sample

curl -X GET "https://uat-api.vizodigital.com/api/v1/payouts/balance" \
  -H "X-API-Key: YOUR_API_KEY_OR_TOKEN" \
  -H "X-Timestamp: $(TZ=Asia/Kolkata date '+%Y-%m-%d %H:%M:%S')"

Success Response

{
    "status": "success",
    "message": "Payout wallet balance.",
    "data": {
        "payout_balance": "5000.00",
        "pending_amount": "1000.00",
        "minimum": "100.00",
        "fee": "10.00"
    }
}

Failure response

{
    "message": "Invalid or revoked API key."
}

Overview

Returns what is in your payout wallet and the rules for a payout.

How the two wallets work

Main wallet: you recharge it, and service charges (for example the AEPS Daily 2FA charge) are taken from it.
Payout wallet: banking funds land here. Today that is AEPS commission (at once) and AEPS withdrawn amounts (after each settlement cycle).
You can take payout wallet money to an approved bank account with Request Payout, or move it to your main wallet with Move to Main Wallet.
Money never moves from the main wallet to the payout wallet, so recharged money cannot be paid out.

Fields

payout_balance: what you can ask for now.
pending_amount: already held in payouts that are still pending.
minimum: the smallest payout.
fee: taken out of each payout. Ask for Rs 1000 with a fee of Rs 10 and Rs 990 reaches your bank.

Testing in UAT A UAT key always sees a sample payout_balance of 25,000.00, and no money moves. pending_amount adds up your own pending UAT payouts. minimum and fee are the real ones.

Headers

X-API-Key · string required

Your credential: either your `rr_live_` API key, or the Bearer token from `POST /api/v1/auth/client-credentials` (the same token every other API uses). The token may instead be sent as `Authorization: Bearer <token>`. A token follows the same IP whitelist as your keys, and all your tokens share one requests-per-minute allowance.

Example: rr_live_xxxxxxxxxxxxx
X-Timestamp · string required

Current time in IST as `YYYY-MM-DD HH:MM:SS` (or `YYYY-MM-DDTHH:MM:SS`). Do not add a timezone suffix such as `+05:30`. Must be within 15 seconds of our server time.

Example: 2026-10-03 10:30:45

Responses

200 · application/json default

Success

Example

{
    "status": "success",
    "message": "Payout wallet balance.",
    "data": {
        "payout_balance": "5000.00",
        "pending_amount": "1000.00",
        "minimum": "100.00",
        "fee": "10.00"
    }
}

401 · application/json

Failed or rejected

Example

{
    "message": "Invalid or revoked API key."
}

Errors

INVALID_API_KEY · HTTP 401

Invalid or revoked API key.
```
{
    "message": "Invalid or revoked API key."
}
```
TIMESTAMP_OUT_OF_RANGE · HTTP 400

Request timestamp is outside the ±15 second window.
```
{
    "message": "Request timestamp is outside the ±15 second window."
}
```
RATE_LIMITED · HTTP 429

Rate limit exceeded.
```
{
    "message": "Rate limit exceeded."
}
```

Rate Limits

100/min