Currency Exchange Endpoint

The Currency Exchange endpoint allows you to get the exchange of any local currency compared against USD

Currency Exchange

GET https://api-stg.lime-pay.com/v3/exchange_rates?country={country}&amount={amount}

The exchange_rates endpoint allow you to get the exchange of any currency compared against USD.

Query Parameters

Name

Type

Description

country

string

Country ISO code in whose local currency the amount will be converted to.

amount

number

Amount to convert in USD. If none is specified, 1 will be assumed.

Headers

Name

Type

Description

Authorization

string

"Bearer " + Read-Only API Key

Example request

curl --location --request GET 'https://api-stg.lime-pay.com/v3/exchange_rates?country=VN&amount=1' \
--header 'Authorization: Bearer your_read_only_key_here'

import java.io.*;
import okhttp3.*;

public class main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    Request request = new Request.Builder()
      .url("https://api-stg.lime-pay.com/v3/exchange_rates?country=VN&amount=10")
      .method("GET", null)
      .addHeader("Authorization", "Bearer your_read_only_key_here")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

using System;
using RestSharp;

namespace HelloWorldApplication {
    class HelloWorld {
        static void Main(string[] args) {
            var client = new RestClient("https://api-stg.lime-pay.com/v3/exchange_rates?country=VN&amount=10");
            client.Timeout = -1;
            var request = new RestRequest(Method.GET);
            request.AddHeader("Authorization", "Bearer your_read_only_key_here");
            IRestResponse response = client.Execute(request);
            Console.WriteLine(response.Content);
        }
    }
}

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-stg.lime-pay.com/v3/exchange_rates?country=TH&amount=10",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer your_read_only_key_here"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

{
    "fx_rate": 26118.7500,
    "currency": "VND",
    "converted_amount": 26118.7500
}

Please find all the country codes in the Countries Specifications section.

Response fields

Field name

Format

Description

fx_rate

Number

Currency exchange

currency

String

Currency used for the conversion

converted_amount

Number

Amount resulting from multiplying the amount you sent with the fx_rate

Last updated 1 year ago

Was this helpful?

hashtagCurrency Exchange

hashtagQuery Parameters

hashtagHeaders

hashtagExample request

hashtagResponse fields