cnpOnlineResponse

This is the root element for all cnpAPI Online responses.

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

The system returns responses 2 through 5 and the associated messages only if you use Open Access/Transact to submit transactions.

response

String

Yes

Indicates whether your XML syntax passed validation. Expected values are as follows:

0 - XML validation succeeded.

1 - XML validation failed. See the message attribute for more details.

2 - Indicates that the submitted content was either improperly formatted XML or non-XML content.

3 - Indicates that the submission contains empty or invalid credentials (user and password).

4 - Indicates that the merchant has reached the maximum number of concurrent connections.

5 - Indicates that systems may have detected message content that violates certain restrictions.

minLength = N/A maxLength = 3

message

String

Yes

XML validation error message. Expected values are as follows:

- If the response attribute returns 0, the message attribute returns the text “Valid Format.”

- If the response attribute returns 1, the message attribute returns an error message that helps you to identify and troubleshoot the syntax problem. See XML Validation Error Messages for example messages.

- If the response attribute returns 2, the message attribute is "System Error - Call Vantiv."

- If the response attribute returns a value of 3, 4, or 5, the message attribute is "There is a problem with the system. Contact eCommerceSupport@vantiv.com."

minLength = N/A maxLength = 512

Child Elements:

One of the following required: activateResponse, activateReversalResponse, authorizationResponse, authReversalResponse, balanceInquiryResponse, BNPLCancelResponse, BNPLCaptureResponse, BNPLInquiryResponse, BNPLRefundResponse, cancelSubscriptionResponse, captureGivenAuthResponse, captureResponse, createPlanResponse, deactivateResponse, deactivateReversalResponse, depositReversalResponse, creditResponse, echeckCreditResponse, echeckRedepositResponse, echeckSalesResponse, echeckVerificationResponse, echeckVoidResponse, forceCaptureResponse, fraudCheckResponse, giftCardAuthReversalResponse, giftCardCaptureResponse, giftCardCreditResponse, loadResponse, loadReversalResponse, queryTransactionResponse, refundReversalResponse, registerTokenResponse, saleResponse, unloadResponse, unloadReversalResponse, updateCardValidationNumOnTokenRespone, voidResponse, updatePlanResponse, updateSubscriptionResponse, fastAccessFundingResponse, fundingInstructionVoidResponse, payFacCreditResponse, payFacDebitResponse, physicalCheckCreditResponse, physicalCheckDebitResponse, reserveCreditResponse, reserveDebitResponse, submerchantCreditResponse, submerchantDebitResponse, vendorCreditResponse, vendorDebitResponse, customerCreditResponse, customerDebitResponse, payoutOrgCreditResponse, payoutOrgDebitResponse, encryptionKeyResponse