This API is used to create a new account. In order to use this API, the account must have this API enabled. Please contact your account manager for more information.
There are two types of accounts that can be created: master and sub-account. For creating sub-accounts, the master account ID and name are required in the request. The sub-accounts will inherit all the properties and brand information from the API key account (unless specified in the request) upon creation. The subaccounts’ transactions will be billed on the master account. For creating master accounts, the master account ID and name are ignored.
The account name passed within the request will be the name of the newly created account. The login email and password passed within the request will be used to log into the account. If the login email does not already exist within our system, then the login email will be created with the password. If the login email does exist, then the password passed in the request is simply ignored and the user’s current password will be used to log in. The account will be under a plan based on the plan ID which can be requested from your account manager.
The API contains several brand information requests for the account, such as the brand name/nicknames, logo, website, address, city, state, zip, and country. The brand type identifies the type of organization (university, business, etc.) which can be requested from your account manager. The country is set by passing the country ID which can be found here.
This is the name of the function you want to execute with the API.
API_KEY
Mandatory
Random key that is assigned to an account that can be used for authorization instead of USER/PASS. You can find and regenerate this key on the ‘API Settings’ page.
ACCOUNT-CATEGORY
Optional
This request is used to define whether the account is a master account or sub-account.
MASTER-ACCOUNT-ID
Mandatory if Sub account
The ID of the master account for the sub-account to be created.
MASTER-ACCOUNT-NAME
Mandatory if Sub account
The name of the master account for the sub-account to be created.
ACCOUNT-NAME
Mandatory
The name of the account to be created.
LOGIN-EMAIL
Mandatory
The login email address used to log into the account.
LOGIN-PASSWORD
Mandatory
The login password for the login email used to log into the account.
PLAN-ID
Mandatory
The unique ID of the plan which the account will be under. Please ask your account manager for more details.
BRAND-NAME
Optional
The brand name for the account.
BRAND-TYPE
Mandatory if Master account. Optional if Sub account.
The unique ID of the brand type for the account. Please ask your account manager for more details.
BRAND-LOGO
Optional
The brand logo for the account.
BRAND-WEBSITE
Optional
The URL of the brand website for the account.
BRAND-NICKNAMES
Optional
The brand nicknames for the account.
BRAND-ADDRESS
Optional
The brand address for the account.
BRAND-CITY
Optional
The brand city for the account.
BRAND-STATE
Optional
The brand state for the account.
BRAND-ZIP
Optional
The brand zip for the account.
COUNTRY-ID
Optional
The unique ID of the country for the account.
Response Parameters:
Param Name
Presence
Description
STATUS
Always
“Success” or “Failure”.
API_KEY
Success Response Only
Random key that is assigned to an account that can be used for authorization instead of USER/PASS. You can find and regenerate this key on the ‘API Settings’ page.
<response>
<status>Failure</status>
<errorcode>E149</errorcode>
<errorinfo>The master account is a sub-account and cannot create new accounts.</errorinfo>
</response>
General Error Codes:
Code
Description
E100
Invalid request. Make a valid request via GET/POST/XML with all the required variables.
E104
User Authentication Failed.
E105
This account has no API rights.
E106
You can call API every X seconds.
E107
This account has no rights to use this action.
E108
XML Parse error: $error.
E109
API not activated.
E112
IP was not whitelisted. API call rejected.
E113
Set throughput exceeded for this API action. API call rejected.
E114
Phone number is blacklisted. API call rejected.
E120
Account has reached the API request limit.
E503
Internal error.
Related Error Codes:
Code
Description
E141
The API key account and master account are not related.
E142
The account-name value is required.
E143
The account-name value is already taken.
E144
The login-password value is required.
E145
The login-email value is invalid.
E146
The login-email value is required.
E148
The master account is invalid.
E149
The master account is a sub-account and cannot create new accounts.