Skip to main content
POST
Transfer balance
This endpoint allows white label admins to transfer call minutes or chat credits to and from their users. This is useful for managing user balances programmatically when building custom frontends.
This endpoint is only available for white label admins. Regular users will receive a 403 Forbidden error.

Request Body

integer
The ID of the user to transfer to/from. Required if email is not provided.
string
The email of the user to transfer to/from. Required if user_id is not provided.
string
required
The type of balance to transfer: minutes or credits
string
required
The operation to perform: add (transfer to user) or remove (transfer from user)
number
required
The amount to transfer. For minutes, this is the number of call minutes. For credits, this is the number of chat credits.

Response

string
Success message
object
Details of the transfer
object
The user’s updated balance information
object
Your (tenant owner’s) updated balance

Transfer Types

Operations

Example: Adding Credits to a User

Example: Removing Minutes from a User