ValidateCreditCardToken
Validates a credit card token.Input Properties
ValidateCreditCardTokenRequest
Output Properties
ValidateCreditCardTokenResponse
Http Request
POST https://yourcompany-api.exigo.com/3.0/payment/validate/token HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "creditCardIdentifier": "", "expirationYear": 1, "expirationMonth": 1, "cvcCode": "", "billingName": "", "billingAddress1": "", "billingAddress2": "", "billingCity": "", "billingZip": "", "customerID": 1, "customerKey": "DDks8235txcid", "orderID": 1, "orderKey": "DDks8235txcid", "validateTokenOnFile": true, "accountOnFile": null, "warehouseID": 1, "currencyCode": "1", "email": "1", "phone": "1", "clientIpAddress": "1" }
Http Response
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length{ "authorizationCode": "", "message": "", "success": true, "displayMessage": "", "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/ValidateCreditCardToken" <?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> <ValidateCreditCardTokenRequest xmlns="http://api.exigo.com/"> <CreditCardIdentifier>string</CreditCardIdentifier> <ExpirationYear>int</ExpirationYear> <ExpirationMonth>int</ExpirationMonth> <CvcCode>string</CvcCode> <BillingName>string</BillingName> <BillingAddress1>string</BillingAddress1> <BillingAddress2>string</BillingAddress2> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <CustomerID>int</CustomerID> <CustomerKey>string</CustomerKey> <OrderID>int</OrderID> <OrderKey>string</OrderKey> <Other1>string</Other1> <Other2>string</Other2> <Other3>string</Other3> <Other4>string</Other4> <Other5>string</Other5> <Other6>string</Other6> <Other7>string</Other7> <Other8>string</Other8> <Other9>string</Other9> <Other10>string</Other10> <ValidateTokenOnFile>boolean</ValidateTokenOnFile> <AccountOnFile>Primary or Secondary</AccountOnFile> <WarehouseID>int</WarehouseID> <CurrencyCode>string</CurrencyCode> <Email>string</Email> <Phone>string</Phone> <ClientIpAddress>string</ClientIpAddress> </ValidateCreditCardTokenRequest> </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> <ValidateCreditCardTokenResult xmlns="http://api.exigo.com/"> <AuthorizationCode>string</AuthorizationCode> <Message>string</Message> <Success>boolean</Success> <DisplayMessage>string</DisplayMessage> </ValidateCreditCardTokenResult> </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 ValidateCreditCardTokenRequest();
req.CreditCardIdentifier = "1";
req.ExpirationYear = 1;
req.ExpirationMonth = 1;
req.CvcCode = "1";
req.BillingName = "1";
req.BillingAddress1 = "1";
req.BillingAddress2 = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.CustomerID = 1; //Unique numeric identifier for a customer record.
req.CustomerKey = "DDks8235txcid";//Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
req.OrderID = 1; //Unique numeric identifier for order record.
req.OrderKey = "DDks8235txcid"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.
req.ValidateTokenOnFile = true; //Optional. Use this option to validate information already on file
req.AccountOnFile = TokenAccount.Primary; //Optional. To be used when ValidateTokenOnFile = true
req.WarehouseID = 1; //Optional
req.CurrencyCode = "1"; //Optional
req.Email = "1"; //Optional
req.Phone = "1"; //Optional
req.ClientIpAddress = "1"; //Optional
//Send Request to Server and Get Response
var res = await api.ValidateCreditCardTokenAsync(req);
//Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
Console.WriteLine("Message: {0}", res.Message);
Console.WriteLine("Success: {0}", res.Success);
Console.WriteLine("DisplayMessage: {0}", res.DisplayMessage);
}
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
ValidateCreditCardTokenRequest req = new ValidateCreditCardTokenRequest();
req.CreditCardIdentifier = "1";
req.ExpirationYear = 1;
req.ExpirationMonth = 1;
req.CvcCode = "1";
req.BillingName = "1";
req.BillingAddress1 = "1";
req.BillingAddress2 = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.CustomerID = 1; //Unique numeric identifier for a customer record.
req.CustomerKey = "DDks8235txcid";//Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
req.OrderID = 1; //Unique numeric identifier for order record.
req.OrderKey = "DDks8235txcid"; //Unique alpha numeric identifier for order record. Exeption will occur if OrderID & OrderKey are provided.
req.ValidateTokenOnFile = true; //Optional. Use this option to validate information already on file
req.AccountOnFile = TokenAccount.Primary; //Optional. To be used when ValidateTokenOnFile = true
req.WarehouseID = 1; //Optional
req.CurrencyCode = "1"; //Optional
req.Email = "1"; //Optional
req.Phone = "1"; //Optional
req.ClientIpAddress = "1"; //Optional
//Send Request to Server and Get Response
ValidateCreditCardTokenResponse res = api.ValidateCreditCardToken(req);
//Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
Console.WriteLine("Message: {0}", res.Message);
Console.WriteLine("Success: {0}", res.Success);
Console.WriteLine("DisplayMessage: {0}", res.DisplayMessage);
}
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 ValidateCreditCardTokenRequest()
req.CreditCardIdentifier = "1"
req.ExpirationYear = 1
req.ExpirationMonth = 1
req.CvcCode = "1"
req.BillingName = "1"
req.BillingAddress1 = "1"
req.BillingAddress2 = "1"
req.BillingCity = "1"
req.BillingZip = "1"
req.CustomerID = 1
req.CustomerKey = "DDks8235txcid"
req.OrderID = 1
req.OrderKey = "DDks8235txcid"
req.ValidateTokenOnFile = true
req.AccountOnFile = TokenAccount.Primary
req.WarehouseID = 1
req.CurrencyCode = "1"
req.Email = "1"
req.Phone = "1"
req.ClientIpAddress = "1"
'Send Request to Server and Get Response
Dim res As ValidateCreditCardTokenResponse = api.ValidateCreditCardToken(req)
'Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode)
Console.WriteLine("Message: {0}", res.Message)
Console.WriteLine("Success: {0}", res.Success)
Console.WriteLine("DisplayMessage: {0}", res.DisplayMessage)
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->CreditCardIdentifier = "1";
$req->ExpirationYear = 1;
$req->ExpirationMonth = 1;
$req->CvcCode = "1";
$req->BillingName = "1";
$req->BillingAddress1 = "1";
$req->BillingAddress2 = "1";
$req->BillingCity = "1";
$req->BillingZip = "1";
$req->CustomerID = 1;
$req->CustomerKey = "DDks8235txcid";
$req->OrderID = 1;
$req->OrderKey = "DDks8235txcid";
$req->ValidateTokenOnFile = 1;
$req->AccountOnFile = 1;
$req->WarehouseID = 1;
$req->CurrencyCode = "1";
$req->Email = "1";
$req->Phone = "1";
$req->ClientIpAddress = "1";
//Send Request to Server and Get Response
$res = $api.ValidateCreditCardToken($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
ValidateCreditCardTokenRequest req = new ValidateCreditCardTokenRequest();
req.setCreditCardIdentifier("1");
req.setExpirationYear(1);
req.setExpirationMonth(1);
req.setCvcCode("1");
req.setBillingName("1");
req.setBillingAddress1("1");
req.setBillingAddress2("1");
req.setBillingCity("1");
req.setBillingZip("1");
req.setCustomerID(1);
req.setCustomerKey("DDks8235txcid");
req.setOrderID(1);
req.setOrderKey("DDks8235txcid");
req.setValidateTokenOnFile(1);
req.setAccountOnFile(1);
req.setWarehouseID(1);
req.setCurrencyCode("1");
req.setEmail("1");
req.setPhone("1");
req.setClientIpAddress("1");
//Send Request to Server and Get Response
ValidateCreditCardTokenResponse res = api.getExigoApiSoap().validateCreditCardToken(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}