Overview of Online and Batch Processing Formats

There are two methods of submitting payment transactions using the cnpAPI format: Online (one transaction at a time), or Batch. This section provides a high level overview of the request and response structures used for each submission type.

Batch Process Format

We treat each Batch transmission you send to us as a single request. You can think of the entire Batch request as a session composed of one or more individual batches, each containing one or more transactions. You can also use a Batch as a retrieval request for the response to a previously processed session. We return a response transmission for each request.

Batch processing supports the following transaction types:

  • Activate Transactions

  • eCheck Verification Transactions

  • Authorization Transactions

  • Force Capture Transactions

  • Authorization Reversal

  • Fraud Check Transaction

  • Balance Inquiry Transactions

  • Gift Card Auth Reversal Transaction

  • Cancel Subscription Transactions

  • Gift Card Capture Transaction

  • Capture Transactions

  • Gift Card Credit Transaction

  • Capture Given Auth Transactions

  • Load Transactions

  • Create Plan Transactions

  • Register Token Transactions

  • Credit Transactions

  • RFR Batch Transactions (Batch Only)

  • Deactivate Transactions

  • Sale Transactions

  • eCheck Credit Transactions

  • Unload Transactions

  • eCheck Prenotification Credit

  • Update Card Validation Number Transactions

  • eCheck Prenotification Sale

  • Update Plan Transactions

  • eCheck Redeposit Transactions

  • Update Subscription Transactions

  • eCheck Sale Transactions

  • All PayFac Dynamic Payout Transactions

For information and examples of Dynamic Payout Funding Instructions, please refer to Appendix D - Dynamic Payout

For more information about Batch processing, see Batch Transaction Processing.

Supported Communication Protocols

We support the following communication protocols for Batch processing:

  • Encrypted FTP (PGP or GPG key encryption)

  • sFTP

For additional information concerning the recommended transmission methods, see Transferring Session Files.

Batch Processing Request Format

The Batch processing request is made up of the following elements:

  • Header information - one <cnpRequest> element

  • Merchant authentication information - one <authentication> element

  • Batch information - one or more <batchRequest> elements

  • Payment transactions (for example, an Authorization, Capture, Credit, etc.) - at least one per <batchRequest> element

Each of the num and amount attributes used in a batchRequest defaults to 0 (zero) if not specified in the request. In any of the amount fields (authAmount, captureAmount, etc.), the value is an implied decimal (for example 500=5.00).

Batch Processing Response Format

The Batch processing response is composed of the following elements:

  • Header information - one <cnpResponse> element

  • One or more <batchResponse> elements - contains payment transactions response

  • At least one payment transaction response (for example, an Authorization response, Capture response, Credit response, etc.)

For information on the XML Validation response and message attributes, please refer to XML Validation Error Messages.