HOhoneycoin

On-ramp Sdk

The On-Ramp Widget is a pre-built, embeddable user interface that allows your users to convert fiat currency into crypto assets directly within your application. Unlike the API-only integration, this fully hosted component manages the entire user journey—including amount input, real-time exchange rate display, payment method selection, and status updates. It abstracts the complexity of payment collection and blockchain settlement, delivering the equivalent USDC or USDT to the user’s wallet via a secure, low-code integration.

post/api/minting/onramp/sdk

Request

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

Request body

senderAmountinteger 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.

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.

successRedirectUrlstring

Where to redirect the user on a successful deposit

cancelRedirectUrlstring

Where to redirect the user after cancelling the transaction

failureRedirectUrlstring

Where to redirect the user on a failed deposit

countrystring

Required when the chargeCurrency is XOF e.g BJ, SN etc

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Transaction created successfully",
  "data": {
    "transactionId": "UvUQQq5zNzfdknf8Q5x",
    "paymentSdkLink": "https://checkout.honeycoin.app/sdk/transaction/UvUQQq5zNzfdknf8Q5x"
  }
}

Changes

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