HOhoneycoin

Mobile Money Charge

Changed on

Initiates a mobile money charge request for transactions. Charge initiation is asynchronous. A pending transaction may later report stepRequired: "ussd" via webhook or Get Transaction, with stepMetadata.ussdCode, an optional description, and optional expiry in Unix milliseconds. The customer dials the returned code and completes the prompts on their phone. No OTP validation or USSD confirmation request is required. Confirm final payment status before fulfillment.

post/api/b2b/fiat/deposit/momo

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/fiat/deposit/momo
  • Auth
    API key in header Authorization

Request body

amountinteger required
phoneNumberstring

In ISO Format - '+' example: 254719624551

currencystring required
externalReferencestring required

A unique ID of your liking to reconcile transactions internally.

momoOperatorIdstring

Some currencies require operator specification. This can be retrieved from the mobile money operators list found under here: https://docs.honeycoin.app/docs/mobile-money-operators

otpCodestring

One-time payment code required by some operators before charge initiation. Follow the operator-specific customer instructions for the market you are collecting in and pass the generated code here.

externalAccountIdstring

Used to pass the information of an existing external account. See external accounts.

walletCurrencystring

The currency to settle funds into. Defaults to currency.

voucherPinstring

Required for Botswana (BWP) ott voucher charhes

successRedirectUrlstring uri

Optional URL to return the customer to after a successful payment redirect, where supported.

failureRedirectUrlstring uri

Optional URL to return the customer to after a failed payment redirect, where supported.

walletCountrystring

Settlement wallet country. Required whenever walletCurrency is XOF. Optional otherwise, including USD. Send a two-letter country code; surrounding whitespace is trimmed and letters are uppercased.

Response

200

successboolean
messagestring
transactionIdstring

Example response

{
  "success": true,
  "message": "Initiated request.",
  "transactionId": "123456789"
}

Changes

  • fcb58b0ef441Revision changes
    • breaking

      added subschema #1 subschema #2 to the request body allOf list

    • breaking

      added the pattern ^https?:// to the request property

    • breaking

      added the pattern ^https?:// to the request property

    • info

      added the new optional request property

    • info

      the request property became optional