LocalRamp API Documentation
  • Introduction
  • Getting Started
  • Crypto On-ramp
    • Overview
    • Widget Pop-up
    • Full-page checkout
    • Get Limits
    • Get Supported currencies
    • Get Quote
    • List Payment Methods
    • Get Transaction State
  • CRYPTO OFF-RAMP
    • Overview
    • Direct API Sell
      • Instant Sell
      • Get Transaction State
      • Get Limits
      • Get Supported Currencies
      • Get Supported Payment Methods
      • Get Supported Banks
      • Get Crypto Balance
      • Get Rates
      • Verify Bank Account
    • Widget Sell
      • Full-page checkout
      • Widget Pop-up
      • Get Limits
      • Get Quote
      • Get Supported currencies
      • Get Supported Payment Methods
      • Get Transaction State
  • PAYMENTS ON-RAMP
    • Overview
    • Full-page checkout
    • Widget Pop-up
    • White-Label API (Direct Charge)
    • Rates and Fees
    • Get Limits
    • Get Supported Currencies
    • Get Supported Payment Method
    • Withdraw crypto
    • Verify crypto withdrawal
    • Verify transaction
    • Get USDT balance
    • KYC
      • BVN Verification
      • Send OTP
  • Institutional Onramp (>$100k)
    • Overview
    • Initiate transaction
    • Complete transaction
    • Fetch transation
    • Exchange Rate
  • CRYPTO SWAPS
    • Overview
    • Instant Swap
    • Get Transaction State
    • Get Limits
    • Get Supported Currencies
    • Get Rates
  • Webhooks
    • Introduction
    • Verification
    • Events
  • TEST INTEGRATION
    • Simulate Webhooks
      • Fiat received (onramp)
      • Crypto Sent (onramp)
      • Sell completed (offramp)
      • Swap completed
    • Demo transaction
      • Example Completed Buy
      • Example Completed Sell (Bank Account)
      • Example Completed Sell (Mobile Money)
      • Example Completed Swap
Powered by GitBook
On this page
  1. Crypto On-ramp

Get Quote

Before initializing a buy transaction, you might want to know what price the token is being traded at. Make a GET request to the following endpoint.

https://api.localramp.co/v1/transaction/buy/quote?sender_currency=NGN&receiver_currency=USDT_BSC&country_code=NG

The request takes sender_currency ,receiver_currency and country_code as query params.

With the following header

x-auth-token: <PUBLIC_KEY>

If the API call is successful, LocalRamp returns the following response:

{
    "status": "success",
    "data": {
        "rate": {
            "sender_currency": "NGN",
            "receiver_currency": "USDC_BSC",
            "partner_fee": {
                "type": "PERCENT",
                "fee": 0
            },
            "processor_fee": {
                "type": "FLAT",
                "fee": "100.00"
            },
            "network_fee": "1.14510001",
            "exchange_rate": "754.6558",
            "market": "BUY"
        },
        "info": {
            "partner_fee": "Merchant fee in percent",
            "processor_fee": "Fee LocalRamp Charges (NGN)",
            "network_fee": "Fee required to send coin on blockchain (USDC_BSC) ~Estimate",
            "exchange_rate": "Price LocalRamp will buy your crypto at"
        }
    }
}

processor_fee is what LocalRamp charges in local currency fiat i.e NGN, GHS. It will be deducted from whatever the user sends.

network_fee is an estimate of the blockchain network fees. Unit is in receiver_currency i.e BTC, USDT

exchange_rate is the purchase price of the coin.

partner_fee refers to extra fees you might wish to charge your users. This is automatically infused into your rates. Earnings from partner fees are sent straight to your USDT wallet weekly. To set this up, reach out to business@localramp.co

Rate Calculation

To calculate how much you would eventually receive for any sender amount

receiver_amount = ((sender_amount - processor_fee) / exchange_rate) - network_fee

Rates for our on-ramp are locked, so you should expect to receive the exact amounts (except in rare cases with high volatility of asset)

PreviousGet Supported currenciesNextList Payment Methods

Last updated 8 months ago