Record Transaction

Record a transaction for a customer account.

Redemption Transaction

Record a redemption transaction for a customer account.

Batch Transactions

Record a batch of transactions for a customer account, including redemptions.

Delete a Transaction

Deletes a specific transaction in a customer account.

`Record Transaction`

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

field	Example	Note
user_id	john1970	Required
user_password	1959caadac9b13dcb3	Required
type	record_activity	Required
account_id	1111222233334444	Required
code or card_number	1234567890123456 11112222	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Fields for Points-Based Campaigns:

field	Example	Note
campaign_id	1111222233334444	Required
amount	9.95 or 9,95	Optional
promo_id	89	Do not include if none
authorization	Custom description	Optional
send_transaction_email	Y	Do not include if none to be sent.
custom_field_#	Store 35	See Notes below.
custom_field_#	238479237t2t3	See Notes below.
...

Fields for Gift-Card Campaigns:

field	Example	Note
campaign_id	22223333444455555	Required
amount	9.95 or 9,95	Required
authorization	Custom description	Optional
send_transaction_email	Y	Do not include if none to be sent.
custom_field_#	Store 35	See Notes below.
custom_field_#	238479237t2t3	See Notes below.
...

Fields for Buy-X-Get-One-Free / Membership Campaigns:

field	Example	Note
campaign_id	5555666677778888	Required
service_product	96 or item_identifier	Required
buyx_quantity	10	Optional
authorization	Custom description	Optional
send_transaction_email	Y	Do not include if none to be sent.
custom_field_#	Store 35	See Notes below.
custom_field_#	238479237t2t3	See Notes below.
...

Fields for Events (Visits) Based Campaigns:

field	Example	Note
campaign_id	3333444455556666	Required
authorization	Custom description	Optional
send_transaction_email	Y	Do not include if none to be sent.
custom_field_#	Store 35	See Notes below.
custom_field_#	238479237t2t3	See Notes below.
...

Fields for Earn-per-Event (Visits) Campaigns:

field	Example	Note
campaign_id	4444555566667777	Required
authorization	Custom description	Optional
send_transaction_email	Y	Do not include if none to be sent.
custom_field_#	Store 35	See Notes below.
custom_field_#	238479237t2t3	See Notes below.
...

Notes:

'When using this call and using the 'code' parameter to identify a customer, the 'code' MUST be the unique Customer ID that was either
- passed as 'code=' by your program when the customer record was created previously, or
- the 16-digit number that was generated by us when the customer account was created and returned to you in the API response.
Otherwise, pass the customer's card number or memnbership identifier as the 'card_number'.
If you don't know what either the code or card_number are, you can search for a customer using any of their information (like phone #, or other custom field marked as "searchable" by using the customer_search or customer_find API calls to retrieve the customer's code.
New customer accounts are automatically created when a transaction is received and the account/card code is not in the system already.
The field values promo_id for Points campaigns and service_product for BuyX campaigns can be found by calling the Campaign Promotions and BuyX Campaign Items List API calls.
For coalition accounts, the balance for each campaign will be the coalition balance, not the individual campaign balance. Hence the totals of the transactions for each campaign may not add up to the coalition balance, since the customer may have multiple transactions in multiple campaign(s).
To know what the custom_field_# of a custom field is, issue the Transactions Fields - List API call to get a list of the current defined custom transaction fields.

Example PHP Request for Points-Based Campaign:

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


              $data['user_id'] = 'john1970';
              $data['user_password'] = '1959caadac9b13dcb3'; 
              $data['type'] = 'record_activity';
              $data['account_id'] = 'greatwidgets';
              $data['code'] = '1234567890123456';
              $data['campaign_id'] = '1111222233334444';
              $data['amount'] = '9.95';
              $data['promo_id'] = '89';
              $data['authorization'] = 'Custom description';
              $data['custom_field_2'] = 'Store 35';
              $data['custom_field_5'] = 'Some other data';
              $data['send_transaction_email'] = 'Y';

Success XML Response for Points Campaign: