Skip to main content
POST
Transfer balance to customer
← Partner API Reference Transfer credits from your partner master wallet to a customer’s wallet. This is the primary mechanism for reselling voice minutes - you fund your customers, who then spend from their allocated balance on calls.
All Partner API requests use X-Auth-ID and X-Auth-Token headers. See Authentication for details.

Overview

How Balance Transfer Works

When you call the transfer endpoint, Vobiz atomically debits the specified amount from your partner master balance and credits it to the target customer’s wallet. Both debit and credit are recorded as separate transaction entries in each account’s ledger.
  • 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

Transfer credits from your partner master balance to a customer wallet. Transfers are atomic and permanent - verify the amount and target customer before submitting.

Request Body

Response (200)

Errors

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. Both legs (your debit, the customer’s credit) commit together or not at all. If concurrent transfers cause your balance to drop below the required amount between your own check and the actual transfer, the request fails with a 400 and neither ledger is touched.
  • Currency must match your partner account - The currency you send must equal your partner account currency (GET /mecurrency). A mismatched currency is rejected; the API does not convert between currencies.
  • No built-in idempotency key - Retrying a transfer after a network timeout can double-credit the customer, because each call is a fresh transfer. Before retrying a request whose response you never saw, poll the customer’s transactions (match on amount + recent created_at) to confirm whether the first attempt landed.
  • 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 (prefixed Transfer from partner …). 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.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

customer_auth_id
string
required
Example:

"MA_ZKITB8Z2"

Body

application/json
amount
number
required

Positive decimal. Your master balance must be ≥ this amount.

Example:

500

currency
string
required

Must match your partner account currency.

Example:

"INR"

description
string

Note for your records. Appears in both ledgers.

Example:

"April recharge - Credresolve"

Response

Transfer completed