Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 1.8 KB

getcurrencies.md

File metadata and controls

79 lines (61 loc) · 1.8 KB

+++ title = "GetCurrencies" toc = true +++

Obtain the Currencies configured in the System

Request Parameters

Parameter Type Description Required
action string "GetCurrencies" Required

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
totalresults int The total number of results available
currencies array The currency entries returned

Example Request (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'GetCurrencies',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

Example Request (Local API)

$command = 'GetCurrencies';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

Example Response JSON

{
    "result": "success",
    "totalresults": "1",
    "currencies[currency][0][id]": "1",
    "currencies[currency][0][code]": "USD",
    "currencies[currency][0][prefix]": "$",
    "currencies[currency][0][suffix]": " USD",
    "currencies[currency][0][format]": "1",
    "currencies[currency][0][rate]": "1.00000"
}

Version History

Version Changelog
1.0 Initial Version