curl -X POST "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/fund" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"amount": "500000.00",
"description": "Weekly float top-up"
}'
{
"success": true,
"message": "Agent funded successfully",
"transaction_id": "txn_fund_abc123",
"amount": "500,000.00 SLE",
"new_balance": "1,500,000.00 SLE",
"funded_by": "admin@olive.sl"
}
{
"error": "Not authorized to fund this agent",
"code": "FORBIDDEN"
}
Agents
Fund Agent
Add float to an agent’s account
POST
/
agents
/
{id}
/
fund
curl -X POST "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/fund" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"amount": "500000.00",
"description": "Weekly float top-up"
}'
{
"success": true,
"message": "Agent funded successfully",
"transaction_id": "txn_fund_abc123",
"amount": "500,000.00 SLE",
"new_balance": "1,500,000.00 SLE",
"funded_by": "admin@olive.sl"
}
{
"error": "Not authorized to fund this agent",
"code": "FORBIDDEN"
}
Adds float balance to an agent’s account. System admins can fund any agent. Super-agents can only fund their sub-agents.
Request
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)Path Parameters
string
required
Agent UUID to fund (e.g.,
agent_abc123)Body Parameters
string
required
Amount to add (e.g.,
500000.00 or 500000)string
Funding description/reference
Response
boolean
Whether funding succeeded
string
Funding transaction ID
string
Agent’s new float balance
Examples
curl -X POST "https://demo.api.vultlocal.com/api/v1/agents/agent_abc123/fund" \
-H "Authorization: Bearer olive_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"amount": "500000.00",
"description": "Weekly float top-up"
}'
{
"success": true,
"message": "Agent funded successfully",
"transaction_id": "txn_fund_abc123",
"amount": "500,000.00 SLE",
"new_balance": "1,500,000.00 SLE",
"funded_by": "admin@olive.sl"
}
{
"error": "Not authorized to fund this agent",
"code": "FORBIDDEN"
}
Funding Sources
OLIVE Admin
System admin funds from OLIVE pool
Super-Agent
Super-agent transfers own float to sub-agent
Permissions
| Funder Role | Can Fund |
|---|---|
| System Admin | Any agent |
| Super-Agent | Own sub-agents only |
| Sub-Agent | None |
Errors
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_AMOUNT | Invalid amount format |
| 401 | UNAUTHORIZED | Invalid API key |
| 403 | FORBIDDEN | Not authorized to fund |
| 403 | INSUFFICIENT_FLOAT | Super-agent has insufficient balance |
| 404 | NOT_FOUND | Agent not found |
| 500 | INTERNAL_ERROR | Server error |
Authorizations
ApiKeyAuthApiKeyAuthBearerAuth
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Path Parameters
Agent ID
Body
application/json
Fund amount
Accepts decimal format like "1289.00" or "1289"
Response
OK
The response is of type object.
⌘I