ChargeCreditCardTokenOnFile
Attempts to charge a card token on file with the amount found on an exiting order, or a new order in a transaction. If the charge is successful, the order is changed to accepted.Input Properties
ChargeCreditCardTokenOnFileRequest
Output Properties
ChargeCreditCardResponse
Http Request
POST https://yourcompany-api.exigo.com/3.0/payment/charge/tokenonfile HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "creditCardAccountType": null, "orderKey": "1" }
Http Response
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length{ "amount": null, "authorizationCode": "", "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/ChargeCreditCardTokenOnFile" <?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> <ChargeCreditCardTokenOnFileRequest xmlns="http://api.exigo.com/"> <CreditCardAccountType>Primary or Secondary</CreditCardAccountType> <OrderID>int</OrderID> <CvcCode>string</CvcCode> <MaxAmount>decimal</MaxAmount> <MerchantWarehouseIDOverride>int</MerchantWarehouseIDOverride> <ClientIPAddress>string</ClientIPAddress> <OtherData1>string</OtherData1> <OtherData2>string</OtherData2> <OtherData3>string</OtherData3> <OtherData4>string</OtherData4> <OtherData5>string</OtherData5> <OtherData6>string</OtherData6> <OtherData7>string</OtherData7> <OtherData8>string</OtherData8> <OtherData9>string</OtherData9> <OtherData10>string</OtherData10> <OrderKey>string</OrderKey> </ChargeCreditCardTokenOnFileRequest> </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> <ChargeCreditCardTokenOnFileResult xmlns="http://api.exigo.com/"> <Amount>decimal</Amount> <AuthorizationCode>string</AuthorizationCode> </ChargeCreditCardTokenOnFileResult> </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 ChargeCreditCardTokenOnFileRequest();
req.CreditCardAccountType = AccountCreditCardType.Primary;
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.ChargeCreditCardTokenOnFileAsync(req);
//Now examine the results:
Console.WriteLine("Amount: {0}", res.Amount);
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
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
ChargeCreditCardTokenOnFileRequest req = new ChargeCreditCardTokenOnFileRequest();
req.CreditCardAccountType = AccountCreditCardType.Primary;
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
ChargeCreditCardResponse res = api.ChargeCreditCardTokenOnFile(req);
//Now examine the results:
Console.WriteLine("Amount: {0}", res.Amount);
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
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 ChargeCreditCardTokenOnFileRequest()
req.CreditCardAccountType = AccountCreditCardType.Primary
req.OrderKey = "1"
'Send Request to Server and Get Response
Dim res As ChargeCreditCardResponse = api.ChargeCreditCardTokenOnFile(req)
'Now examine the results:
Console.WriteLine("Amount: {0}", res.Amount)
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode)
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->CreditCardAccountType = 1;
$req->OrderKey = "1";
//Send Request to Server and Get Response
$res = $api.ChargeCreditCardTokenOnFile($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
ChargeCreditCardTokenOnFileRequest req = new ChargeCreditCardTokenOnFileRequest();
req.setCreditCardAccountType(1);
req.setOrderKey("1");
//Send Request to Server and Get Response
ChargeCreditCardResponse res = api.getExigoApiSoap().chargeCreditCardTokenOnFile(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}