API DOCUMENTATION Last Update: Apr 2022

Delete a Transaction

Deletes a specific transaction in a customer account.

 

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

 

Fields common to all campaign types:

field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required
type transaction_delete Required
account_id greatwidgets Required
campaign_id 4564222953051300 Required
code 1234567890123456 Required
transaction_id 4056 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

 

Notes:

  • 'When using this call, you need to specificy the campaign_id the transaction belongs to, the customer code the transaction is for, and the transaction_id of the transaction itself to identify the transaction and to avoid accidental removal of the wrong transaction.
  • Deleting transactions can severely mess up a customer's balance IF there are subsequent redemptions that are based on the transaction's impact on the customer balance at the time the redemption occurred. Deleting transactions in an campaign that has depreciation or recurring fees can similarly severly and negatively impact subsequent balances.
  • Transactions that are the result of Depreciations or Recurring Fees CANNOT be deleted as they are created on the fly, and not recorded as a physical event.
  • Only one transaction can be deleted at a time. To delete more than one transaction at a time, use a loop in your code to itterate through each transaction and make the API call to delete it.

 

Example PHP Request:

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

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'transaction_delete';
  4. $data['account_id'] = 'greatwidgets';
  5. $data['campaign_id'] = '4564222953051300';
  6. $data['code'] = '1234567890123456';
  7. $data['transaction_id'] = '4056';

 

Success XML Response for Points Campaign:

  1. <response status="success">
  2. </response>

 

Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>