Exigo Web Services API v2019.2.13.1

RefundPriorCreditCardCharge

Refunds a prior charge. To be used with an order.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

RefundPriorCreditCardChargeRequest
PropertyData TypeNotes
ReturnPaymentIDInt32
OrderIDInt32Unique numeric identifier for order record.
RefundOriginalOrderBooleanOptional. Boolean value that allows payment to be applied directly to the original sales order. If true, ReturnPaymentID should not be set. Defaults to False.
MaxAmountDecimalOptional.
OrderKeyStringOptional. Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

Output Properties

RefundPriorCreditCardChargeResponse
PropertyData TypeNotes
AmountDecimal
AuthorizationCodeString
PaymentIDInt32

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/RefundPriorCreditCardCharge"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <RefundPriorCreditCardChargeRequest xmlns="http://api.exigo.com/"> <ReturnPaymentID>int</ReturnPaymentID> <OrderID>int</OrderID> <RefundOriginalOrder>boolean</RefundOriginalOrder> <MaxAmount>decimal</MaxAmount> <OrderKey>string</OrderKey> </RefundPriorCreditCardChargeRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RefundPriorCreditCardChargeResult xmlns="http://api.exigo.com/"> <Amount>decimal</Amount> <AuthorizationCode>string</AuthorizationCode> </RefundPriorCreditCardChargeResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    RefundPriorCreditCardChargeRequest req = new RefundPriorCreditCardChargeRequest();

 

    req.ReturnPaymentID = 1;

    req.OrderID = 1;                //Unique numeric identifier for order record.

    req.MaxAmount = 1;

    req.OrderKey = "1";             //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

 

    //Send Request to Server and Get Response

    RefundPriorCreditCardChargeResponse res = api.RefundPriorCreditCardCharge(req);

 

    //Now examine the results:

    Console.WriteLine("Amount: {0}", res.Amount);

    Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);

    Console.WriteLine("PaymentID: {0}", res.PaymentID);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new RefundPriorCreditCardChargeRequest()

 

    req.ReturnPaymentID = 1

    req.OrderID = 1

    req.MaxAmount = 1

    req.OrderKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As RefundPriorCreditCardChargeResponse = api.RefundPriorCreditCardCharge(req)

 

    'Now examine the results:

    Console.WriteLine("Amount: {0}", res.Amount)

    Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode)

    Console.WriteLine("PaymentID: {0}", res.PaymentID)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->ReturnPaymentID = 1;

    $req->OrderID = 1;

    $req->MaxAmount = 1;

    $req->OrderKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.RefundPriorCreditCardCharge($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    RefundPriorCreditCardChargeRequest req = new RefundPriorCreditCardChargeRequest();

 

    req.setReturnPaymentID(1);

    req.setOrderID(1);

    req.setMaxAmount(1);

    req.setOrderKey("1");

 

    //Send Request to Server and Get Response

    RefundPriorCreditCardChargeResponse res = api.getExigoApiSoap().refundPriorCreditCardCharge(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.