SetAccountChecking
Setup bank account on file 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
SetAccountCheckingRequest
Output Properties
SetAccountResponse
Http Request
PUT https://yourcompany-api.exigo.com/3.0/account/checking HTTP/1.1 Content-Type: application/json Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword){ "customerID": 1, "bankAccountNumber": "", "bankRoutingNumber": "", "bankName": "", "bankAccountType": null, "nameOnAccount": "", "useMainAddress": true, "billingAddress": "", "billingCity": "", "billingZip": "", "driversLicenseNumber": "", "customerKey": "1" }
Http Response
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: length{ "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: lifewave-api.exigo.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://api.exigo.com/SetAccountChecking" <?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> <SetAccountCheckingRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <BankAccountNumber>string</BankAccountNumber> <BankRoutingNumber>string</BankRoutingNumber> <BankName>string</BankName> <BankAccountType>CheckingPersonal or CheckingBusiness or SavingsPersonal or SavingsBusiness</BankAccountType> <NameOnAccount>string</NameOnAccount> <UseMainAddress>boolean</UseMainAddress> <BillingAddress>string</BillingAddress> <BillingCity>string</BillingCity> <BillingState>string</BillingState> <BillingZip>string</BillingZip> <BillingCountry>string</BillingCountry> <DriversLicenseNumber>string</DriversLicenseNumber> <Iban>string</Iban> <SwiftCode>string</SwiftCode> <CustomerKey>string</CustomerKey> </SetAccountCheckingRequest> </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> <SetAccountCheckingResult xmlns="http://api.exigo.com/" /> </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 SetAccountCheckingRequest();
req.CustomerID = 1; //Unique numeric identifier for customer record.
req.BankAccountNumber = "1";
req.BankRoutingNumber = "1";
req.BankName = "1";
req.BankAccountType = BankAccountType.CheckingPersonal; //The type of bank account
req.NameOnAccount = "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
req.BillingAddress = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.DriversLicenseNumber = "1";
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.SetAccountCheckingAsync(req);
//Now examine the results:
}
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
SetAccountCheckingRequest req = new SetAccountCheckingRequest();
req.CustomerID = 1; //Unique numeric identifier for customer record.
req.BankAccountNumber = "1";
req.BankRoutingNumber = "1";
req.BankName = "1";
req.BankAccountType = BankAccountType.CheckingPersonal; //The type of bank account
req.NameOnAccount = "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
req.BillingAddress = "1";
req.BillingCity = "1";
req.BillingZip = "1";
req.DriversLicenseNumber = "1";
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
SetAccountResponse res = api.SetAccountChecking(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 SetAccountCheckingRequest()
req.CustomerID = 1
req.BankAccountNumber = "1"
req.BankRoutingNumber = "1"
req.BankName = "1"
req.BankAccountType = BankAccountType.CheckingPersonal
req.NameOnAccount = "1"
req.UseMainAddress = true
req.BillingAddress = "1"
req.BillingCity = "1"
req.BillingZip = "1"
req.DriversLicenseNumber = "1"
req.CustomerKey = "1"
'Send Request to Server and Get Response
Dim res As SetAccountResponse = api.SetAccountChecking(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->BankAccountNumber = "1";
$req->BankRoutingNumber = "1";
$req->BankName = "1";
$req->BankAccountType = 1;
$req->NameOnAccount = "1";
$req->UseMainAddress = 1;
$req->BillingAddress = "1";
$req->BillingCity = "1";
$req->BillingZip = "1";
$req->DriversLicenseNumber = "1";
$req->CustomerKey = "1";
//Send Request to Server and Get Response
$res = $api.SetAccountChecking($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
SetAccountCheckingRequest req = new SetAccountCheckingRequest();
req.setCustomerID(1);
req.setBankAccountNumber("1");
req.setBankRoutingNumber("1");
req.setBankName("1");
req.setBankAccountType(1);
req.setNameOnAccount("1");
req.setUseMainAddress(1);
req.setBillingAddress("1");
req.setBillingCity("1");
req.setBillingZip("1");
req.setDriversLicenseNumber("1");
req.setCustomerKey("1");
//Send Request to Server and Get Response
SetAccountResponse res = api.getExigoApiSoap().setAccountChecking(req, auth);
//Now examine the results:
}
catch (Exception ex)
{
System.out.println("Error: " + ex.getMessage());
}