Partner API

Transfer balance to customer

Atomically debits your partner master balance and credits the customer's wallet. Both legs are recorded in each account's ledger. Transfers are permanent and cannot be reversed.

post/api/v1/partner/accounts/{customer_auth_id}/transfer-balance

Request

Base URL
https://api.vobiz.ai
Auth
API key in header X-Auth-ID and API key in header X-Auth-Token
TypeScript
https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/partner/accounts/:customer_auth_id/transfer-balance/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customer_auth_idstring required

Example:MA_ZKITB8Z2

Request body

amountnumber required

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

currencystring required

Must match your partner account currency.

descriptionstring

Note for your records. Appears in both ledgers.

Example request

{
  "amount": 500,
  "currency": "INR",
  "description": "April recharge - Credresolve"
}

Response

Transfer completed

Changes

No recorded changes to this operation across all 1 revision of this API.