HOhoneycoin

Off-Ramp

The endpoint allows you to send tokens to an escrow address and get the value back in a number of different FIAT currencies.

post/api/minting/offramp

Request

  • Base URL
    https://crypto.honeycoin.app
  • URL
    https://crypto.honeycoin.app/api/minting/offramp
  • Auth
    API key in header Authorization

Request body

senderAmountnumber double required

The token amount.

senderCurrencystring required

The token currency e.g USDC/USDT

receiverCurrencystring required

The fiat currency to settle e.g KES

chain'eth' | 'arb' | 'base' | 'matic' | 'bsc' | 'optimism' | 'solana' | 'tron' | 'tempo' required

The chain to send funds from.

emailstring

The email belonging to the customer

countrystring required

The payout country in iso 2 code e.g KE, NG

destinationstring required

The payout destination e.g Mobile Money (MoMo), Bank Account, Paybill and Till.

externalReferencestring required

A unique ID of your liking to reconcile transactions internally.

refundAddressstring

The on-chain address specified here is where funds will be returned if a payout fails. If no refund address is provided, the funds will be automatically sent back to the sender's address. ↩️ The refund address must be on the same blockchain as the specified chain above.

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "transactionId": "VCs2cihgfk2Xs8QVnQP1",
    "addressId": "duAHpYjgjfnZ6wAY8R8m",
    "address": "0x2942ea22d9ff167463f4fa5d2fc8d7117f0cc399",
    "expiresAt": 1751619606288
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.