developer:soap-1.4:methods:overridetransaction

Soap API v1.4

overrideTransaction

Override a specific transaction.

Description

This method can be used to override a transaction that has been flagged for manager approval.

Currently this method applies only to electronic check transactions.

See also runTransaction, voidTransaction, runCheckSale, runCheckCredit

Syntax

boolean overrideTransaction ( ueSecurityToken Token, integer RefNum, string Reason )

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Transaction Reference number assigned by the gateway.
string Reason Description of override reason. (Optional, only used with select check processors)

Return Value

boolean

Examples

.NET C#

For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the C Sharp .Net Soap How-to.

string refnum;
            string reason;
 
            refnum = "46976525";
            reason = "Because it is test";
 
            //usaepay.TransactionResponse response = new usaepay.TransactionResponse();
            Boolean response;
 
            try
            {
                response = client.overrideTransaction(token, refnum, reason);
                if (response)
                {
                    MessageBox.Show(string.Concat("Transaction was overrided successfully"));
                }
                else MessageBox.Show(string.Concat("Error"));
            }
            catch (Exception err)
            {
                MessageBox.Show(err.Message);
 
            }
 

VB.Net

  Dim client As usaepay.usaepayService = New usaepay.usaepayService
        Dim token As usaepay.ueSecurityToken
 
        token = Me.CreateToken("714SSUxv1uohng2XkMJ7kLpETsu58G66", "1234")
 
        Dim refnum As String
        refnum = 47019830
 
        Dim reason As String
        reason = "Test"
 
        Dim response As Boolean
        response = client.overrideTransaction(token, refnum, reason)
 
        If response = True Then
            MsgBox("Override Successful.")
        Else
            MsgBox("An Error Occured.")
        End If

XML

<?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:overrideTransaction>
 <Token xsi:type="ns1:ueSecurityToken">
  <ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
  <PinHash xsi:type="ns1:ueHash">
   <HashValue xsi:type="xsd:string">26329b20b448d5c672cefae557458a4213c5f4d4</HashValue>
   <Seed xsi:type="xsd:string">1340127045400107017</Seed>
   <Type xsi:type="xsd:string">sha1</Type>
  </PinHash>
  <SourceKey xsi:type="xsd:string">422_Your_Source_Key_iW67</SourceKey>
 </Token>
 <RefNum xsi:type="xsd:integer">52512512</RefNum>
 <Reason xsi:type="xsd:string">Because we need an example</Reason>
</ns1:overrideTransaction>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Change History

Version Change
1.0 Method added in soap v1.0
developer/soap-1.4/methods/overridetransaction.txt · Last modified: 2012/06/19 10:43 by charlie

Page Tools