HOhoneycoin

Payouts

Changed on

This endpoint is a universal endpoint for payouts to destinations such as mobile money wallets and bank accounts. If the account has one or more active allowlisted IP addresses, production requests must originate from an allowed IPv4 address; otherwise the API returns IP_NOT_ALLOWED.

post/api/b2b/fiat/payout

Request

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

Request body

amountinteger required
currencystring
countrystring

ISO 3166-1 alpha-2 country code

destinationstring

MoMo / Bank Account

externalReferencestring required

A unique ID of your liking to reconcile transactions internally.

externalAccountIdstring
debitCurrencystring

The wallet you want to be debited from. If missing, we will default to the currency passed.

debitCountrystring

Country scope of the wallet being debited. Required whenever debitCurrency is XOF, even for same-currency payouts. Optional for other debit currencies, including USD; omit when debitCurrency is absent.

Response

200

successboolean
messagestring
transactionIdstring

Example response

{
  "success": true,
  "message": "Withdrawal Request Accepted for Processing.",
  "transactionId": "mIt5ycmF3YCqaOQp6Ljz"
}

Changes

  • fcb58b0ef441Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the request body allOf list

    • breaking

      the request property's minLength was increased from 0 to 2

    • breaking

      the / request property type changed from string to string number

    • warning

      the request property's maxLength was set to 2

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status