cnpOnlineRequest

This is the root element for all cnpAPI Online requests.

Parent Elements:

None

Attributes:

Attribute Name

Type

Required?

Description

version

String

Yes

Defines the cnpAPI schema version against which the XML is validated.

minLength = N/A maxLength = 10

xmlns

String

Yes

Defines the URI of the schema definition. This is a fixed location and must be specified as: http://www.vantivcnp.com/schema.

minLength = N/A maxLength = 38

merchantId

String

Yes

A unique string used to identify the merchant within the system.

minLength = N/A maxLength = 50

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

loggedInUser

String

No

Internal Use Only

sameDayFunding

Boolean

No

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

Child Elements:

Required: authentication

One of the following required: activate, activateReversal, authorization, authReversal, balanceInquiry, BNPLAuthorizationRequest, BNPLCancelRequest, BNPLCaptureRequest, BNPLRefundRequest, cancelSubscription, capture, captureGivenAuth, createPlan, credit, deactivate, deactivateReversal, depositReversal, echeckCredit, echeckRedeposit, echeckSale, echeckVerification, echeckVoid, finicityAccountRequest, finicityURLRequest, forceCapture, fraudCheck, giftCardAuthReversal, giftCardCapture, giftCardCredit, load, loadReversal, queryTransaction, registerTokenRequest, refundReversal, sale, depositTransactionReversal, unload, updateCardValidationNumOnToken, updatePlan, updateSubscription, unloadReversal, void, fastAccessFunding, fundingInstructionVoid, payFacCredit, payFacDebit, physicalCheckCredit, physicalCheckDebit, reserveCredit, reserveDebit, submerchantCredit, submerchantDebit, vendorCredit, vendorDebit, customerCredit, customerDebit, payoutOrgCredit, payoutOrgDebit, translateToLowValueTokenRequest, encryptionKeyRequest