Exigo Web Services API v3.4.272

SetAccountDirectDeposit

Setup direct deposit info for an existing customer, or new customer in a transaction. You can also empty the account settings by simply leaving everything but CustomerID empty.

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

Input Properties

SetAccountDirectDepositRequest
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
NameOnAccountStringOptional.
BankAccountNumberStringOptional.
BankRoutingNumberStringOptional.
DepositAccountType DepositAccountTypeOptional. The type of account. Defaults to Checking.
BankNameStringOptional.
BankAddressStringOptional.
BankCityStringOptional.
BankStateStringOptional.
BankZipStringOptional.
BankCountryStringOptional.
IbanStringOptional.
SwiftCodeStringOptional.
BankAccountType BankAccountTypeDeprecated, use DepositAccountType instead.

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

<?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> <SetAccountDirectDepositRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <NameOnAccount>string</NameOnAccount> <BankAccountNumber>string</BankAccountNumber> <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> <Iban>string</Iban> <SwiftCode>string</SwiftCode> <BankAccountType>CheckingPersonal or CheckingBusiness or SavingsPersonal or SavingsBusiness</BankAccountType> </SetAccountDirectDepositRequest> </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> <SetAccountDirectDepositResult 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

    SetAccountDirectDepositRequest req = new SetAccountDirectDepositRequest();

 

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

    req.NameOnAccount = "1";

    req.BankAccountNumber = "1";

    req.BankRoutingNumber = "1";

    req.DepositAccountType = DepositAccountType.Checking;     //The type of account

    req.BankName = "1";

    req.BankAddress = "1";

    req.BankCity = "1";

    req.BankState = "1";

    req.BankZip = "1";

    req.BankCountry = "1";

    req.Iban = "1";

    req.SwiftCode = "1";

 

    //Send Request to Server and Get Response

    SetAccountResponse res = api.SetAccountDirectDeposit(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 SetAccountDirectDepositRequest()

 

    req.CustomerID = 1

    req.NameOnAccount = "1"

    req.BankAccountNumber = "1"

    req.BankRoutingNumber = "1"

    req.DepositAccountType = DepositAccountType.Checking

    req.BankName = "1"

    req.BankAddress = "1"

    req.BankCity = "1"

    req.BankState = "1"

    req.BankZip = "1"

    req.BankCountry = "1"

    req.Iban = "1"

    req.SwiftCode = "1"

 

    'Send Request to Server and Get Response

    Dim res As SetAccountResponse = api.SetAccountDirectDeposit(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->NameOnAccount = "1";

    $req->BankAccountNumber = "1";

    $req->BankRoutingNumber = "1";

    $req->DepositAccountType = 1;

    $req->BankName = "1";

    $req->BankAddress = "1";

    $req->BankCity = "1";

    $req->BankState = "1";

    $req->BankZip = "1";

    $req->BankCountry = "1";

    $req->Iban = "1";

    $req->SwiftCode = "1";

 

    //Send Request to Server and Get Response

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

    SetAccountDirectDepositRequest req = new SetAccountDirectDepositRequest();

 

    req.setCustomerID(1);

    req.setNameOnAccount("1");

    req.setBankAccountNumber("1");

    req.setBankRoutingNumber("1");

    req.setDepositAccountType(1);

    req.setBankName("1");

    req.setBankAddress("1");

    req.setBankCity("1");

    req.setBankState("1");

    req.setBankZip("1");

    req.setBankCountry("1");

    req.setIban("1");

    req.setSwiftCode("1");

 

    //Send Request to Server and Get Response

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

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.