Settlement Rates

Details on obtaining current indicative settlement rates

You can receive settlement rates applied during payout using this API. Please note that these rates are indicative and actual settlement rates may vary based on settlement time. Based on these rates, you can set you own exchange rate and provide them per transaction during transaction creation. The exchange rate provided during transaction creation is the customer exchange rate and can vary from the settlement rate.

GET /v2/settlement-rates/

You can use the following filter parameters to filter out responses are per your requirement.

1. GET {{url}}/settlement-rates/?payout_method={{payout_method}}

2. GET {{url}}/settlement-rates/?destination_currency={{destination_currency}}

3. GET {{url}}/settlement-rates/?destination_country_code={{destination_country.code}}

4. GET {{url}}/settlement-rates/?payout_method={{payout_method}}&destination_country_code={{destination_country.code}}

Parameters

Field	Type	Description
source_country	Object	Source country
source_country.name	String	Name of source country
source_country.code	String	2-character ISO code of the source country
source_currency	String	3-character ISO code of the country
destination_country	String	Destination country
destination_country.name	String	Name of destination country
destination_country.code	String	2-character ISO code of the destination country
destination_currency	String	3-character ISO code of the country
payout_method	String	Delivery method for which the settlement rate is applicable
settlement_rate	Number	Indicative settlement rate in destination currency

Request Sample

curl --location GET '{{url}}/v2/settlement-rates/' \
--header 'X-Client-Id: clientid’\
--header 'X-Client-Secret: clientsecret’\
--header 'Content-Type: application/json'

Response Sample

{
    "rates": [
{
            "source_currency": "USD",
            "destination_currency": "USD",
            "payout_method": "BANK_DEPOSIT",
            "settlement_rate": 1.0000,
            "source_country": {
                "name": "United States",
                "code": "US"
            },
            "destination_country": {
                "name": "Nigeria",
                "code": "NG"
            }
        },
       {
            "source_currency": "USD",
            "destination_currency": "GTQ",
            "payout_method": "WALLET",
            "settlement_rate": 7.8060,
            "source_country": {
                "name": "United States",
                "code": "US"
            },
            "destination_country": {
                "name": "Guatemala",
                "code": "GT"
            }
        },
        {
            "source_currency": "USD",
            "destination_currency": "GTQ",
            "payout_method": "BANK_DEPOSIT",
            "settlement_rate": 7.7291,
            "source_country": {
                "name": "United States",
                "code": "US"
            },
            "destination_country": {
                "name": "Guatemala",
                "code": "GT"
            }
        }      
           ]
}