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 OFF-RAMP
  2. Direct API Sell

Instant Sell

You can sell your crypto for fiat which gets instantly paid to bank accounts. To do this, Make a POST request to the following endpoint.

https://api.localramp.co/v1/transaction/sell/initiate

Please find below the request body for the endpoint.

Field
Data Type
Description

tx_ext_reference

String

Required - your unique reference for the transaction

email

String

Required - e.g "dinesh@piedpiper.xyz"

from_currency

String

Required - e.g "BTC"

to_currency

String

Required e.g "NGN", "GHS"

country_code

String

Required e.g "NG", "GH"

from_amount

String

Required - amount of from_currency to be sold e.g "0.235"

destination_type

String

Required - "bank_account" or "mobile_money"

account_number

String

Optionally Required - required for destination_type of bank_account e.g "012345678"

bank_code

String

phone_number

String

Optionally Required - required for destination_type of mobile_money e.g "+23312345677"

phone_network

String

With the following header

x-auth-token: <SECRET_KEY>

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

{
    "status": "success",
    "data": {
        "tx_ext_reference": "youReference",
        "reference": "SELL_hDUkDSE36MHkds79",
        "account_name": "RAJI JOHNSON",
        "bank_name": "UNITED BANK"
    }
}

Store the tx_ext_reference returned which would be used to verify the transaction.

PreviousDirect API SellNextGet Transaction State

Last updated 10 months ago

Optionally Required - required for destination_type of bank_account. Check e.g "012"

Optionally Required - required for destination_type of mobile_money. Check e.g "mobile_money_mtn"

If this request fails (including 5xx errors), always that the transaction has not been created before giving any value. Use tx_ext_reference

verify
Get Supported Banks
Get Supported Payment Methods