Authorization Response Structure

An Authorization response has the following structure. The response message is identical for Online and Batch transactions except Online includes the <postDate> element.

<authorizationResponse id="Authorization Id" reportGroup="iQ Report Group" customerId="Customer Id">

  <cnpTxnId>Transaction Id</cnpTxnId>

  <orderIdOrder Id</orderId>

  <response>Response Code</response>

  <responseTime>Date and Time in GMT</responseTime>

  <postDate>Date transaction posted</postDate> (Online Only)

  <message>Response Message</message>

  <location>Processing Location</location>

  <authCode>Approval Code</authCode>

  <approvedAmount>Approved amount for partial Auth<approvedAmount>

  <accountInformation>

  <accountUpdater>

  <fraudResult>

  <tokenResponse> (for Tokenized merchants submitting card data)

  <enhancedAuthResponse>

  <recyclingResponse> (included for declined Auths if feature is enabled)

  <recurringResponse> (for Recurring Engine merchants)

  <giftCardResponse> (included if Gift Card is Method of Payment)

  <applepayResponse>

  <cardSuffix>Card Last 4</cardSuffix> (included for ApplePay using VI or MC)

  <androidpayResponse>

  <networkTransactionId>Txn ID returned from network</networkTransactionId>

  <paymentAccountReferenceNumber>Correlation Value</paymentAccountReferenceNumber>

  <pinlessDebitResponse>

  <checkoutId>Unique Id Value</checkoutId>

</authorizationResponse>

 

Example:  Batch Authorization Response

The example below shows a batch Authorization response that contains two transactions.

<cnpResponse version="12.13" xmlns="http://www.vantivcnp.com/schema" id="123" response="0" message="Valid Format" cnpSessionId="987654321">

  <batchResponse id="01234567" cnpBatchId="4455667788" merchantId="100">

    <authorizationResponse id="AX54321678" reportGroup="RG27">

      <cnpTxnId>84568456</cnpTxnId>

      <orderId>12z58743y1</orderId>

      <response>000</response>

      <responseTime>2011-03-01T10:24:31</responseTime>

      <message>Approved</message>

      <authCode>123456</authCode>

      <fraudResult>

        <avsResult>00</avsResult>

      </fraudResult>

    </authorizationResponse>

    <authorizationResponse id="AX54325432" reportGroup="RG12">

      <cnpTxnId>84568457</cnpTxnId>

      <orderId>12z58743y7</orderId>

      <response>000</response>

      <responseTime>2017-09-01T10:24:31</responseTime>

      <message>Approved</message>

      <authCode>123456</authCode>

      <fraudResult>

        <avsResult>00</avsResult>

        <authenticationResult>2</authenticationResult>

      </fraudResult>

      <enhancedAuthResponse>

        <fundingSource>

          <type>PREPAID</type>

          <availableBalance>5000</availableBalance>

          <reloadable>NO</reloadable>

          <prepaidCardType>GIFT</prepaidCardType>

        </fundingSource>

        <accountRangeId>1234567890123456789</accountRangeId>

      </enhancedAuthResponse>

    </authorizationResponse>

  </batchResponse>

</cnpResponse>

Example:  Online Authorization Response including Advanced Fraud Results

The online response format contains a <postDate> element, which indicates the date the financial transaction will post.

<cnpOnlineResponse version="12.8" xmlns="http://www.vantivcnp.com/schema" response="0" message="Valid Format">

  <authorizationResponse id="834262" reportGroup="ABC Division">

    <cnpTxnId>969506</cnpTxnId>

    <orderId>65347567</orderId>

    <response>000</response>

    <responseTime>2017-09-25T15:13:43</responseTime>

    <postDate>2017-09-25</postDate>

    <message>Approved</message>

    <authCode>123457</authCode>

    <fraudResult>

      <avsResult>00</avsResult>

      <cardValidationResult>N</cardValidationResult>

      <authenticationResult>2</authenticationResult>

      <advancedFraudResults>

        <deviceReviewStatus>pass</deviceReviewStatus>

        <deviceReputationScore>70</deviceReputationScore>

        <triggeredRule>FlashImagesCookiesDisabled</triggeredRule>

      </advancedFraudResults>

    </fraudResult>

    <enhancedAuthResponse>

      <fundingSource>

        <type>PREPAID</type>

        <availableBalance>0</availableBalance>

        <reloadable>YES</reloadable>

        <prepaidCardType>TEEN</prepaidCardType>

      </fundingSource>

        <accountRangeId>1234567890123456789</accountRangeId>

      </enhancedAuthResponse>

    <paymentAccountReferenceNumber>123456789</paymentAccountReferenceNumber>

  </authorizationResponse>

