Exigo Web Services API v2022.12.19.1

 Search

GetAccountDirectDeposit

Returns direct deposit info for an existing customer.

Input Properties

GetAccountDirectDepositRequest
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

GetAccountDirectDepositResponse
PropertyData TypeNotes
NameOnAccountString
BankAccountNumberDisplayString
BankRoutingNumberString
DepositAccountType DepositAccountTypeDeprecated, use DepositAccountType instead.
BankNameString
BankAddressString
BankCityString
BankStateString
BankZipString
BankCountryString
BankAccountType BankAccountTypeDeprecated, use DepositAccountTypeID instead.
IbanString
SwiftCodeString
DepositAccountTypeID Int32Classification of bank account.

Http Request

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

Http Response

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


{
  "nameOnAccount": "",
  "bankAccountNumberDisplay": "",
  "bankRoutingNumber": "",
  "depositAccountType": null,
  "bankName": "",
  "bankAddress": "",
  "bankCity": "",
  "bankState": "",
  "bankZip": "",
  "bankCountry": "",
  "bankAccountType": null,
  "iban": "",
  "swiftCode": "",
  "depositAccountTypeID": 1,
  "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/GetAccountDirectDeposit"

<?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>
    <GetAccountDirectDepositRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <CustomerKey>string</CustomerKey>
    </GetAccountDirectDepositRequest>
  </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>
    <GetAccountDirectDepositResult xmlns="http://api.exigo.com/">
      <NameOnAccount>string</NameOnAccount>
      <BankAccountNumberDisplay>string</BankAccountNumberDisplay>
      <BankRoutingNumber>string</BankRoutingNumber>
      <DepositAccountType>Checking or Saving or Business or Personal</DepositAccountType>
      <BankName>string</BankName>
      <BankAddress>string</BankAddress>
      <BankCity>string</BankCity>
      <BankState>string</BankState>
      <BankZip>string</BankZip>
      <BankCountry>string</BankCountry>
      <BankAccountType>CheckingPersonal or CheckingBusiness or SavingsPersonal or SavingsBusiness</BankAccountType>
      <Iban>string</Iban>
      <SwiftCode>string</SwiftCode>
      <DepositAccountTypeID>int</DepositAccountTypeID>
    </GetAccountDirectDepositResult>
  </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 GetAccountDirectDepositRequest();

 

    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.GetAccountDirectDepositAsync(req);

 

    //Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

}

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

    GetAccountDirectDepositRequest req = new GetAccountDirectDepositRequest();

 

    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

    GetAccountDirectDepositResponse res = api.GetAccountDirectDeposit(req);

 

    //Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

}

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

 

    req.CustomerID = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetAccountDirectDepositResponse = api.GetAccountDirectDeposit(req)

 

    'Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

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.GetAccountDirectDeposit($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

    GetAccountDirectDepositRequest req = new GetAccountDirectDepositRequest();

 

    req.setCustomerID(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    GetAccountDirectDepositResponse res = api.getExigoApiSoap().getAccountDirectDeposit(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.