Exigo Web Services API v3.4.272

GetCustomerBilling

Retruns billing accounts on file for a customer. Only returns last four digits of a credit card.

Input Properties

GetCustomerBillingRequest
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.

Output Properties

GetCustomerBillingResponse
PropertyData TypeNotes
PrimaryCreditCardCreditCardAccountResponse
SecondaryCreditCardCreditCardAccountResponse
BankAccountBankAccountResponse
PrimaryWalletAccountWalletAccountResponse
SecondaryWallletAccountWalletAccountResponse
CreditCardAccountResponse
PropertyData TypeNotes
CreditCardNumberDisplayString
ExpirationMonthInt32
ExpirationYearInt32
CreditCardType Int32Optionally pass in Visa, Master Card, etc.
CreditCardTypeDescriptionString
BillingNameString
BillingAddressString
BillingCityString
BillingState String
BillingZipString
BillingCountry String
BillingAddress2String
CreditCardAccountResponse
PropertyData TypeNotes
CreditCardNumberDisplayString
ExpirationMonthInt32
ExpirationYearInt32
CreditCardType Int32Optionally pass in Visa, Master Card, etc.
CreditCardTypeDescriptionString
BillingNameString
BillingAddressString
BillingCityString
BillingState String
BillingZipString
BillingCountry String
BillingAddress2String
BankAccountResponse
PropertyData TypeNotes
BankAccountNumberDisplayString
BankRoutingNumberString
BankNameString
BankAccountType BankAccountType
NameOnAccountString
BillingAddressString
BillingCityString
BillingState String
BillingZipString
BillingCountry String
BillingAddress2String
WalletAccountResponse
PropertyData TypeNotes
WalletType Int32
WalletAccountDisplayString
WalletAccountResponse
PropertyData TypeNotes
WalletType Int32
WalletAccountDisplayString

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/GetCustomerBilling"

<?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> <GetCustomerBillingRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> </GetCustomerBillingRequest> </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> <GetCustomerBillingResult xmlns="http://api.exigo.com/"> <PrimaryCreditCard> <CreditCardNumberDisplay>string</CreditCardNumberDisplay> <ExpirationMonth>int</ExpirationMonth> <ExpirationYear>int</ExpirationYear> <CreditCardType>int</CreditCardType> <CreditCardTypeDescription>string</CreditCardTypeDescription> <BillingName>string</BillingName> <BillingAddress>string</BillingAddress> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <BillingAddress2>string</BillingAddress2> </PrimaryCreditCard> <SecondaryCreditCard> <CreditCardNumberDisplay>string</CreditCardNumberDisplay> <ExpirationMonth>int</ExpirationMonth> <ExpirationYear>int</ExpirationYear> <CreditCardType>int</CreditCardType> <CreditCardTypeDescription>string</CreditCardTypeDescription> <BillingName>string</BillingName> <BillingAddress>string</BillingAddress> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <BillingAddress2>string</BillingAddress2> </SecondaryCreditCard> <BankAccount> <BankAccountNumberDisplay>string</BankAccountNumberDisplay> <BankRoutingNumber>string</BankRoutingNumber> <BankName>string</BankName> <BankAccountType>CheckingPersonal or CheckingBusiness or SavingsPersonal or SavingsBusiness</BankAccountType> <NameOnAccount>string</NameOnAccount> <BillingAddress>string</BillingAddress> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <BillingAddress2>string</BillingAddress2> </BankAccount> <PrimaryWalletAccount> <WalletType>int</WalletType> <WalletAccountDisplay>string</WalletAccountDisplay> </PrimaryWalletAccount> <SecondaryWallletAccount> <WalletType>int</WalletType> <WalletAccountDisplay>string</WalletAccountDisplay> </SecondaryWallletAccount> </GetCustomerBillingResult> </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

    GetCustomerBillingRequest req = new GetCustomerBillingRequest();

 

    req.CustomerID = 1;             //Unique identifier for a customer entity.

 

    //Send Request to Server and Get Response

    GetCustomerBillingResponse res = api.GetCustomerBilling(req);

 

    //Now examine the results:

    Console.WriteLine("PrimaryCreditCard: {0}", res.PrimaryCreditCard);

    Console.WriteLine("SecondaryCreditCard: {0}", res.SecondaryCreditCard);

    Console.WriteLine("BankAccount: {0}", res.BankAccount);

    Console.WriteLine("PrimaryWalletAccount: {0}", res.PrimaryWalletAccount);

    Console.WriteLine("SecondaryWallletAccount: {0}", res.SecondaryWallletAccount);

}

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

 

    req.CustomerID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerBillingResponse = api.GetCustomerBilling(req)

 

    'Now examine the results:

    Console.WriteLine("PrimaryCreditCard: {0}", res.PrimaryCreditCard)

    Console.WriteLine("SecondaryCreditCard: {0}", res.SecondaryCreditCard)

    Console.WriteLine("BankAccount: {0}", res.BankAccount)

    Console.WriteLine("PrimaryWalletAccount: {0}", res.PrimaryWalletAccount)

    Console.WriteLine("SecondaryWallletAccount: {0}", res.SecondaryWallletAccount)

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;

 

    //Send Request to Server and Get Response

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

    GetCustomerBillingRequest req = new GetCustomerBillingRequest();

 

    req.setCustomerID(1);

 

    //Send Request to Server and Get Response

    GetCustomerBillingResponse res = api.getExigoApiSoap().getCustomerBilling(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.