---
title: "On-ramp Sdk"
method: POST
path: "/api/minting/onramp/sdk"
---

# On-ramp Sdk

`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`

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.

## Request body

- object
  - `senderAmount` integer, required: The amount of fiat currency to charge the customer.
  - `senderCurrency` string, required: The fiat currency to be charged. This must be a supported currency.
  - `receiverCurrency` string, required: The cryptocurrency to be settled. Currently, only USDC and USDT are supported.
  - `chain` string, 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
  - `email` string: The customer's email address. Optional, but highly recommended for sending transaction receipts.
  - `receiverAddress` string, required: The destination on-chain wallet address for the crypto settlement. This address must be valid on the specified chain.
  - `externalReference` string, 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.
  - `successRedirectUrl` string: Where to redirect the user on a successful deposit
  - `cancelRedirectUrl` string: Where to redirect the user after cancelling the transaction
  - `failureRedirectUrl` string: Where to redirect the user on a failed deposit
  - `country` string: Required when the chargeCurrency is XOF e.g BJ, SN etc

## Response `200`

200

- object
  - `success` boolean
  - `message` string
  - `data` object
    - `transactionId` string
    - `paymentSdkLink` string

---

[API](https://skmtc.dev/honeycoin/apis/honeycoin-crypto-api.md) - [All operations](https://skmtc.dev/honeycoin/apis/honeycoin-crypto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/honeycoin/apis/honeycoin-crypto-api/revisions/420578caf183?raw)