Unload Transactions

The Unload transaction removes funds from an active Gift Card. The unload amount cannot exceed the available balance on the Gift Card. If you attempt to unload more than the available balance, the transaction will be declined with a response Code of 209 - Invalid Amount.

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.

Unload Request

You must specify the Unload request as follows. The structure of the request is identical for either an Online or a Batch submission.

<unload id="Unload Id" reportGroup="iQ Report Group" customerId="Customer Id">

  <orderId>Order Id</orderId>

  <amount>Amount to Load</amount>

  <orderSource>Order Entry Source</orderSource>

  <card>

</unload>

Example: Online Unload Request

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

  <authentication>

    <user>User Name</user>

    <password>Password</password>

  </authentication>

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

    <orderId>65347567</orderId>

    <amount>40000</amount>

    <orderSource>ecommerce</orderSource>

    <card>

      <type>GC</type>

      <number>9000000000000001</number>

      <pin>1234</number>

    </card>

  </onload>

</cnpOnlineRequest>

Unload Response

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

<unloadResponse id="Unload Id" reportGroup="iQ Report Group" customerId="Customer Id">

  <cnpTxnId>Transaction Id</cnpTxnId>

  <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>

</unloadResponse>

Example: Unload Response

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

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

    <cnpTxnId>9695064321</cnpTxnId>

    <response>000</response>

    <responseTime>2020-03-22T15:13:43</responseTime>

    <postDate>2020-03-22</postDate>

    <message>Approved</message>

    <giftCardResponse>

      <txnTime>2020-03-22T12:00:00</txnTime>

      <refCode>003558</refCode>

      <systemTraceId>834528</systemTraceId>

      <sequenceNumber>123456</sequenceNumber>

      <availableBalance>0</availableBalance>

    </giftCardResponse>

  </unloadResponse>

</cnpOnlineResponse>