Exigo API Web Service

GetCustomerBilling

Returns billing accounts on file for a customer. Only => s last four digits of a credit card.

Input Properties

GetCustomerBillingRequest

PropertyData TypeNotes

CustomerIDInt32Unique numeric identifier for customer record.

CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetCustomerBillingResponse

PropertyData TypeNotes

PrimaryCreditCardCreditCardAccountResponse

SecondaryCreditCardCreditCardAccountResponse

BankAccountBankAccountResponse

PrimaryWalletAccountWalletAccountResponse

SecondaryWallletAccountWalletAccountResponse

ThirdWalletAccountWalletAccountResponse

FourthWalletAccountWalletAccountResponse

FifthWalletAccountWalletAccountResponse

CreditCardAccountResponse

PropertyData TypeNotes

CreditCardNumberDisplayString

CreditCardTokenString

ExpirationMonthInt32

ExpirationYearInt32

CreditCardType Int32Optionally pass in Visa, Master Card, etc.

CreditCardTypeDescriptionString

BillingNameString

BillingAddressString

BillingCityString

BillingState String

BillingZipString

BillingCountry String

BillingAddress2String

CreditCardAccountResponse

PropertyData TypeNotes

CreditCardNumberDisplayString

CreditCardTokenString

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

CheckIbanString

CheckSwiftCodeString

WalletAccountResponse

PropertyData TypeNotes

WalletType Int32

WalletAccountDisplayString

WalletOther1String

WalletOther2String

WalletOther3String

WalletAccountResponse

PropertyData TypeNotes

WalletType Int32

WalletAccountDisplayString

WalletOther1String

WalletOther2String

WalletOther3String

WalletAccountResponse

PropertyData TypeNotes

WalletType Int32

WalletAccountDisplayString

WalletOther1String

WalletOther2String

WalletOther3String

WalletAccountResponse

PropertyData TypeNotes

WalletType Int32

WalletAccountDisplayString

WalletOther1String

WalletOther2String

WalletOther3String

WalletAccountResponse

PropertyData TypeNotes

WalletType Int32

WalletAccountDisplayString

WalletOther1String

WalletOther2String

WalletOther3String

Http Request

GET https://yourcompany-api.exigo.com/3.0/account?customerID=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "primaryCreditCard": null,
  "secondaryCreditCard": null,
  "bankAccount": null,
  "primaryWalletAccount": null,
  "secondaryWallletAccount": null,
  "thirdWalletAccount": null,
  "fourthWalletAccount": null,
  "fifthWalletAccount": null,
  "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/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>
      <CustomerKey>string</CustomerKey>
    </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>
        <CreditCardToken>string</CreditCardToken>
        <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>
        <CreditCardToken>string</CreditCardToken>
        <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>
        <CheckIban>string</CheckIban>
        <CheckSwiftCode>string</CheckSwiftCode>
      </BankAccount>
      <PrimaryWalletAccount>
        <WalletType>int</WalletType>
        <WalletAccountDisplay>string</WalletAccountDisplay>
        <WalletOther1>string</WalletOther1>
        <WalletOther2>string</WalletOther2>
        <WalletOther3>string</WalletOther3>
      </PrimaryWalletAccount>
      <SecondaryWallletAccount>
        <WalletType>int</WalletType>
        <WalletAccountDisplay>string</WalletAccountDisplay>
        <WalletOther1>string</WalletOther1>
        <WalletOther2>string</WalletOther2>
        <WalletOther3>string</WalletOther3>
      </SecondaryWallletAccount>
      <ThirdWalletAccount>
        <WalletType>int</WalletType>
        <WalletAccountDisplay>string</WalletAccountDisplay>
        <WalletOther1>string</WalletOther1>
        <WalletOther2>string</WalletOther2>
        <WalletOther3>string</WalletOther3>
      </ThirdWalletAccount>
      <FourthWalletAccount>
        <WalletType>int</WalletType>
        <WalletAccountDisplay>string</WalletAccountDisplay>
        <WalletOther1>string</WalletOther1>
        <WalletOther2>string</WalletOther2>
        <WalletOther3>string</WalletOther3>
      </FourthWalletAccount>
      <FifthWalletAccount>
        <WalletType>int</WalletType>
        <WalletAccountDisplay>string</WalletAccountDisplay>
        <WalletOther1>string</WalletOther1>
        <WalletOther2>string</WalletOther2>
        <WalletOther3>string</WalletOther3>
      </FifthWalletAccount>
    </GetCustomerBillingResult>
  </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 GetCustomerBillingRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.CustomerKey = "1"; //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.GetCustomerBillingAsync(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);

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

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

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

}

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

GetCustomerBillingRequest req = new GetCustomerBillingRequest();

req.CustomerID = 1; //Unique numeric identifier for customer record.

req.CustomerKey = "1"; //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

//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);

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

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

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

}

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

req.CustomerKey = "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)

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

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

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

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->CustomerKey = "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);

req.setCustomerKey("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.

Exigo Web Services API v2022.12.19.1

GetCustomerBilling

Input Properties

GetCustomerBillingRequest

Output Properties

GetCustomerBillingResponse

CreditCardAccountResponse

CreditCardAccountResponse

BankAccountResponse

WalletAccountResponse

WalletAccountResponse

WalletAccountResponse

WalletAccountResponse

WalletAccountResponse

Soap Response

C# Soap Client

VB.Net

PHP

Java

CSV