Skip to main content
POST
Transfers funds from subscriber’s VULT mobile money wallet to their OLIVE wallet.

Request

string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

Body Parameters

string
required
Subscriber UUID
string
required
VULT wallet identifier
string
required
Amount to transfer (e.g., 500.00)
string
required
VULT transaction reference for reconciliation
string
required
Subscriber’s OLIVE PIN

Response

boolean
Whether funding succeeded
string
OLIVE transaction ID
string
Updated OLIVE wallet balance

Examples


Flow

1

Verify PIN

Authenticate subscriber with OLIVE PIN
2

Check VULT Wallet

Verify VULT wallet linked and has balance
3

Debit VULT

Deduct from VULT mobile money wallet
4

Credit OLIVE

Add to OLIVE wallet balance
5

Record

Log transaction with VULT reference

Prerequisites

VULT Linked

Subscriber must have VULT wallet linked to profile

VULT Balance

Sufficient balance in VULT wallet

Errors

Authorizations

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Body

application/json

Fund from VULT details

amount
string
required

Accepts decimal format like "500.00" or "500"

Example:

"500.00"

pin
string
required
Example:

"1234"

subscriber_id
string
required
Example:

"subscriber-uuid"

transaction_ref
string
required
Example:

"VULT-TXN-123"

vult_wallet_id
string
required
Example:

"vult-wallet-123"

Response

Wallet funded successfully

The response is of type object.