Create Account API

createAccount

Synopsis:

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.

Request: XML

<request>
    <action>createAccount</action>
    <api_key>API key</api_key>
    <account-category>'master' or 'subaccount'</account-category>
    <master-account-id>master account ID</master-account-id>
    <master-account-name>master account name</master-account-name>
    <account-name>account name</account-name>
    <login-email>login email address</login-email>
    <login-password>login password</login-password>
    <plan-id>plan ID</plan-id>
    <brand-name>brand name</brand-name>
    <brand-type>brand type</brand-type>
    <brand-logo>brand logo URL</brand-logo>
    <brand-website>brand website</brand-website>
    <brand-nicknames>brand nicknames</brand-nicknames>
    <brand-address>brand address</brand-address>
    <brand-city>brand city</brand-city>
    <brand-state>brand state</brand-state>
    <brand-zip>brand zip code</brand-zip>
    <country-id>country ID</country-id>
</request>

Request: GET

API_URL?action=createaccount
&api_key=API key
&account-category='master' or 'subaccount'
&master-account-id=master account ID
&master-account-name=master account name
&account-name=account name
&login-email=login email address
&login-password=login password
&plan-id=plan ID
&brand-name=brand name
&brand-type=brand type
&brand-logo=brand logo URL
&brand-website=brand website
&brand-nicknames=brand nicknames
&brand-address=brand address
&brand-city=brand city
&brand-state=brand state
&brand-zip=brand zip code
&country-id=country ID

Request Parameters:

Sub-account
Mandatory: action, api_key, master-account-id, master-account-name, account-name, login-email, login-password, plan-id
Optional: account-category, brand-name, brand-type, brand-logo, brand-website, brand-nicknames, brand-address, brand-city, brand-state, brand-zip, country-id

Master Account
Mandatory: action, api_key, account-name, login-email, login-password, plan-id, country-id, brand-type
Optional: account-category, brand-name, brand-type, brand-logo, brand-website, brand-nicknames, brand-address, brand-city, brand-state, brand-zip, country-id

Response Parameters:

status, username, password, api_key, userid, errorCode, errorInfo

Request Example: XML

Sub-account
<request>
    <action>createAccount</action>
    <api_key>qtfkyko9jtfahcoqj0v2wf5cg1t8iwlz</api_key>
    <account-category>subaccount</account-category>
    <master-account-id>31126</master-account-id>
    <master-account-name>bob</master-account-name>
    <account-name>bob491823102</account-name>
    <login-email>bob@skycore.com</login-email>
    <login-password>bob42713</login-password>
    <plan-id>1</plan-id>
</request>

Master Account
<request>
    <action>createAccount</action>
    <api_key>qtfkyko9jtfahcoqj0v2wf5cg1t8iwlz</api_key>
    <account-category>master</account-category>
    <account-name>bob32094324</account-name>
    <login-email>bob@skycore.com</login-email>
    <login-password>bob42713</login-password>
    <plan-id>1</plan-id>
    <brand-name>Skycore LLC</brand-name>
    <brand-type>2</brand-type>
    <brand-logo>https://www.skycore.com/skycore-logo</brand-logo>
    <brand-website>https://www.skycore.com</brand-website>
    <brand-nicknames>Skycore</brand-nicknames>
    <brand-address>397 Moody St.</brand-address>
    <brand-city>Waltham</brand-city>
    <brand-state>MA</brand-state>
    <brand-zip>02453</brand-zip>
    <country-id>7</country-id>
</request>

Request Example: GET

Sub-account
https://secure.skycore.com/API/wxml/1.3/index.php?action=createaccount
&api_key=qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ
&account-category=subaccount
&master-account-id=31126
&master-account-name=bob
&account-name=bob491823102
&login-email=bob@skycore.com
&login-password=bob42713
&plan-id=1

Master Account
https://secure.skycore.com/API/wxml/1.3/index.php?action=createaccount
&api_key=qTFkykO9JTfahCOqJ0V2Wf5Cg1t8iWlZ
&account-category=master
&account-name=bob32094324
&login-email=bob@skycore.com
&login-password=bob42713
&plan-id=1
&brand-name=Skycore LLC
&brand-type=2
&brand-logo=https://www.skycore.com/skycore-logo
&brand-website=https://www.skycore.com
&brand-nicknames=Skycore
&brand-address=397 Moody St.
&brand-city=Waltham
&brand-state=MA
&brand-zip=02453
&country-id=7

Response Example: Success

<response>
    <status>Success</status>
    <username>bob491823102</username>
    <password>42363deef6129efa1dc0a54b26cf1426</password>
    <api_key>umfkkslcdki9yj5b7fdbk5i8eqaoq88l</api_key>
    <userid>150265</userid>
</response>

Response Example: Failure

<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:

Related Error Codes:

Key Term Definitions:

Country: