Exigo Web Services API v2022.12.19.1

CreatePaymentCheck

Creates a new payment using check information.

Input Properties

CreatePaymentCheckRequest
PropertyData TypeNotes
OrderIDInt32Unique numeric identifier for order record.
PaymentDateDateTime
AmountDecimal
MemoStringOptional.
CheckNumberStringOptional.
CheckAccountNumberStringOptional.
CheckRoutingNumberStringOptional.
CheckDateDateTimeOptional.
OrderKeyStringOptional. Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.

Output Properties

CreatePaymentCheckResponse
PropertyData TypeNotes
PaymentIDInt32
MessageString
DisplayMessageString
MerchantTransactionKeyString

Http Request

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

{ "paymentDate": "2024-11-12T00:00:00-06:00", "amount": null, "orderKey": "1" }

Http Response

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

{ "paymentID": 1, "message": "", "displayMessage": "", "merchantTransactionKey": "", "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/CreatePaymentCheck"

<?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> <CreatePaymentCheckRequest xmlns="http://api.exigo.com/"> <OrderID>int</OrderID> <PaymentDate>dateTime</PaymentDate> <Amount>decimal</Amount> <Memo>string</Memo> <CheckNumber>string</CheckNumber> <CheckAccountNumber>string</CheckAccountNumber> <CheckRoutingNumber>string</CheckRoutingNumber> <CheckDate>dateTime</CheckDate> <OrderKey>string</OrderKey> </CreatePaymentCheckRequest> </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> <CreatePaymentCheckResult 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 CreatePaymentCheckRequest();

 

    req.PaymentDate = DateTime.Today;

    req.Amount = 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

    var res = await api.CreatePaymentCheckAsync(req);

 

    //Now examine the results:

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

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

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

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

}

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

    CreatePaymentCheckRequest req = new CreatePaymentCheckRequest();

 

    req.PaymentDate = DateTime.Today;

    req.Amount = 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

    CreatePaymentCheckResponse res = api.CreatePaymentCheck(req);

 

    //Now examine the results:

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

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

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

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

}

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

 

    req.PaymentDate = DateTime.Today

    req.Amount = 1

    req.OrderKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As CreatePaymentCheckResponse = api.CreatePaymentCheck(req)

 

    'Now examine the results:

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

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

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

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

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

    $req->Amount = 1;

    $req->OrderKey = "1";

 

    //Send Request to Server and Get Response

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

    CreatePaymentCheckRequest req = new CreatePaymentCheckRequest();

 

    req.setPaymentDate(1);

    req.setAmount(1);

    req.setOrderKey("1");

 

    //Send Request to Server and Get Response

    CreatePaymentCheckResponse res = api.getExigoApiSoap().createPaymentCheck(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.