Exigo Web Services API v2022.12.19.1

 Search

VoidPayments

Voids payments

Input Properties

VoidPaymentsRequest
PropertyData TypeNotes
PaymentIdStartInt32Optional. If voiding payments by range, PaymentIdEnd must also be set. Defaults to 0.
PaymentIdEndInt32Optional. If voiding payments by range, PaymentIdStart must also be set. Defaults to 0.
PaymentIdsInt32[]Optional. If voiding payments by list, neither PaymentIdStart nor PaymentIdEnd must be set.

Output Properties

VoidPaymentsResponse
PropertyData TypeNotes

Http Request

POST https://yourcompany-api.exigo.com/3.0/payment/void HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)


{
  "paymentIdStart": 1,
  "paymentIdEnd": 1
}

Http Response

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


{
  "result": null
}

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: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/VoidPayments"

<?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>
    <voidPaymentsRequest xmlns="http://api.exigo.com/">
      <PaymentIdStart>int</PaymentIdStart>
      <PaymentIdEnd>int</PaymentIdEnd>
      <PaymentIds>
        <int>int</int>
      </PaymentIds>
    </voidPaymentsRequest>
  </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>
    <VoidPaymentsResult xmlns="http://api.exigo.com/" />
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new VoidPaymentsRequest();

 

    req.PaymentIdStart = 1;         //If voiding payments by range, PaymentIdEnd must also be set.

    req.PaymentIdEnd = 1;           //If voiding payments by range, PaymentIdStart must also be set.

 

    //Send Request to Server and Get Response

    var res = await api.VoidPaymentsAsync(req);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

C# Soap Client

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

    VoidPaymentsRequest req = new VoidPaymentsRequest();

 

    req.PaymentIdStart = 1;         //If voiding payments by range, PaymentIdEnd must also be set.

    req.PaymentIdEnd = 1;           //If voiding payments by range, PaymentIdStart must also be set.

 

    //Send Request to Server and Get Response

    VoidPaymentsResponse res = api.VoidPayments(req);

 

    //Now examine the results:

}

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 VoidPaymentsRequest()

 

    req.PaymentIdStart = 1

    req.PaymentIdEnd = 1

 

    'Send Request to Server and Get Response

    Dim res As VoidPaymentsResponse = api.VoidPayments(req)

 

    'Now examine the results:

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->PaymentIdStart = 1;

    $req->PaymentIdEnd = 1;

 

    //Send Request to Server and Get Response

    $res = $api.VoidPayments($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

    VoidPaymentsRequest req = new VoidPaymentsRequest();

 

    req.setPaymentIdStart(1);

    req.setPaymentIdEnd(1);

 

    //Send Request to Server and Get Response

    VoidPaymentsResponse res = api.getExigoApiSoap().voidPayments(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.