iGolder API Reference: <SubAccountGetBalance>
The web service
<SubAccountGetBalance> is our simplest
API. Fetching your account balance may be useful if
you are an exchanger wishing to display to your customers how much available gold you have in
Fetching my account balance
A simple HTTP POST request to
the following URL https://www.iGolder.com/api.ashx is sufficient to fetch your account balance:
The SubAccountId is the identifier of the
sub-account you wish to fetch your balance, and the SecurityTokenId
is your security identifier acting as your automation password.
Each sub-account provides a
secret security token for you to use when calling our web services. In the
example above, you replace the value 16523c7d4fc44925a6a844fb919ea8b9
sub-account identifier, and 0498d220267241f2a8106b416df1ed33
security token identifier.
For extra security and convenience, we designed our automation interface to not use your login email and password. Without a security token
identifier, the automation module would require your email and password to be
hardcoded, thus exposing your iGolder password in case the code gets stolen. With iGolder, someone knowing
your secret security identifier is still unable to access your account
without your permission. You, the account owner must manually grant
access to the
IP address of the computers you
authorize to access your account via automation. To manually approve
the IP addresses, you must login using your email and password. Using a security token identifier is
also convenient, as you may change your email and/or password without
affecting your automated payments.
After invoking the web service by calling the URL https://www.iGolder.com/api.ashx,
the server iGolder.com will return you a response of the following format:
||Amount of gold available for spending. This value represents
the amount of gold which had cleared from Safetransit and can be
transferred (spent) to another account. Any gold in Safetransit is considered
unavailable, and therefore excluded from this value.
||Quantity of gold frozen in Safetransit. The frozen gold will become available for spending when the payment clears at the Safetransit closing date.
||Account balance in grams of gold. This value is the total account balance, including any gold in Safetransit™.
|Current market exchange rate of the total account balance in a
fiat currency, such as United States Dollars (USD) or Euros
(EUR), Great Britain Pound (GBP). You may add or remove fiat currencies by clicking
on the link
iGolder Settings at the top right
of the page. If you wish to know the value of your
available or frozen
gold, simply do the
The value in fiat currency is purely for convenience, and
because of the currency market fluctuation, this value changes
||Date and time at the moment the account balance was fetched.
Since the account balance may change anytime, it may be useful to
know the exact time that the balance was reported.
The time is displayed in your local time, and if incorrect, you
have to configure your timezone in your account settings.
||Public name of the sub-account. This value is returned for convenience, in case you wish to debug or troubleshoot your integration. You may change the sub-account name
anytime in the account details.
iGolder Automation Tool
If you wish to automate iGolder operations, we recommend you to enable automation
and download our test tool iGolderAutomationTool.exe.
Within minutes, you will be able to fetch your account
download your transaction history and
automate sending a
gold payment. Within one hour of work, you may
add iGolder payments to your website via our
Shopping Cart Interface.