Balance Inquiry Transactions

A Balance Inquiry transaction returns the available balance of a Gift Card.

You must be enabled for (Closed Loop) Gift Card transactions to use this transaction type. Please consult your Relationship Manager for additional information about Gift Card transactions.

Balance Inquiry Request

You must structure an Balance Inquiry request as shown in the following examples. The structure of the request is identical for either an Online or a Batch submission.

<balanceInquiry id="Balance Inquiry Id" reportGroup="iQ Report Group" customerId="Customer Id">

  <orderId>Order Id</orderId>

  <orderSource>Order Entry Source</orderSource>

  <card>

</balanceInquiry>

Example:  Balance Inquiry Request

<cnpOnlineRequest version="12.13" xmlns="http://www.vantivcnp.com/schema" merchantId="100">

  <authentication>

    <user>User Name</user>

    <password>Password</password>

  </authentication>

  <balanceInquiry id="834262" reportGroup="ABC Division" customerId="038945">

    <orderId>65347567</orderId>

    <orderSource>ecommerce</orderSource>

    <card>

      <type>GC</type>

      <number>9000000000000001</number>

      <pin>1234</pin>

    </card>

  </balanceInquiry>

</cnpOnlineRequest>

Balance Inquiry Response

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

<balanceInquiryResponse id="Balance Inquiry 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>

  <fraudResult>

  <giftCardResponse>

</balanceInquiryResponse>

Example: Balance Inquiry Response

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

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

    <cnpTxnId>9695064321</cnpTxnId>

    <orderId>65347567</orderId>

    <response>000</response>

    <responseTime>2017-03-21T15:13:43</responseTime>

    <postDate>2017-03-21</postDate>

    <message>Approved</message>

    <fraudResult>

      <cardValidationResult>N</cardValidationResult>

    </fraudResult>

    <giftCardResponse>

      <availableBalance>2000</activateReversalResponse>

</cnpOnlineResponse>