developer:soap:methods:getsupportedcurrencies

Soap API v1.2

getSupportedCurrencies

Retrieves an array of currencies supported by a merchant account.

Description

Depending on the merchant account configuration, different currencies are available for multi-currency processing. This method will return an array containing the currencies that are supported by the merchant account.

If multi-currency processing is not supported, the array will be empty.

To view the account details for a particular merchant account, including whether or not the account supports multi-currency processing, use the getAccountDetails method.

Each currency type is assigned a three digit numeric code (ie: USD=840, Japanese yen=392). You must enter the three digit code for both the original currency and the converted currency in a conversion. The Currency Code list provides all of the three digit codes and their corresponding currencies for international currency conversion.

If you would like to add support for multi-currency transactions to a merchant account please contact the merchant's service provider or customer service.

See also currencyConversion, bulkCurrencyConversion, getAccountDetails

Syntax

CurrencyObject getSupportedCurrencies ( ueSecurityToken Token )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.

Return Value

CurrencyObject Returns an array of currencies supported by the merchant account for use with multi-currency processing.

Examples

PHP

For directions on how to set up the WSDL link and create “$token” and “$client,” see the PHP Soap guide.

<?php 
 
try { 
 
  $currencies = $client->getSupportedCurrencies($token); 
  print_r($currencies);                             
  } 
 
catch(SoapFault $e) { 
  die("soap fault: " .$e->getMessage(). "\n\nRequest: " .   
  $this->client->__getLastResponse());         
} 
 
?>     

PHP Pear::SOAP

For directions on how to set up the WSDL link and create “$token” and “$client,” see the PHP Pear Soap guide.

NOTE: A bug in PEAR::Soap version 0.11.0 causes the first two currencies to be dropped. To correctly use getSupportedCurrencies you must remove the comment on line 786 of SOAP/Base.php.

<?php
 
$params=array("Token"=>$token);
 
$currencies=$client->call('getSupportedCurrencies', $params);
 
print_r($currencies);
 
?>
developer/soap/methods/getsupportedcurrencies.txt · Last modified: 2009/07/06 10:23 by epouchak

Page Tools