AuthorizeOnlyCreditCardTokenOnFile
Attempts to authorize only a credit card token on file. A follow up ChargePriorAuthorization will need to be issued to actually capture and settle the authorization.Input Properties
AuthorizeOnlyCreditCardTokenOnFileRequest
Output Properties
AuthorizeOnlyCreditCardResponse
Http Request
Rest call not available for this method yet.
Http Response
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/AuthorizeOnlyCreditCardTokenOnFile" <?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> <authorizeOnlyCreditCardTokenOnFileRequest xmlns="http://api.exigo.com/"> <CreditCardAccountType>Primary or Secondary</CreditCardAccountType> <WarehouseID>int</WarehouseID> <CurrencyCode>string</CurrencyCode> <CustomerID>int</CustomerID> <Amount>decimal</Amount> <CustomerKey>string</CustomerKey> </authorizeOnlyCreditCardTokenOnFileRequest> </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> <AuthorizeOnlyCreditCardTokenOnFileResult xmlns="http://api.exigo.com/"> <AuthorizationCode>string</AuthorizationCode> <MerchantTransactionKey>string</MerchantTransactionKey> <Message>string</Message> <DisplayMessage>string</DisplayMessage> </AuthorizeOnlyCreditCardTokenOnFileResult> </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 AuthorizeOnlyCreditCardTokenOnFileRequest();
req.CreditCardAccountType = AccountCreditCardType.Primary;
req.WarehouseID = 1; //Unique location for orders
req.CurrencyCode = "usd";
req.CustomerID = 1; //Unique numeric identifier for a customer record.
req.Amount = 1;
req.CustomerKey = "DDks8235txcid";//Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
//Send Request to Server and Get Response
var res = await api.AuthorizeOnlyCreditCardTokenOnFileAsync(req);
//Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
Console.WriteLine("MerchantTransactionKey: {0}", res.MerchantTransactionKey);
Console.WriteLine("Message: {0}", res.Message);
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
AuthorizeOnlyCreditCardTokenOnFileRequest req = new AuthorizeOnlyCreditCardTokenOnFileRequest();
req.CreditCardAccountType = AccountCreditCardType.Primary;
req.WarehouseID = 1; //Unique location for orders
req.CurrencyCode = "usd";
req.CustomerID = 1; //Unique numeric identifier for a customer record.
req.Amount = 1;
req.CustomerKey = "DDks8235txcid";//Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
//Send Request to Server and Get Response
AuthorizeOnlyCreditCardResponse res = api.AuthorizeOnlyCreditCardTokenOnFile(req);
//Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode);
Console.WriteLine("MerchantTransactionKey: {0}", res.MerchantTransactionKey);
Console.WriteLine("Message: {0}", res.Message);
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 AuthorizeOnlyCreditCardTokenOnFileRequest()
req.CreditCardAccountType = AccountCreditCardType.Primary
req.WarehouseID = 1
req.CurrencyCode = "usd"
req.CustomerID = 1
req.Amount = 1
req.CustomerKey = "DDks8235txcid"
'Send Request to Server and Get Response
Dim res As AuthorizeOnlyCreditCardResponse = api.AuthorizeOnlyCreditCardTokenOnFile(req)
'Now examine the results:
Console.WriteLine("AuthorizationCode: {0}", res.AuthorizationCode)
Console.WriteLine("MerchantTransactionKey: {0}", res.MerchantTransactionKey)
Console.WriteLine("Message: {0}", res.Message)
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->CreditCardAccountType = 1;
$req->WarehouseID = 1;
$req->CurrencyCode = "usd";
$req->CustomerID = 1;
$req->Amount = 1;
$req->CustomerKey = "DDks8235txcid";
//Send Request to Server and Get Response
$res = $api.AuthorizeOnlyCreditCardTokenOnFile($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
AuthorizeOnlyCreditCardTokenOnFileRequest req = new AuthorizeOnlyCreditCardTokenOnFileRequest();
req.setCreditCardAccountType(1);
req.setWarehouseID(1);
req.setCurrencyCode("usd");
req.setCustomerID(1);
req.setAmount(1);
req.setCustomerKey("DDks8235txcid");
//Send Request to Server and Get Response
AuthorizeOnlyCreditCardResponse res = api.getExigoApiSoap().authorizeOnlyCreditCardTokenOnFile(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}