Advanced Transaction API modes and descriptions

19 Apr 2024

Support Center » Knowledgebase » Technical FAQs » Advanced integration and API » Advanced Transaction API modes and descriptions

	Advanced Transaction API modes and descriptions

Solution

The Advanced Transaction API works very much like the outbound API, but it is set up in your account profile and preferences and is triggered on all transactions, rather than being set up per offer like the outbound API.

To set it up, click the main menu under My Account >> Profile & Preferences. In the Advanced Transaction API section, you provide a URL on your site. This should be the location where you would set up a script to capture the API calls.

aff_comm_set: Informational mode indicating that an affiliate commission has been set for a transaction

aff_decline: Informational mode indicating that an affiliate commission has been manually declined by the admin

aff_mark_as_paid: Informational mode indicating that an affiliate commission has been manually marked as paid by the admin

batch: Called when multiple transactions have been deleted, voided, refunded, or marked as refunded in batch, from checking the box of multiple transactions and then selecting on of the available actions on the transaction page.

chargeback: An existing transaction that has been marked as a chargeback

credit: An existing transaction that has been refunded

credit_applied: Informational mode - an internal placeholder transaction created to indicate when a transaction is refunded.

mark_credit: Informational mode - an internal placeholder transaction created to indicate when a transaction is marked as refunded

mass_pay_file: Informational, indicating that a mass pay file has been generated for a transaction for an affiliate

paypal_EOT: Informational mode originating from PayPal, indicating that a recurring payment profile has reached its End Of Term

paypal_cancel: Informational mode originating from PayPal, indicating that a recurring payment profile has been cancelled

paypal_payment: Originating from PayPal, indicating that a subscription/recurring payment transaction has occurred

paypal_refund: Originating from PayPal, indicating that a refund has occurred

paypal_subscr: Informational mode originating from PayPal, indicating that a recurring payment profile has been created

paypal_web_accept: Originating from PayPal, indicating that a one-time payment transaction has occurred

refund_failed: Informational mode, indicates when a refund was attempted and failed

refunded: An existing transaction that has been refunded.

resend: Informational mode, indicates when a transaction record of any type was resent through the transaction API

reverse_aff_comm: Indicates that an affiliate commission has been reversed, when a transaction with a commission that has been marked as paid has been refunded/chargeback

subscr_cancel: Informational mode, indicates a recurring CC subscription was cancelled by the subscriber

subscr_eot: Informational mode, Indicates a recurring CC subscription has reached its End Of Term (whether by cancellation, billing failure, or the number of installments for the subscription has been reached.)

subscr_failed: Informational mode, indicates that a recurring credit card payment attempt has failed

subscr_payment: Indicates that a recurring payment transaction (CC, PayPal, 2Co) has occurred

subscr_signup: Indicates a recurring subscription has been created, but there is no initial payment (free trial)

subscr_success: Informational mode, indicates when an attempted subscription via CC succeeds

timeout: Informational mode - an internal placeholder transaction created to indicate when a transaction (CC, PayPal, 2Co) was attempted and the remote server did not respond

void: An existing CC transaction that has been voided

void_applied: Informational mode - an internal placeholder transaction created to indicate when a CC transaction is voided

voided: An existing CC transaction has been voided

web_accept: Indicating that a one-time payment transaction (CC, PayPal, 2Co) has occurred

Article Details

Article ID:

239

Created On:

15 Aug 2012 03:33 PM