GoCardlessDeveloper Docs
Create a sandbox account

Currency Exchange Rate

View as Markdown

Currency exchange rates from our foreign exchange provider.

List exchange rates#

GET/currency_exchange_rates

Returns a cursor-paginated list of all exchange rates.

Query Parameters

NameTypeDescription
beforestring | null

Cursor pointing to the end of the desired set.

afterstring | null

Cursor pointing to the start of the desired set.

limitinteger | string

Number of records to return.

sourcestring
targetstring
GET https://api.gocardless.com/currency_exchange_rates?source=GBP&target=EUR HTTP/1.1
@client.currency_exchange_rates.list(params: { source: "EUR", target: "GBP" })
client.currency_exchange_rates.list(params={"source": "EUR", "target": "GBP"}).records
const currencyExchangeRates = await client.currencyExchangeRates.list();

// List the currency exchange rate for a source and target currency.
const filteredRates = await client.currencyExchangeRates.list({ source: 'EUR', target: 'GBP' });
$client->currencyExchangeRates()->list([
  "params" => ["source" => "EUR", "target" => "GBP"]
]);
client.currencyExchangeRates().all().withSource("EUR").withTarget("GBP").execute();
currencyExchangeRateListParams := gocardless.CurrencyExchangeRateListParams{
  Source: "EUR",
  Target: "GBP",
}

currencyExchangeRateListResult, err := client.CurrencyExchangeRates.List(ctx, currencyExchangeRateListParams)
for _, currencyExchangeRate := range currencyExchangeRateListResult.CurrencyExchangeRates {
    fmt.Println(currencyExchangeRate.Rate)
}
var request = new GoCardless.Services.CurrencyExchangeRateListRequest()
{
    Source = "EUR",
    Target = "GBP"
};

var response = client.CurrencyExchangeRates.All(request);
foreach (GoCardless.Resources.CurrencyExchangeRate rate in response)
{
    Console.WriteLine(rate.Rate);
}
Responsehttp
HTTP/1.1 200 OK
Content-Type: application/json
{
    "currency_exchange_rates": [
        {
            "rate": "1.19111",
            "source": "GBP",
            "target": "EUR",
            "time": "2020-02-24T23:50:04.000Z"
        }
    ],
    "meta": {
        "cursors": {
            "after": null,
            "before": null
        },
        "limit": 50
    }
}
Response 200

Successful response

currency_exchange_ratesarray
4 properties
sourcestring

Source currency

targetstring

Target currency

ratestring

The exchange rate from the source to target currencies provided with up to 10 decimal places.

timestring

Time at which the rate was retrieved from the provider.

metaobject
2 properties
limitintegerrequired
cursorsobjectrequired
2 properties
beforestring | nullrequired

Cursor pointing to the end of the desired set.

afterstring | nullrequired

Cursor pointing to the start of the desired set.

Errors 400401404422500
400

Bad Request

401

Unauthorised

404

Not found

422

Validation Error

500

Internal Error

Error Body
errorobjectrequired

Generic error

6 properties
codeinteger
documentation_urlstring
errorsarrayrequired
6 properties
reasonstring
fieldstring
request_pointerstring
messagestringrequired
metadataobject
linksobject
messagestringrequired
request_idstringrequired
typestring