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

# On-ramp

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

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.

## Request body

- object
  - `senderAmount` number, double, 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.
  - `method` string, required: The fiat payment method. Supported values include momo (Mobile Money) and bank. The chargeDetails object will vary based on this value.
  - `chargeDetails` object, required: An object containing payment method-specific details.
    - `phoneNumber` string: Required when the method is momo. The customer's mobile number, including the country code (e.g., 254712345678 for Kenya).
    - `momoOperatorId` string: Required when the method is momo. The ID of the mobile money operator (e.g., MPESA)
    - `email` string: Required when method is bank. e.g test@gmail.com
  - `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.

## Response `200`

200

- object
  - `success` boolean
  - `data` object
    - `transactionId` 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)