POST
/
api
/
v1
/
transactions
/
applications
/
{application_id}
/
prepaid-deposit
/
monime
Create Prepaid Deposit
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/applications/{application_id}/prepaid-deposit/monime \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "amount": 123,
  "phone_number": "<string>"
}
'
{
  "transaction_id": "84d5df64-42b7-4a00-ba5d-6c1b3fb1ff82",
  "payment_code": {
    "id": "pmt_monime_9988",
    "code": "*715*99882233#",
    "status": "pending",
    "amount": {
      "value": 5000,
      "currency": "SLE"
    }
  }
}
This endpoint allows developer admins to fund their application’s platform_prepaid wallet using Mobile Money (Monime). It requests a USSD payment code using HOST Pay’s central platform credentials.

Query Parameters

live_mode
boolean
default:"true"
Specifies whether to execute the deposit in live or test environment mode.

Path Parameters

application_id
string
required
The unique identifier of the client-managed application.

Request Body

amount
integer
required
The amount to deposit in SLE cents (e.g., 5000 for 50.00 SLE).
phone_number
string
required
The Monime-registered mobile money phone number to request payment from.

Response

transaction_id
string
The unique identifier for the deposit transaction.
payment_code
object
The response payload from Monime containing the USSD code and status.
{
  "transaction_id": "84d5df64-42b7-4a00-ba5d-6c1b3fb1ff82",
  "payment_code": {
    "id": "pmt_monime_9988",
    "code": "*715*99882233#",
    "status": "pending",
    "amount": {
      "value": 5000,
      "currency": "SLE"
    }
  }
}
curl --request POST \
  --url https://hpay-api.host-sl.com/api/v1/transactions/applications/YOUR_APP_ID/prepaid-deposit/monime?live_mode=true \
  --header 'api-key: YOUR_API_KEY' \
  --header 'secret-key: YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone_number": "+23277123456",
    "amount": 5000
  }'