batchRequest

This is the root element for all cnpAPI Batch requests.

Parent Elements:

cnpRequest

Attributes:

Include the count and amount attributes for all transaction types included in the Batch. For example if you submit one Sale transaction of $10, include numSales="1" and saleAmount="1000". You must always include an amount, if you include a count. Do not include corresponding attributes, if the Batch does not include the transaction type.

Attribute Name

Type

Required?

Description

id

String

No

A unique string to identify this batchRequest

within the system.

minLength = N/A maxLength = 25

numAuths

Integer

No

Defines the total count of Authorization transactions in the batchRequest.

minLength = N/A maxLength = N/A

authAmount

Integer

No

Defines the total dollar amount of Authorization transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numAuthReversals

Integer

No

Defines the total count of AuthReversal transactions in the batchRequest.

minLength = N/A maxLength = N/A

authReversalAmount

Integer

No

Defines the total dollar amount of AuthReversal transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numTransactionReversals

Integer

No

Defines the total count of transactionReversal transactions in the batchRequest.

minLength = N/A maxLength = N/A

transactionReversalAmount

Integer

No

Defines the total dollar amount of transactionReversal transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

numGiftCardAuthReversals

Integer

No

Defines the total count of giftCardAuthReversal transactions in the batchRequest.

minLength = N/A maxLength = N/A

giftCardAuthReversalOrig inalAmount

Integer

No

Defines the total dollar amount of giftCardAuthReversal transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numCaptures

Integer

No

Defines the total count of Capture transactions in the batchRequest.

minLength = N/A maxLength = N/A

captureAmount

Integer

No

Defines the total dollar amount of Capture transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numGiftCardCaptures

Integer

No

Defines the total count of giftCardCapture transactions in the batchRequest.

minLength = N/A maxLength = N/A

giftCardCaptureAmount

Integer

No

Defines the total dollar amount of giftCardCapture transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numCredits

Integer

No

Defines the total count of Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

creditAmount

Integer

No

Defines the total dollar amount of Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numGiftCardCredits

Integer

No

Defines the total count of giftCardCredit transactions in the batchRequest.

minLength = N/A maxLength = N/A

giftCardCreditAmount

Integer

No

Defines the total dollar amount of giftCardCredit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numForceCaptures

Integer

No

Defines the total count of Force Capture transactions in the batchRequest.

minLength = N/A maxLength = N/A

forceCaptureAmount

Integer

No

Defines the total dollar amount of Force Capture transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numSales

Integer

No

Defines the total count of Sale transactions in the batchRequest.

minLength = N/A maxLength = N/A

saleAmount

Integer

No

Defines the total dollar amount of Sale transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numCaptureGivenAuths

Integer

No

Defines the total count of Capture Given Auth transactions in the batchRequest.

minLength = N/A maxLength = N/A

captureGivenAuthAmount

Integer

No

Defines the total dollar amount of Capture Given Auth transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

numEcheckSales

Integer

No

Defines the total count of eCheck Sale transactions in the batchRequest.

minLength = N/A maxLength = N/A

echeckSalesAmount

Integer

No

Defines the total dollar amount of eCheck Sale transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numEcheckCredit

Integer

No

Defines the total count of eCheck Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

echeckCreditAmount

Integer

No

Defines the total dollar amount of eCheck Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numEcheckVerification

Integer

No

Defines the total count of eCheck Verification transactions in the batchRequest.

minLength = N/A maxLength = N/A

echeckVerificationAmount

Integer

No

Defines the total dollar amount of eCheck Verification transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numEcheckRedeposit

Integer

No

Defines the total count of eCheck Redeposit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numEcheckPreNoteSale

Integer

No

Defines the total count of eCheck Prenotification Sale transactions in the batchRequest.

minLength = N/A maxLength = N/A

numEcheckPreNoteCredit

Integer

No

Defines the total count of eCheck Prenotification Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numAccountUpdates

Integer

No

Defines the total count of Account Update transactions in the batchRequest.

minLength = N/A maxLength = N/A

numTokenRegistrations

Integer

No

Defines the total count of Token Registration transactions in the batchRequest.

minLength = N/A maxLength = N/A

numUpdateCardValidatio nNumOnTokens

Integer

No

Defines the total count of Update Card Validation Number request transactions in the batchRequest.

minLength = N/A maxLength = N/A

numCancelSubscriptions

Integer

No

Defines the total count of Cancel Subscription transactions in the batchRequest.

minLength = N/A maxLength = N/A

numUpdateSubscriptions

Integer

No

Defines the total count of Update Subscription transactions in the batchRequest.

minLength = N/A maxLength = N/A

numCreatePlans

Integer

No

Defines the total count of Create Plan transactions in the batchRequest.

minLength = N/A maxLength = N/A

numUpdatePlans

Integer

No

Defines the total count of Update Plan transactions in the batchRequest.

minLength = N/A maxLength = N/A

numActivates

Integer

No

Defines the total count of (Gift Card) Activate transactions in the batchRequest.

minLength = N/A maxLength = N/A

