Full-page checkout

Hosted pages

This allows you to redirect your users to a separate payment checkout page.

With the Checkout Redirect option, you can access the LocalRamp payment gateway by making a request from your server to our initiate checkout endpoint. We would return a response that includes a Checkout URL that loads the payment page where your users can purchase crypto. After payment is completed or canceled, the customer is returned to any URL specified by you.

1. Collect payment details

Collect payment/purchase details from your user. These details are passed to the initiate checkout endpoint.

Please find below the request body for the endpoint.

FieldData TypeDescription



Required - Your unique transaction reference. Must be unique for every transaction. e.g "Abc123"



Required e.g "customer@example.com"



Required - The currency your user would be paying in. e.g "NGN"



Required - The country_code of the user paying in e.g "NG", "KE", "GH", "ZM"



Required - usdt amount you want to receive e.g "200.00".



Optional - The url to redirect your users to, when the transaction is complete

Before passing inusdt_amount, you'll need to know the maximum and minimum values allowed for a sender_currency. See limit section.

To get the list of supported currencies and country codes see the Get currencies section

2 - Initialize the transaction

After collecting the necessary payment details for the transaction. Make a POST request to our initiate buy endpoint.


This endpoint takes the payment details as the request body.

With the following header

x-auth-token: <SECRET_KEY>

This endpoint is protected by secret key authentication. So when calling it, append the x-auth-token header with your secret key.

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

    "status": "success",
    "data": {
        "reference": "ref27",
        "checkout_link": "https://pay.localramp.co/too8909gY"

You should then redirect your user to the Checkout URL provided in the response to enable them to complete their payment.

You can also choose to open the checkout link in an iframe

<iframe src="https://pay.localramp.co/too8909gY" frameborder="0" width="350" height="500" allow="clipboard-read; clipboard-write self *"></iframe>

Once the purchase is complete or the checkout is closed, LocalRamp will redirect your user to your specified callback_url.

3. Verifying the transaction status

The transaction reference will be appended as a query parameter to your callback_url as well.


You can now verify the status of the transaction. See verify section

In a situation where no callback_url is passed, the user will be redirected to your business website.

4. Receive confirmation via webhook

In some cases, the payout might take a few minutes to arrive. If you do not want to keep querying the transaction status, you can always get informed through webhooks when the transaction is complete. See webhook section.

Last updated