Skip to content

Set Currency Exchange Rates

PATCH /service/set_currency_exchange_rates

With this endpoint you can set the currency exchange rates in your configuration such as "EUR Exchange Rate to USD".

Description URL Response Format Request Method Authentication
Sets currency exchange rates in your configuration https://domain/api/service/set_currency_exchange_rates JSON PATCH HTTP headers

Parameters

Name Description Type Required
base base currency to set rates for string yes
rates Array of other currencies with the conversion rate to the "base" parameter above. GET yes

Example Code

php

<?php 
$url = 'http://domain/api/service/set_currency_exchange_rates';
$curl = curl_init(); 

$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);  


$data = Array(
    'base' => 'USD',
    'rates' => Array(
        'EUR' => 0.8639308856,
        'AUD' => 1.4094168468,
        'CAD' => 1.3047084234,
    ),
);                                                  

$data_string = http_build_query($data);
$url .= '?'.$data_string;

curl_setopt($curl, CURLOPT_GET, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url); 


$resp = curl_exec($curl); 
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
    //json was valid. Dump the decoded array
    print_r($output);
}
else {
    //invalid json, just dump the raw response
    print_r($resp);
}
// Close request to clear up some resources 
curl_close($curl); 
?>

Example Output

Array
(
    [result] => success
    [message] => Saved new rates to config. EUR: 0.8639308856; AUD: 1.4094168468; CAD: 1.3047084234;
)