numDeactivates

Integer

No

Defines the total count of (Gift Card) Deactivate transactions in the batchRequest.

minLength = N/A maxLength = N/A

activateAmount

Integer

No

Defines the total dollar amount of (Gift Card) Activate transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

numLoads

Integer

No

Defines the total count of (Gift Card) Load transactions in the batchRequest.

minLength = N/A maxLength = N/A

loadAmount

Integer

No

Defines the total dollar amount of (Gift Card) Load transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

numUnloads

Integer

No

Defines the total count of (Gift Card) Unload transactions in the batchRequest.

minLength = N/A maxLength = N/A

unloadAmount

Integer

No

Defines the total dollar amount of (Gift Card) Unload transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

numBalanceInquirys

Integer

No

Defines the total count of (Gift Card) Balance Inquiry transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPayFacCredit

Integer

No

Defines the total count of PayFac Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPayFacDebit

Integer

No

Defines the total count of PayFac Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numSubmerchantCredit

Integer

No

Defines the total count of Submerchant Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numSubmerchantDebit

Integer

No

Defines the total count of Submerchant Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numReserveCredit

Integer

No

Defines the total count of Reserve Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numReserveDebit

Integer

No

Defines the total count of Reserve Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numVendorCredit

Integer

No

Defines the total count of Vendor Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numVendorDebit

Integer

No

Defines the total count of Vendor Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPhysicalCheckCredit

Integer

No

Defines the total count of Physical Check Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPhysicalCheckDebit

Integer

No

Defines the total count of Physical Check Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numFundingInstructionVoid

Integer

No

Defines the total count of Funding Instruction Void transactions in the batchRequest.

minLength = N/A maxLength = N/A

numFastAccessFunding

Integer

No

Defines the total count of Fast Access Funding Instruction transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPayoutOrgCredit

Integer

No

Defines the total count of Payout Org Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numPayoutOrgDebit

Integer

No

Defines the total count of Payout Org Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numCustomerCredit

Integer

No

Defines the total count of Customer Credit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numCustomerDebit

Integer

No

Defines the total count of Customer Debit transactions in the batchRequest.

minLength = N/A maxLength = N/A

numTranslateToLowValu eTokenRequests

Integer

No

Defines the total count of HVT to LVT translation transactions in the batchRequest.

minLength = N/A maxLength = N/A

payFacCreditAmount

Integer

No

Defines the total dollar amount of PayFac Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

payFacDebitAmount

Integer

No

Defines the total dollar amount of PayFac Debit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

submerchantCreditAmount

Integer

No

Defines the total dollar amount of Sub-merchant Credit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

submerchantDebitAmount

Integer

No

Defines the total dollar amount of Sub-merchant Debit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

reserveCreditAmount

Integer

No

Defines the total dollar amount of Reserve Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

reserveDebitAmount

Integer

No

Defines the total dollar amount of Reserve Debit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

vendorCreditAmount

Integer

No

Defines the total dollar amount of Vendor Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

vendorDebitAmount

Integer

No

Defines the total dollar amount of Vendor Debit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

physicalCheckCreditAmount

Integer

No

Defines the total dollar amount of Physical Check Credit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

physicalCheckDebitAmount

Integer

No

Defines the total dollar amount of Physical Check Debit transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

FastAccessFundingAmount

Integer

No

Defines the total dollar amount of Fast Access Funding transactions in the batchRequest. The decimal point is implied. For example, you enter $25.00 as 2500.

totalDigits = 10

payoutOrgCreditAmount

Integer

No

Defines the total dollar amount of Payout Org Credit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

payoutOrgDebitAmount

Integer

No

Defines the total dollar amount of Payout Org Debit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

customerCreditAmount

Integer

No

Defines the total dollar amount of Customer Credit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

customerDebitAmount

Integer

No

Defines the total dollar amount of Customer Debit transactions in the batchRequest. The decimal point is implied. For example, you enter

$25.00 as 2500.

totalDigits = 10

merchantId

String

Yes

A unique string to identify the merchant within the system.

minLength = N/A maxLength = 50

Note: International currencies are supported on a per merchantId basis.

sameDayFunding

Boolean

No

Used for Dynamic Payout Funding Instructions only. Set to true to mark this Batch of Funding Instructions for same day funding. Also, see Same Day Funding.

Child Elements:

At least one of the following required: activate, authorization, authReversal, balanceInquiry, cancelSubscription, capture, captureGivenAuth, createPlan, credit, deactivate, echeckCredit, echeckPreNoteCredit, echeckPreNoteSale, echeckRedeposit, echeckSale, echeckVerification, fastAccessFunding, forceCapture, giftCardAuthReversal, giftCardCapture, giftCardCredit, load, registerTokenRequest, sale, depositTransactionReversal, unload, updateCardValidationNumOnToken, updatePlan, updateSubscription, payFacCredit, customerCredit, customerDebit, payoutOrgCredit, payoutOrgDebit, payFacDebit, reserveCredit, reserveDebit, submerchantCredit, submerchantDebit, vendorCredit, vendorDebit