HOhoneycoin

On-ramp

The on-ramp endpoint facilitates converting fiat currency into crypto assets on a specified blockchain. It processes a fiat payment from a customer and automatically settles the equivalent crypto amount (currently USDC or USDT) into an on-chain wallet address you provide. The service handles the exchange rate conversion and transaction fees, providing a seamless bridge between traditional finance and decentralised applications.

post/api/minting/onramp

Request

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

Request body

senderAmountnumber double required

The amount of fiat currency to charge the customer.

senderCurrencystring required

The fiat currency to be charged. This must be a supported currency.

receiverCurrencystring required

The cryptocurrency to be settled. Currently, only USDC and USDT are supported.

chainstring required

The blockchain network for the crypto settlement. This determines the network on which the crypto will be sent. Supported chains are ETH, ARB, BASE, MATIC, BSC, and OPTIMISM

emailstring

The customer's email address. Optional, but highly recommended for sending transaction receipts.

receiverAddressstring required

The destination on-chain wallet address for the crypto settlement. This address must be valid on the specified chain.

methodstring required

The fiat payment method. Supported values include momo (Mobile Money) and bank. The chargeDetails object will vary based on this value.

externalReferencestring required

A unique ID from your system to identify and reconcile this transaction. The API will reject requests with duplicate externalReference values to prevent double-spending.

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "transactionId": "y47aWLwUE2NW7duNNbiM"
  }
}

Changes

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