POST
/
api
/
v1
/
transactions
/
wallet
/
mobile-money-cashout
/
Mobile Money Cashout
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/mobile-money-cashout/ \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "wallet_id": "<string>",
  "amount": 123,
  "phone_number": "<string>",
  "provider": "<string>",
  "currency": "<string>"
}
'
{
  "id": "trans_123abc...",
  "wallet_id": "wall_789xyz...",
  "amount": 50.0,
  "currency": "SLE",
  "transaction_type": "withdrawal",
  "payment_method": "mobile_money",
  "status": "pending",
  "monime_fee": 1.5,
  "application_fee": 1.0,
  "description": "Wallet withdrawal to +23278XXXXXX",
  "created_at": "2025-01-16T10:10:00Z"
}
This endpoint allows users to withdraw funds from their wallet directly to a mobile money account (Orange Money or Africell Money) in Sierra Leone.

Request Body

wallet_id
string
required
The unique identifier of the wallet to withdraw funds from.
amount
number
required
The amount to withdraw in SLE (e.g., 50.50 for 50.50 SLE).
phone_number
string
required
The recipient’s mobile money phone number in E.164 format (e.g., +23278XXXXXX).
provider
string
The mobile money provider code:
  • m17: Orange Money (default)
  • m18: Africell Money
currency
string
The currency code. Currently, only “SLE” is supported for mobile money cashouts.

Response

id
string
The unique identifier for the transaction.
wallet_id
string
The ID of the wallet the funds were withdrawn from.
amount
number
The net amount being sent to the mobile money account.
currency
string
The currency code (“SLE”).
status
string
The current status of the transaction (e.g., “pending”, “completed”, “failed”).
monime_fee
number
The fee charged by Monime for the cashout.
application_fee
number
The platform fee collected for this withdrawal.
{
  "id": "trans_123abc...",
  "wallet_id": "wall_789xyz...",
  "amount": 50.0,
  "currency": "SLE",
  "transaction_type": "withdrawal",
  "payment_method": "mobile_money",
  "status": "pending",
  "monime_fee": 1.5,
  "application_fee": 1.0,
  "description": "Wallet withdrawal to +23278XXXXXX",
  "created_at": "2025-01-16T10:10:00Z"
}
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/wallet/mobile-money-cashout/ \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "wallet_id": "wall_789xyz...",
    "amount": 50.00,
    "phone_number": "+23278XXXXXX",
    "provider": "m17"
  }'