CreatePayment
Creates a new payment type using cash, money order etc.Input Properties
CreatePaymentRequest
Output Properties
CreatePaymentResponse
Http Request
POST https://yourcompany-api.exigo.com/3.0/payment HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "paymentDate": "2024-10-14T00:00:00-05: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: lifewave-api.exigo.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.exigo.com/CreatePayment" <?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> <CreatePaymentRequest xmlns="http://api.exigo.com/"> <OrderID>int</OrderID> <PaymentDate>dateTime</PaymentDate> <Amount>decimal</Amount> <PaymentType>Cash or CreditCard or Check or CreditVoucher or Net30 or Net60 or ACHDebit or UseCredit or BankDraft or BankWire or PointRedemtion or COD or MoneyOrder or BankDeposit or Other1 or Other2 or Other3 or Wallet or Other4 or Other5 or Other6 or Other7 or Other8 or Other9 or Other10 or Other11 or Other12 or Other13 or Other14 or Other15</PaymentType> <AuthorizationCode>string</AuthorizationCode> <Memo>string</Memo> <BillingName>string</BillingName> <BillingAddress>string</BillingAddress> <BillingAddress2>string</BillingAddress2> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <OrderKey>string</OrderKey> <PaymentTy>string</PaymentTy> </CreatePaymentRequest> </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> <CreatePaymentResult xmlns="http://api.exigo.com/"> <PaymentID>int</PaymentID> <Message>string</Message> <DisplayMessage>string</DisplayMessage> <MerchantTransactionKey>string</MerchantTransactionKey> </CreatePaymentResult> </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 CreatePaymentRequest();
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.CreatePaymentAsync(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
CreatePaymentRequest req = new CreatePaymentRequest();
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
CreatePaymentResponse res = api.CreatePayment(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 CreatePaymentRequest()
req.PaymentDate = DateTime.Today
req.Amount = 1
req.OrderKey = "1"
'Send Request to Server and Get Response
Dim res As CreatePaymentResponse = api.CreatePayment(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.CreatePayment($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
CreatePaymentRequest req = new CreatePaymentRequest();
req.setPaymentDate(1);
req.setAmount(1);
req.setOrderKey("1");
//Send Request to Server and Get Response
CreatePaymentResponse res = api.getExigoApiSoap().createPayment(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}