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 Transaction State

After the modal is closed, you should fetch the transaction to know the current status. Make a GET request to the following endpoint.

https://api.localramp.co/v1/transaction/buy/status/:reference

With the following header

x-auth-token: <SECRET_KEY>

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

{
    "status": "success",
    "data": {
        "reference": "my-unique-ref",
        "state": "completed",
        "txid": "<txID>",
        "received_amount": "0.7382747",
        "receiver_currency": "BTC_BTC",
        "sent_amount": "10000",
        "sender_currency": "NGN",
        "destination_address": "<address>",
        "destination_tag": null,
        "email": "test@example.com",
        "payment_method": "bank_transfer", //mobile_money
        "source_account_bank": "Wallet Bank"
        "phone_network": "MTN",
        "phone_number":"+2340000000",
    }
}

The possible state's are awaiting_payment, pending and completed

awaiting_payment - This means we are yet to receive payment from the customer.

pending - This means we have received payment and we are processing the request

completed - This means that the transaction has been completed

sent_amount is the fiat amount sent by the user minus localramp fees.received_amount is the amount in crypto sent to the wallet. Note that these are different from the sender_amount and receiver_amountused in initiating the transaction.

PreviousList Payment MethodsNextOverview

Last updated 4 months ago