Update Account Information

The data to be submitted to the API is composed of the following fields:

Notes:

• The account_id cannot be changed -- It needs to be provided to identify which account is being edited.
• 'agency' is the ID of the agency under which this client belongs.
• The contact_ and biz_ fields are information about the client, except for the contact_email ( which is the agency's email contact -- this isdue to historical and legacy billing reasons -- this is the email to which the bill is sent from the billing system.)
• The client's email field is the client_email, NOT the contact_email (see above)
• You can find a list of language two-letter codes in the Available Languages reference page
• You can find a list of currency codes in the Currency Codes reference page
• You can find a list of timezone codes in the Timezones reference page
• The activate parameter is optional and used only for those agencies that do not allow trial clients to automatically become billable once they pass 10 customers. For those agencies, specifying activate=Y will activate the trial client and allow them to pass the 10-customer limit.
• Legacy use of type=process_owner_account, action=edit is still valid, but deprecated.

Example PHP Request:

If you are using PHP, the $data array would look like this:

        $data['user_id'] = 'john1970';
        $data['user_password'] = '1959caadac9b13dcb3';
        $data['type'] = account_update';
        $data['agency'] = 'demo_agency';
        $data['contact_email'] = 'contact@demo_agency.com';
        $data['contact_first_name'] = 'John';
        $data['contact_last_name'] = 'Doe';
        $data['contact_phone'] = '555-555-2455';
        $data['client_email'] = 'john@widgets.com';
        $data['biz_name'] = 'Great Widgets, LLC';
        $data['biz_address1'] = '123 Success St.';
        $data['biz_address2'] = 'Suite 103';
        $data['biz_city'] = 'Anytown';
        $data['biz_state'] = 'ZZ';
        $data['biz_zip'] = '55555';
        $data['biz_country'] = 'New Zealand';
        $data['account_id'] = 'greatwidgets';
        $data['account_password'] = 'pa$$w0rd';
        $data['language_selector'] = 'EN';
        $data['symbol_selector'] = 'AUD';
        $data['timezone_selector'] = '68';
        $data['referrer_name'] = 'John Smith';
    

Success XML Response:

        <response status="success">
        </response>
   

Success XML Response (if user_id = account_id, then the user_password is new):

        <response status="success">
            <new_api_token>2959caadac9b13dcb4</new_api_token>
        </response>
     

Error XML Response:

        <response status="error">
            <error>Error message</error>
        </response>
     

Client - Account Info

The data to be submitted to the API is composed of the following fields:

Example PHP Request:

If you are using PHP, the $data array would look like this:

        $data['user_id'] = 'john1970';
        $data['user_password'] = '1959caadac9b13dcb3'; 
        $data['type'] = 'account_info';
        $data['account_id'] = 'greatwidgets';
    

Success XML Response (New or Updated Account):

        <response status="success">
        <account>
        <account_id>test2009050502</account_id>
        <biz_name>Great Widgets Company</biz_name>
        <biz_address1>123 Main St.</biz_address1>
        <biz_address2></biz_address2>
        <biz_city>Anytown</biz_city>
        <biz_state>CA</biz_state>
        <biz_zip>55555</biz_zip>
        <biz_country></biz_country>
        <contact_first_name>John</contact_first_name>
        <contact_last_name>Smith</contact_last_name>
        <contact_email>John@email.com</contact_email>
        <contact_phone>555-555-5555</contact_phone>
        <language>EN</language>
        <symbol>USD</symbol>
        <glyph>$</glyph>
        <timezone>14</timezone>
        <created>2010-09-05</created>
        </account>
        </response>
    

NOTES:

• If the account is a coalition account, a <coalition>Yes</coalition> node will be added.
• If the account is a two-tier account, a <two_tier>Yes</two_tier> node will be added.

Error XML Response:

        <response status="error">
            <error>Error message</error>
        </response>
    

Dashboard Info

The data to be submitted to the API is composed of the following fields:

NOTES:

• The information returned is dependent on the permissions of the user. For example, if a user only has access to one campaign out of many, the total transactions, or last X transactions, etc. will have a lower quantity than if a user with more permissions made this API call.
• most_active: specifiy the number of most active customers to list
• customer_count: return the total customer count for the account.
• total_customers_this_month: return a summary of:
  • New customers this month so far.
  • New customers all of last month.
  • New customers last month in the same period as this month.
• total_transactions_this_month returns a summary of:
  • Number of transactions this month so far.
  • Number of transactions all of last month.
  • Number of transactions last month in the same period as this month.
• active_campaigns_count: How many active campaigns (affected by user permissions)
• campaigns_per_day_activity: A summary per campaign of the number of transactions per day for the number of days specified.
• last_X_transactions: Summary info of the number of transactions specified.
• last_X_customers: Summary into of the number of customers specified.

Example PHP Request:

If you are using PHP, the $data array would look like this:

        $data['API'] = '1.5';
        $data['user_id'] = 'john1970';
        $data['user_api_key'] = '1959caadac9b13dcb3'; 
        $data['account_id'] = 'greatwidgets';
        $data['type'] = 'dashboard';
        $data['most_active'] = '10';
        $data['customer_count'] = 'Yes';
        $data['total_customers_this_month'] = '10';
        $data['total_transactions_this_month'] = '10';
        $data['active_campaign_count'] = 'Yes';
        $data['campaigns_per_day_activity'] = '30';
        $data['last_X_transactions'] = '10';
        $data['last_X_customers'] = '10';
    
    

Success XML Response (New or Updated Account):

        <response status="success">
            <most_active>
                <customer>
                    <code>12345678900123456</code>
                    <card_number>16846</card_number>
                    <first_name>John</first_name>
                    <last_name>Smith</last_name>
                    <transactions>124</transactions>
                </customer>
            ...
            </most_active>
            <total_customers>
                <all_time>2845</all_time>
                <this_month>276</this_month>
                <last_month>498</last_month>
                <same_period_last_month>248</same_period_last_month>
            </total_customers>
            <total_transactions>
                <this_month>8905</this_month>
                <last_month>10567</last_month>
                <same_period_last_month>9025</same_period_last_month>
            </total_transactions>
            <active_campaigns_count>5</active_campaigns_count>
            <campaigns_per_day_activity>
                <campaign>
                    <campaign_id>1234567890543216</campaign_id>
                    <campaign_name>Points Campaign</campaign_name>
                    <campaign_type>points</campaign_type>
                    <day>
                    <date>2013-05-10</date>
                    <quantity>157</quantity>
                    </day>
                    ...
                </campaigns>
                ...
            </campaigns_per_day_activity>
            <last_X_transactions>
                <transactions>10</transactions>
                    <transaction>
                        <transaction_id>123456</transaction_id>
                        <campaign_id>1234567890543216</campaign_id>
                        <campaign_name>Points Campaign</campaign_name>
                        <campaign_type>points</campaign_type>
                        <code>12345678900123456</code>
                        <card_number>16846</card_number>
                        <first_name>John</first_name>
                        <last_name>Smith</last_name>
                        <date>2013-05-10</date>
                        <amount>1500</amount>
                        <redeemed>N</redeemed>
                        <item></item>
                        <description>Smith</description>
                        <user>cashier123</user>
                    </transaction>
                ...
            </last_X_transactions>
            <last_X_customers>
                <customer>
                    <code>12345678900123456</code>
                    <card_number>16846</card_number>
                    <first_name>John</first_name>
                    <last_name>Smith</last_name>
                    <time_stamp>2013-05-10 13:14:56</time_stamp>
                </customer>
                ...
            </last_X_customers>
        </response>
        
    

Error XML Response:

        <response status="error">
            <error>Error message</error>
        </response>