Balance Transfer

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

How Balance Transfer Works

• Your Master Balance - debited by the transfer amount (e.g. -₹500.00).
• Customer Wallet - credited by the same amount (e.g. +₹500.00).

​

Transfer Balance

​

Request Body

curl -X POST \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/transfer-balance" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500.00,
    "currency": "INR",
    "description": "April recharge - Credresolve"
  }'

import requests

BASE = "https://api.vobiz.ai/partner/v1"
HEADERS = {
    "X-Auth-ID": "{your_partner_id}",
    "X-Auth-Token": "{your_auth_token}",
    "Accept": "application/json",
    "Content-Type": "application/json",
}

# Check your own balance first
profile = requests.get(f"{BASE}/me", headers=HEADERS).json()
if profile["balance"] >= 500.00:
    response = requests.post(
        f"{BASE}/accounts/MA_48149cf4/transfer-balance",
        headers=HEADERS,
        json={
            "amount": 500.00,
            "currency": "INR",
            "description": "April recharge - Credresolve",
        },
    )
    print(response.json())

​

Notes

• Transfers are permanent and cannot be reversed - Once a transfer completes, there is no API endpoint to reverse it. If you transfer the wrong amount or to the wrong customer, contact Vobiz support. Always verify the customer_auth_id and amount before calling this endpoint.
• Transfers are atomic - your balance is checked at submission time - The API checks your master balance at the moment the request is received. If concurrent transfers cause your balance to drop below the required amount between your check and the actual transfer, the request fails with a 400 error.
• Description appears in both ledgers - The description field is recorded in your partner transaction ledger as a debit and in the customer’s transaction ledger as a credit. Use clear notes for easier reconciliation during billing cycles.

​

Before Transferring - Checklist

• Verify the target customer_auth_id is correct.
• Confirm the transfer amount and currency.
• Confirm your master balance is sufficient.
• Add a clear description for ledger reconciliation.
• Remember that transfers are permanent and cannot be reversed via API.