v1

latestOpenAPI 3.1.02026-07-24590534.0 KB

Initiate GHS Momo deposit

This endpoint verifies otp for mobile money deposit

post/custodial/on_ramp_transactions/initiate_mobile_money

Request body

merchant_referencestring

Transaction reference used in initiating the on-ramp transaction.

phone_numberstring

Customer's phone number. You can use the banks endpoint to get a list of available banks and their codes.

network_providerstring

Customer's network provider. To fetch providers use this endpoint. Allowed Values, MTN, AIRTEL, and VODAFONE.

Response

200

statusstring

messagestring

Example response

{
  "status": "ok",
  "message": "Mobile money deposit successfully initiated",
  "data": {
    "next_step": "PIN",
    "fee": "23.0",
    "amount": "1000.0",
    "instruction": "You will receive a prompt on your mobile number ******7778 to enter your PIN to authorize your payment request of GHS 1000 to SB_fjjfjjff",
    "currency": "ghs"
  }
}