Endpoints
Balance Transfer
Transfer credits from your Vobiz partner master wallet to a customer’s wallet - the primary mechanism for funding reseller sub-accounts with prepaid voice minutes.
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
| Property | Behavior |
|---|---|
| Atomic | Transfers complete or fail entirely - no partial states |
| Permanent | Cannot be reversed via API - verify amount before submitting |
| Instant | Customer wallet is credited immediately on success |
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
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Required | Amount to transfer in the partner’s currency |
currency | string | Required | ISO 4217 currency code, e.g. INR |
description | string | Optional | Free-text note recorded in both transaction ledgers |
Response (200)
| Field | Notes |
|---|---|
transaction_id | The transfer’s ledger reference. Store it for reconciliation - it ties the debit on your ledger to the credit on the customer’s. |
from_account | Your partner auth_id (the debited account). |
to_account | The customer auth_id (the credited account). |
status | completed on success. The transfer is atomic - there is no pending state. |
partner_balance_after | Your master balance after the debit. Assert this is non-negative as a sanity check. |
customer_balance_after | The customer’s wallet balance after the credit. |
Errors
| Status | Cause |
|---|---|
400 | Insufficient partner balance (payload above), non-positive amount, or a currency that doesn’t match your partner account currency. |
401 / 403 | Invalid partner credentials, or can_transfer_balance is false on your partner profile. |
404 | customer_auth_id not found, or it belongs to a different partner. |
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_idand 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
400and neither ledger is touched. - Currency must match your partner account - The
currencyyou send must equal your partner account currency (GET /me→currency). 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+ recentcreated_at) to confirm whether the first attempt landed. - Description appears in both ledgers - The
descriptionfield is recorded in your partner transaction ledger as a debit and in the customer’s transaction ledger as a credit (prefixedTransfer from partner …). Use clear notes for easier reconciliation during billing cycles.
Before Transferring - Checklist
- Verify the target
customer_auth_idis correct. - Confirm the transfer
amountandcurrency. - Confirm your master balance is sufficient.
- Add a clear
descriptionfor ledger reconciliation. - Remember that transfers are permanent and cannot be reversed via API.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Example:
"MA_ZKITB8Z2"
Body
application/json
Response
Transfer completed