queueTransaction

Queue a specific transaction.

Description

This function will queue a transaction that was previously authorized. You can only queue a transaction that hasn't been settled yet. A transaction is settled when the batch that it is in has been closed.

The transaction to be queued must be retrieved using the reference number (RefNum or TransKey) assigned to the transaction by the gateway. The RefNum is assigned by the gateway and returned when a transaction is processed. To find a missing RefNum, use the searchTransactions method.

See also runTransaction, runQuickSale, runCredit, runSale, runauthOnly, getTransactionStatus

Syntax

boolean queueTransaction ( ueSecurityToken Token, string RefNum )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
string RefNum Unique transaction reference number assigned by the gateway. You can also use TransKey in the RefNum field.

Return Value

Type Description
boolean Returns confirmation of request only if successful. If request fails, an exception will be thrown.

Examples

PHP

For directions on how to set up the WSDL link, create "$token" and "$client", go to PHP Soap How-to.

try {
    $RefNum="onfmz93jtw93c1g";

    $res=$client->queueTransaction($token, $RefNum);
    print_r($res);

  }

  catch (SoapFault $e){
    die("queueTransaction failed :" .$e->getMessage());
  }

XML

Request:

<?xml version="1.0" encoding="UTF-8"?>
   <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <SOAP-ENV:Body>
         <ns1:queueTransaction>
            <Token xsi:type="ns1:ueSecurityToken">
               <ClientIP xsi:type="xsd:string">123.123.123.123</ClientIP>
               <PinHash xsi:type="ns1:ueHash">
                  <HashValue xsi:type="xsd:string">0fce6e926d22ce2c068c8d417cbe7c670056f59f1cb01678d75c7352e003324e</HashValue>
                  <Seed xsi:type="xsd:string">1539018251449307535sadfpouhasodf8uh</Seed>
                  <Type xsi:type="xsd:string">sha256</Type>
               </PinHash>
               <SourceKey xsi:type="xsd:string">chwl7EPgI56G8X76a0ME509Vc2z3BGge</SourceKey>
            </Token>
            <RefNum xsi:type="xsd:string">onfmz93jtw93c1g</RefNum>
         </ns1:queueTransaction>
      </SOAP-ENV:Body>
   </SOAP-ENV:Envelope>

Response:

<?xml version="1.0" encoding="UTF-8"?>
   <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:usaepay" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <SOAP-ENV:Body>
         <ns1:queueTransactionResponse>
            <queueTransactionReturn xsi:type="xsd:boolean">true</queueTransactionReturn>
         </ns1:queueTransactionResponse>
      </SOAP-ENV:Body>
   </SOAP-ENV:Envelope>

Change Log

Version Change
1.7 Added Method.