CreatePaymentCreditCard
Creates a specific credit card payment for an existing order, or a new order in a transaction. Note: This does not charge a card, and you must have an authorization code to submit this.Input Properties
CreatePaymentCreditCardRequest
Output Properties
CreatePaymentCreditCardResponse
Http Request
POST https://yourcompany-api.exigo.com/3.0/payment/creditcard HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "orderID": 1, "paymentDate": "2024-11-07T00:00:00-06:00", "amount": null, "creditCardNumber": "1", "expirationMonth": 1, "expirationYear": 1, "billingName": "", "billingAddress": "", "billingAddress2": "", "billingCity": "", "billingZip": "", "authorizationCode": "1", "memo": "", "orderKey": "1", "merchantTransactionKey": "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/CreatePaymentCreditCard" <?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> <CreatePaymentCreditCardRequest xmlns="http://api.exigo.com/"> <OrderID>int</OrderID> <PaymentDate>dateTime</PaymentDate> <Amount>decimal</Amount> <CreditCardNumber>string</CreditCardNumber> <ExpirationMonth>int</ExpirationMonth> <ExpirationYear>int</ExpirationYear> <BillingName>string</BillingName> <BillingAddress>string</BillingAddress> <BillingAddress2>string</BillingAddress2> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <CreditCardType>int</CreditCardType> <AuthorizationCode>string</AuthorizationCode> <Memo>string</Memo> <OrderKey>string</OrderKey> <MerchantTransactionKey>string</MerchantTransactionKey> </CreatePaymentCreditCardRequest> </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> <CreatePaymentCreditCardResult 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 CreatePaymentCreditCardRequest();
req.OrderID = 1; //Unique numeric identifier for order record.
req.PaymentDate = DateTime.Today;
req.Amount = 1;
req.CreditCardNumber = "1";
req.ExpirationMonth = 1;
req.ExpirationYear = 1;
req.BillingName = "1";
req.BillingAddress = "1";
req.BillingAddress2 = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.AuthorizationCode = "1";
req.Memo = "1";
req.OrderKey = "1"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.
req.MerchantTransactionKey = "1";
//Send Request to Server and Get Response
var res = await api.CreatePaymentCreditCardAsync(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
CreatePaymentCreditCardRequest req = new CreatePaymentCreditCardRequest();
req.OrderID = 1; //Unique numeric identifier for order record.
req.PaymentDate = DateTime.Today;
req.Amount = 1;
req.CreditCardNumber = "1";
req.ExpirationMonth = 1;
req.ExpirationYear = 1;
req.BillingName = "1";
req.BillingAddress = "1";
req.BillingAddress2 = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.AuthorizationCode = "1";
req.Memo = "1";
req.OrderKey = "1"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.
req.MerchantTransactionKey = "1";
//Send Request to Server and Get Response
CreatePaymentCreditCardResponse res = api.CreatePaymentCreditCard(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 CreatePaymentCreditCardRequest()
req.OrderID = 1
req.PaymentDate = DateTime.Today
req.Amount = 1
req.CreditCardNumber = "1"
req.ExpirationMonth = 1
req.ExpirationYear = 1
req.BillingName = "1"
req.BillingAddress = "1"
req.BillingAddress2 = "1"
req.BillingCity = "1"
req.BillingZip = "1"
req.AuthorizationCode = "1"
req.Memo = "1"
req.OrderKey = "1"
req.MerchantTransactionKey = "1"
'Send Request to Server and Get Response
Dim res As CreatePaymentCreditCardResponse = api.CreatePaymentCreditCard(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->OrderID = 1;
$req->PaymentDate = 1;
$req->Amount = 1;
$req->CreditCardNumber = "1";
$req->ExpirationMonth = 1;
$req->ExpirationYear = 1;
$req->BillingName = "1";
$req->BillingAddress = "1";
$req->BillingAddress2 = "1";
$req->BillingCity = "1";
$req->BillingZip = "1";
$req->AuthorizationCode = "1";
$req->Memo = "1";
$req->OrderKey = "1";
$req->MerchantTransactionKey = "1";
//Send Request to Server and Get Response
$res = $api.CreatePaymentCreditCard($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
CreatePaymentCreditCardRequest req = new CreatePaymentCreditCardRequest();
req.setOrderID(1);
req.setPaymentDate(1);
req.setAmount(1);
req.setCreditCardNumber("1");
req.setExpirationMonth(1);
req.setExpirationYear(1);
req.setBillingName("1");
req.setBillingAddress("1");
req.setBillingAddress2("1");
req.setBillingCity("1");
req.setBillingZip("1");
req.setAuthorizationCode("1");
req.setMemo("1");
req.setOrderKey("1");
req.setMerchantTransactionKey("1");
//Send Request to Server and Get Response
CreatePaymentCreditCardResponse res = api.getExigoApiSoap().createPaymentCreditCard(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}