Exigo Web Services API v3.4.252

CreatePaymentCheck

Creates a new payment using check information.

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

Input Properties

CreatePaymentCheckRequest
PropertyData TypeNotes
OrderIDInt32
PaymentDateDateTime
AmountDecimal
MemoStringOptional. Optional.
CheckNumberStringOptional. Optional.
CheckAccountNumberStringOptional. Optional.
CheckRoutingNumberStringOptional. Optional.
CheckDateDateTimeOptional. Optional.

Output Properties

CreatePaymentCheckResponse
PropertyData TypeNotes
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/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> </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/"> <PaymentID>int</PaymentID> </CreatePaymentCheckResult> </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

    CreatePaymentCheckRequest req = new CreatePaymentCheckRequest();

 

    req.OrderID = 1;

    req.PaymentDate = DateTime.Today;

    req.Amount = 1;

 

    //Send Request to Server and Get Response

    CreatePaymentCheckResponse res = api.CreatePaymentCheck(req);

 

    //Now examine the results:

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

 

    req.OrderID = 1

    req.PaymentDate = DateTime.Today

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

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

    $req->PaymentDate = 1;

    $req->Amount = 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.setOrderID(1);

    req.setPaymentDate(1);

    req.setAmount(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.