Exigo Web Services API v3.4.272

SetAccountCreditCardToken

Setup primary or secondary credit card token on file for an existing customer, or new customer in a transaction.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

SetAccountCreditCardTokenRequest
PropertyData TypeNotes
CustomerIDInt32The customer's unique identifier. This field is not required if it part of a transaction that is also creating a customer.
CreditCardAccountType AccountCreditCardTypeOptional. Whether the credit card is the customer's primary or secondary card. Defaults to Primary.
CreditCardTokenStringThe credit card's token created by the Exigo Payment API.
ExpirationMonthInt32The month of the card's expiration date.
ExpirationYearInt32The year of the card's expiration date.
CreditCardTypeInt32Optional. Defaults to 1.
BillingNameStringOptional.
UseMainAddressBooleanIf true, the customer's main address on file will be used. If UseMainAddress is set to true, do not submit a seperate billing address.
BillingAddressStringOptional.
BillingAddress2StringOptional.
BillingCityStringOptional.
BillingStateStringThe state of the card's billing address. If UseMainAddress is set to true, do not set this field.
BillingZipStringOptional.
BillingCountryStringThe country of the card's billing address. If UseMainAddress is set to true, do not set this field.
HideFromWebBooleanOptional. Can be used for AutoOrder but will not show up in shopping cart.

Output Properties

SetAccountResponse
PropertyData TypeNotes

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: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/SetAccountCreditCardToken"

<?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> <SetAccountCreditCardTokenRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <CreditCardAccountType>Primary or Secondary</CreditCardAccountType> <CreditCardToken>string</CreditCardToken> <ExpirationMonth>int</ExpirationMonth> <ExpirationYear>int</ExpirationYear> <CreditCardType>int</CreditCardType> <BillingName>string</BillingName> <UseMainAddress>boolean</UseMainAddress> <BillingAddress>string</BillingAddress> <BillingAddress2>string</BillingAddress2> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <HideFromWeb>boolean</HideFromWeb> </SetAccountCreditCardTokenRequest> </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> <SetAccountCreditCardTokenResult xmlns="http://api.exigo.com/" /> </soap:Body> </soap:Envelope>

C#

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

    SetAccountCreditCardTokenRequest req = new SetAccountCreditCardTokenRequest();

 

    req.CustomerID = 1;             //The customer's unique identifier. This field is not required if it part of a transaction that is also creating a customer.

    req.CreditCardAccountType = AccountCreditCardType.Primary;  //Whether the credit card is the customer's primary or secondary card.

    req.CreditCardToken = "5AE56HJ42OPZ5487";//The credit card's token created by the Exigo Payment API

    req.ExpirationMonth = 1;        //The month of the card's expiration date

    req.ExpirationYear = 2015;      //The year of the card's expiration date

    req.CreditCardType = 1;         //Defaults to 1.

    req.UseMainAddress = true;         //If true, the customer's main address on file will be used. If UseMainAddress is set to true, do not submit a seperate billing address

 

    //Send Request to Server and Get Response

    SetAccountResponse res = api.SetAccountCreditCardToken(req);

 

    //Now examine the results:

}

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 SetAccountCreditCardTokenRequest()

 

    req.CustomerID = 1

    req.CreditCardAccountType = AccountCreditCardType.Primary

    req.CreditCardToken = "5AE56HJ42OPZ5487"

    req.ExpirationMonth = 1

    req.ExpirationYear = 2015

    req.CreditCardType = 1

    req.UseMainAddress = true

 

    'Send Request to Server and Get Response

    Dim res As SetAccountResponse = api.SetAccountCreditCardToken(req)

 

    'Now examine the results:

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->CustomerID = 1;

    $req->CreditCardAccountType = 1;

    $req->CreditCardToken = "5AE56HJ42OPZ5487";

    $req->ExpirationMonth = 1;

    $req->ExpirationYear = 2015;

    $req->CreditCardType = 1;

    $req->UseMainAddress = 1;

 

    //Send Request to Server and Get Response

    $res = $api.SetAccountCreditCardToken($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

    SetAccountCreditCardTokenRequest req = new SetAccountCreditCardTokenRequest();

 

    req.setCustomerID(1);

    req.setCreditCardAccountType(1);

    req.setCreditCardToken("5AE56HJ42OPZ5487");

    req.setExpirationMonth(1);

    req.setExpirationYear(2015);

    req.setCreditCardType(1);

    req.setUseMainAddress(1);

 

    //Send Request to Server and Get Response

    SetAccountResponse res = api.getExigoApiSoap().setAccountCreditCardToken(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.