This API call lets 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
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 |
0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |