Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Misc »

Get Account Information

This API call let's you retrieve the list of the merchant's account information. The response is an XML of the merchant's account information.

Request Fields

Field Name Type Required Description
action String Yes accountInfo
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 

Response Fields (XML)

Field Name Type Description
account - XML structure
accountId String The merchant account ID.
status Integer 1 or 0. Whether or not the account is active or not. 
businessName String The merchant's business name.
businessLegalName String The legal business name of the merchant.
myHelcimDomain String The merchant's Helcim domain.
websiteURL String The web address of the merchant's website.
address - XML structure
street1 String The merchant's street address.
street2 String The merchant's street address.
city String The merchant's city.
province String The merchant's province.
country String The merchant's country.
postalCode String The merchant's postal code.
phone String The merchant's phone number.
fax String The merchant's fax number.
email String The merchant's email address.
address - XML structure
features - XML structure
transactions Integer 1 or 0. Whether the merchant's account has the transactions feature enabled.
vt Integer 1 or 0. Whether the merchant's account has the Virtual Terminal enabled.
products Integer 1 or 0. Whether the merchant's account has the products feature enabled.
customers Integer 1 or 0. Whether the merchant's account has the customers feature enabled.
customerPortal Integer 1 or 0. Whether the merchant's account has the customer portal feature enabled.
paymentPages Integer 1 or 0. Whether the merchant's account has the payments page feature enabled.
onlineStore Integer 1 or 0. Whether the merchant's account has the online store feature enabled.
orders Integer 1 or 0. Whether the merchant's account has the orders feature enabled.
ordersOnline Integer 1 or 0. Whether the merchant's account has the online orders feature enabled.
recurring Integer 1 or 0. Whether the merchant's account has the recurring payments feature enabled.
api Integer 1 or 0. Whether the merchant's account has the api feature enabled.
apiGateway Integer 1 or 0. Whether the merchant's account has the api gateway feature enabled.
defender Integer 1 or 0. Whether the merchant's account has the Helcim defender feature enabled.
pos Integer 1 or 0. Whether the merchant's account has the POS feature enabled.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description

Code Samples

Sample Account Info Response XML

<?xml version="1.0"?>
<account>
    <accountId>8888072103</accountId>
    <status>1</status>
    <businessName>HELCIM TEAM DEMO</businessName>
    <businessLegalName>Helcim Team Corp.</businessLegalName>
    <myHelcimDomain>https://team.myhelcim.com/</myHelcimDomain>
    <websiteURL>https://www.helcim.com/</websiteURL>
    <address>
        <street1>5720 4th Street SE</street1>
        <street2>Suite 140</street2>
        <city>Calgary</city>
        <province>Alberta</province>
        <country>Canada</country>
        <postalCode>T2H 1K7</postalCode>
        <phone>877-643-5246</phone>
        <fax>866-469-3077</fax>
        <email>donotreply@helcim.com</email>
    </address>
    <features>
        <transactions>1</transactions>
        <vt>1</vt>
        <products>1</products>
        <customers>1</customers>
        <customerPortal>1</customerPortal>
        <paymentPages>1</paymentPages>
        <onlineStore>1</onlineStore>
        <orders>1</orders>
        <ordersOnline>1</ordersOnline>
        <recurring>1</recurring>
        <api>1</api>
        <apiGateway>1</apiGateway>
        <defender>1</defender>
        <pos>1</pos>
    </features>
</account>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="accountInfo">