Transaction Types and Examples
This section presents structural information of each transaction type for both Online and Batch submission methods. The structural information is followed by one or more examples of the cnpAPI transaction. Each structural example shows the parent and all child elements, but does not show grandchildren. The cnpAPI examples do show child elements to multiple levels.
The element names in the structural examples provide links to the element definitions in Chapter 4.
The XML examples in this section are intended to present typical cnpAPI transactions. The examples may not include every possible element for a particular transaction type. When coding your XML, always consult the cnpAPI schema files for information concerning all available elements.
This section contains examples of the following transaction types:
In the cnpAPI, the order of the elements is enforced. Failure to adhere to the element order as defined in the schema will result in XML validation errors.
-
Activate Transactions (Private Label Gift Card transaction)
-
Activate Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
Balance Inquiry Transactions (Private Label Gift Card transaction)
-
Buy Now Pay Later Authorization Transactions
-
Cancel Subscription Transactions (Recurring Engine transaction)
-
Create Plan Transactions (Recurring Engine transaction)
-
Deactivate Transactions (Private Label Gift Card transaction)
-
Deactivate Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
Deposit Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
eCheck Prenotification Credit Transactions (Batch Only) (Batch Only)
-
eCheck Prenotification Sale Transactions (Batch Only) (Batch Only)
-
Gift Card Auth Reversal Transactions (Private Label Gift Card transaction)
-
Gift Card Capture Transactions (Private Label Gift Card transaction)
-
Gift Card Credit Transactions (Private Label Gift Card transaction)
-
Load Transactions (Private Label Gift Card transaction)
-
Load Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
Refund Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
Unload Transactions (Private Label Gift Card transaction)
-
Unload Reversal Transactions (Online Only) (Private Label Gift Card transaction)
-
Update Plan Transactions (Recurring Engine transaction)
-
Update Subscription Transactions (Recurring Engine transaction)