Search Currency

The Search Currency provides the client with static data relating to currencies held within the GTA system. The API will provide a currency name along with the unique ISO code to identify the currency.

Example XML Search Currency request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Currency Request.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
	<Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
		<RequestorPreferences>
			<RequestMode>SYNCHRONOUS</RequestMode>
		</RequestorPreferences>
	</Source>
	<RequestDetails>
		<SearchCurrencyRequest>
			<CurrencyName><![CDATA[A]]></CurrencyName>
		</SearchCurrencyRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Currency attributes/parameters

A Search Currency request can contain optional attributes/parameters to filter the currencies returned.  However, if none are specified a request for all currencies will be executed.

The request can contain the following optional attributes/parameters: -

Parameter

Description

CurrencyName

If specified all currencies containing the given characters will be returned.

Note: Currency Name searches are not case sensitive.

CurrencyCode

ISO 3166 format, 2 letter

If specified the currency details for the single code will be returned.

Example XML Search Currency response

The XML message below gives a sample of that given by the API in response to a Currency Search Request.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200002">
	<ResponseDetails Language="en">
		<SearchCurrencyResponse>
    		<CurrencyDetails>
				<Currency Code="ARS"><![CDATA[Argentine Peso]]></Currency>
				<Currency Code="AUD"><![CDATA[Australian Dollar]]></Currency>
     	</CurrencyDetails>
		</SearchCurrencyResponse>
	</ResponseDetails>
</Response>

Search Currency response parameters

A Search Currency response will return the following for each currency found for the request parameters: -

Parameter

Description

Currency

The currency name.

In the language requested (if available).

 

Attribute

Description

 

Code

The ISO code for the currency.

Docs Navigation