Onramp Quickstart

Convert customer fiat into crypto delivered to a wallet address. Use a single POST /orders endpoint; order type is inferred from the quote legs (fiat from → crypto to).

All write endpoints require a secret key (sk_*) and HMAC request signing. Examples assume you have set CLIENT_ID, SECRET_KEY, ENC_KEY, and computed TIMESTAMP / SIGNATURE.

Prerequisites

KYB-approved partner account with API keys (pk_*, sk_*, enc_*)
KYC completed on the end user, preferably via a KYC provider (required for onramp)
A valid customer wallet address on the target network
Authentication and signing implemented

End-to-end flow

Create a quote

Reserve an exchange rate for a fiat amount and target crypto currency/network.

Create the order

Submit the quote ID, recipient wallet, and customer details via POST /orders.

Collect fiat payment

Present payin deposit instructions (bank account) from the order response to your customer.

Wait for payment confirmation

Liquidramp auto-detects the transfer. Optionally call POST /orders/:reference/fulfill with the bank reference if confirmation is delayed.

Track settlement

Poll GET /orders/:reference or subscribe to webhooks for order.settled.

1. Create a quote

curl -X POST "$BASE_URL/orders/quote" \
  -H "Content-Type: application/json" \
  -H "liquidramp-client-id: $CLIENT_ID" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "liquidramp-timestamp: $TIMESTAMP" \
  -H "liquidramp-signature: $SIGNATURE" \
  -d '{
  "from": { "currency": "NGN", "amount": 50000 },
  "to": { "currency": "USDT", "network": "BSC" },
  "partner_fee": 0
}'

Save data.quote_id from the response. Quotes expire — create the order promptly. See Quotes.

2. Create the order

curl -X POST "$BASE_URL/orders" \
  -H "Content-Type: application/json" \
  -H "liquidramp-client-id: $CLIENT_ID" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "liquidramp-timestamp: $TIMESTAMP" \
  -H "liquidramp-signature: $SIGNATURE" \
  -d '{
  "quote_id": "QUOTE_ID_FROM_STEP_1",
  "merchant_reference": "merchant-ref-001",
  "recipient": { "address": "0x34DF48981ce4d1899a2b1139CC0fDDb6951C4053" },
  "customer": {
    "reference": "cust-001",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "+2348012345678"
  }
}'

The response includes reference, type, from, to, pricing, optional fee, status, and payin. There is no wallet-management API. Pass the customer’s destination as recipient.address. The network is taken from the quote’s to.network leg. Validate address format and chain before creating the order — sending to the wrong network is irreversible. Present payin deposit instructions to the customer:

"payin": {
  "currency": "NGN",
  "account_name": "Liquidramp Collections",
  "account_number": "1234567890",
  "institution_code": "000013",
  "amount": 50000,
  "expires_at": "2026-06-27T13:00:00.000Z",
  "paid_at": null
}

3. Confirm pay-in (optional)

Liquidramp auto-detects and confirms the customer’s bank transfer. Call fulfill only if confirmation is delayed:

curl -X POST "$BASE_URL/orders/ORD-REFERENCE/fulfill" \
  -H "Content-Type: application/json" \
  -H "liquidramp-client-id: $CLIENT_ID" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "liquidramp-timestamp: $TIMESTAMP" \
  -H "liquidramp-signature: $SIGNATURE" \
  -d '{
  "reference": "bank-tx-ref-001",
  "institution": "gtbank"
}'

institution is optional. After confirmation, crypto is released to recipient.address.

4. Poll or listen

curl -X GET "$BASE_URL/orders/ORD-REFERENCE?include=payout,timeline" \
  -H "liquidramp-client-id: $CLIENT_ID" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "liquidramp-timestamp: $TIMESTAMP" \
  -H "liquidramp-signature: $SIGNATURE"

Prefer webhooks over tight polling in production.

Endpoint	Method	Purpose
`/orders/quote`	POST	Reserve rate
`/orders`	POST	Create onramp order
`/orders/{reference}/fulfill`	POST	Optional pay-in proof if confirmation is delayed
`/orders/{reference}`	GET	Order status

Introduction

Getting Started

Quickstarts

Liquidity Providers

Resources

Prerequisites

End-to-end flow

1. Create a quote

2. Create the order

3. Confirm pay-in (optional)

4. Poll or listen

​Prerequisites

​End-to-end flow

​1. Create a quote

​2. Create the order

​3. Confirm pay-in (optional)

​4. Poll or listen

​Related

Prerequisites

End-to-end flow

1. Create a quote

2. Create the order

3. Confirm pay-in (optional)

4. Poll or listen

Related