</cnpOnlineResponse>

Example:  Authorization Response for Tokenized Merchant Sending Card Data

If a tokenized merchant submits card data in the Authorization request, the response includes the tokenResponse element. The example below is a response for an Online request (cnpOnlineResponse element not shown); therefore, it includes the postDate element.

<authorizationResponse id="99999" reportGroup="RG1" customerId="444">

  <cnpTxnId>21200000001108</cnpTxnId>

  <orderId>F12345</orderId>

  <response>000</response>

  <responseTime>2017-10-08T21:38:32</responseTime>

  <postDate>2017-10-08</postDate>

  <message>Approved</message>

  <authCode>270005</authCode>

  <fraudResult>

    <avsResult>11</avsResult>

    <cardValidationResult>P</cardValidationResult>

  </fraudResult>

  <tokenResponse>

    <cnpToken>1111100100240005</cnpToken>

    <tokenResponseCode>801</tokenResponseCode>

    <tokenMessage>Account number was successfully registered</tokenMessage>

    <type>VI</type>

    <bin>402410</bin>

  </tokenResponse>

</authorizationResponse>

Example:  Online Authorization Response with Account Updater Token Info

In this example, the <accountUpdater> contains both original and new card information as well as the <extendedCardResponse> element. This signifies that the card number changed from the original to the new and (from the extended response code) that the issuer reported the new account as closed. Although the Authorization was approved, this information allows you to make an informed decision about how to proceed with the sale.

<cnpOnlineResponse version="12.0" xmlns="http://www.vantivcnp.com/schema" response="0" message="Valid Format">

  <authorizationResponse id="834262" reportGroup="ABC Division">

    <cnpTxnId>969506</cnpTxnId>

    <orderId>65347567</orderId>

    <response>000</response>

    <responseTime>2017-09-25T15:13:43</responseTime>

    <postDate>2017-09-25</postDate>

    <message>Approved</message>

    <authCode>123457</authCode>

    <accountUpdater>

      <originalCardTokenInfo>

        <cnpToken>1111100100240005</cnpToken>

        <type>VI</type>

        <expDate>1112</expDate>

        <bin>400555</bin>

      </originalCardTokenInfo>

      <newCardTokenInfo>

        <cnpToken>1111100100250017</cnpToken>

        <type>VI</type>

        <expDate>1114</expDate>

        <bin>400555</bin>

      </newCardTokenInfo>

      <extendedCardResponse>

        <code>501</code>

        <message>The account was closed</message>

      </extendedCardResponse>

    </accountUpdater>

    <fraudResult>

      <avsResult>00</avsResult>

      <cardValidationResult>N</cardValidationResult>

      <authenticationResult>2</authenticationResult>

    </fraudResult>

  </authorizationResponse>

</cnpOnlineResponse>

Example:  Online Authorization Response with Recurring Response

<cnpOnlineResponse version="12.0" xmlns="http://www.vantivcnp.com/schema" response="0" message="Valid Format">

  <authorizationResponse id="834262" reportGroup="ABC Division">

    <cnpTxnId>969506</cnpTxnId>

    <orderId>65347567</orderId>

    <response>000</response>

    <responseTime>2017-09-25T15:13:43</responseTime>

    <postDate>2017-09-25</postDate>

    <message>Approved</message>

    <authCode>123457</authCode>

    <fraudResult>

      <avsResult>00</avsResult>

      <cardValidationResult>N</cardValidationResult>

      <authenticationResult>2</authenticationResult>

    </fraudResult>

    <recurringResponse>

      <subscriptionId>1234567890</subscriptionId>

      <responseCode>000</responseCode>

      <responseMessage>Approved</responseMessage>

    </recurringResponse>

  </authorizationResponse>

</cnpOnlineResponse>