For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Transaction State

After initiating an instant sell, you should fetch the transaction to know the current status. Make a GET request to either of the following endpoints using your tx_ext_reference OR localramp's reference.

https://api.localramp.co/v1/transaction/sell/status/:ext_reference/ext

OR

https://api.localramp.co/v1/transaction/sell/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": "our-unique-ref",
        "tx_ext_reference": "your-unique-ref",
        "status": "completed",
        "destination_type": "bank_account",
        "account_number": "0123456789",
        "bank_code": "000",
        "account_name": "RAJI JOHNSON",
        "bank_name": "UNITED BANK",
        "from_amount": "0.038058405",
        "from_currency": "BTC",
        "to_amount": "127890",
        "to_currency": "NGN",
        "phone_number":"+12345677",
        "phone_network": "mobile_money_mtn"
    }
}

The possible status's are pending , completedand failed

pending - This means we are still processing the sell transaction

completed - This means that the transaction has been completed

Last updated