Soap API v1.2


Refund a specific transaction.


This method refunds a sale. Both credit card and check sale transactions may be refunded. You may choose to refund the entire amount or just a portion of the original sale.

For credit cards, the refund will show up as a separate transaction on the card holder's statement. To cancel the original sale before the batch it is in has been settled, the voidTransaction method should be used instead.

The transaction to be refunded must be retrieved 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, voidTransaction


TransactionResponse refundTransaction ( ueSecurityToken Token, integer RefNum, double Amount )


Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer RefNum Transaction Reference number assigned by the gateway.
double Amount Amount to be refunded (set to 0 if refunding entire original amount)

Return Value

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 SOAP PHP How-to.

try {
  print_r($client->refundTransaction($token,$refnum, $amount));
catch(SoapFault $e) {    
  echo $e->getMessage();
  echo "\n\nRequest: " . $client->__getLastRequest();
  echo "\n\nResponse: " . $client->__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 refund.
  BigInteger RefNum = _runTransaction();
  TransactionResponse response;
  response = client.refundTransaction(token, RefNum, 10.10);
} catch (Exception e) {
    System.out.println("Soap Exception: " + e.getMessage());


<?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">fb8305331a09c4f1002971c5974987ddb0dbba0f
<Seed xsi:type="xsd:string">1193442685704132440</Seed>
<Type xsi:type="xsd:string">sha1</Type>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
<RefNum xsi:type="xsd:integer">1009411</RefNum>
<Amount xsi:type="xsd:double">1.99</Amount>

Change History

Version Change
1.0 Method added in soap v1.0
developer/soap/methods/refundtransaction.txt · Last modified: 2010/05/11 12:52 by vladg

Page Tools