Soap API v1.2


Retrieve the current status of a specific transaction.


This method allows you to check the status of a completed transaction.

Use this method to determine if a transaction has been authorized, processed, or settled.

To specify the transaction you would like to view, you must retrieve it using the reference number (RefNum) 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, voidTransaction, runCredit, runSale, runauthOnly, captureTransaction


TransactionResponse getTransactionStatus ( ueSecurityToken Token, integer RefNum )


Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Transaction Reference number assigned by the gateway.


TransactionResponse Returns a TransactionResponse object containing the results of the transaction and all relevant data.



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

try { 
catch(SoapFault $e) { 
  echo $e->getMessage(); 
echo "\n\nRequest: " . $tran->__getLastRequest(); 
echo "\n\nResponse: " . $tran->__getLastResponse(); 


This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
  //Set RefNum to the Reference Number of transaction you 
  //want to retrieve.
  BigInteger refnum = new BigInteger();
  TransactionResponse response = new TransactionResponse();
  response = client.getTransactionStatus(token, refnum);
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());


    Dim client As usaepay.usaepayService = New usaepay.usaepayService
    Dim token As usaepay.ueSecurityToken
    token = Me.CreateToken("982lz9VsLm87MA54Sv8E582h8OZMArL6", "443311")
    Dim transaction As usaepay.TransactionRequestObject = New usaepay.TransactionRequestObject
    Dim refnum As Integer
    refnum = "46405618"
    Dim response As usaepay.TransactionResponse = New usaepay.TransactionResponse
    response = client.getTransactionStatus(token, refnum)
    If response.StatusCode = "P" Then
      MsgBox("Status: Pending")
    ElseIf response.StatusCode = "B" Then
      MsgBox("Status: Submitted")
    ElseIf response.StatusCode = "E" Then
      MsgBox("Status: Error, Reason: " & response.Error)
    ElseIf response.StatusCode = "N" Then
      MsgBox("Status: New Transaction")
    ElseIf response.StatusCode = "F" Then
      MsgBox("Status: Funded")
    ElseIf response.StatusCode = "S" Then
      MsgBox("Status: Settled")
    ElseIf response.StatusCode = "V" Then
      MsgBox("Status: Voided")
    ElseIf response.StatusCode = "T" Then
      MsgBox("Status: Timed Out (no response in 5 days)")
    ElseIf response.StatusCode = "R" Then
      MsgBox("Status: Returned")
    ElseIf response.StatusCode = "M" Then
      MsgBox("Status: On Hold")
    End If


<?xml version="1.0" encoding="UTF-8"?> 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" 
xmlns:ns1="urn:usaepay" xmlns:xsd="" 
<Token xsi:type="ns1:ueSecurityToken"> 
<ClientIP xsi:type="xsd:string"></ClientIP> 
<PinHash xsi:type="ns1:ueHash"> 
<HashValue xsi:type="xsd:string">e4a3cef16854af8c6495a4394050ed4c64af97ed</HashValue> 
<Seed xsi:type="xsd:string">1193689131266474060</Seed> 
<Type xsi:type="xsd:string">sha1</Type> 
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey> 
<RefNum xsi:type="xsd:integer">1118418</RefNum> 
developer/soap/methods/gettransactionstatus.txt · Last modified: 2009/09/09 13:10 by charlie

Page Tools