getDepositHistory()
Get deposit history data for your entire program or related to a specific customer.
Recordset Paging
Large data sets can be retrieved using recordset paging. A maximum date range of three years (1095 days) is allowed. When retrieving a large data set, pass the number of records desired (500 per page maximum) as the 'recordCnt' parameter value. Each response will include the total number of records found related to the date range as 'total_record_count'. The number of pages available will be returned as 'number_of_pages'. The current page being returned is communicated simply as 'page'. The API consumer can request the different pages of the recordset by passing the desired page number as the 'page' parameter.
Parameters
Parameter Required Data type Pattern Notes
transactionId Yes String

60 characters or less

9845dk-39fdk3fj3-4483483478

A unique system generated ID number that identifies the API transaction with Galileo Processing systems. A UUID is preferred. This must be different for each transaction.
accountNo No String

PAN or PRN

074103447228

Can be either a PAN (the 16 digit card number) or PRN (a unique 12 digit account identifier).
startDate Yes Date

YYYY-MM-DD

2016-01-01

The beginning date for the date range.
endDate Yes Date

YYYY-MM-DD

2016-02-01

The end date for the date range; must be greater than or equal to the startDate.
recordCnt No Integer

Positive integer value in the range of 1 and 99999.

100

The maximum number of records to be returned in the method response.
page No Number

Integer value of 1 or greater.

3

The page number to be retrieved in the context of recordset paging.
Status Codes
Status Code description
0 Success
2 Invalid parameter(s)
12 Invalid customer account
-1 Indicates that the application record failed to update or return.
Response
<?xml version="1.0" encoding="UTF-8"?>
<response>
   <status_code>0</status_code>
   <status>Success</status>
   <system_timestamp>2017-08-18 13:13:06</system_timestamp>
   <response_data>
     <deposit_count>3</deposit_count>
     <page>1</page>
     <total_record_count>61</total_record_count>
     <number_of_pages>21</number_of_pages>
     <start_date>2012-01-01</start_date>
     <end_date>2014-01-01</end_date>
     <deposits>
       <deposit>
         <ach_trans_id>13236551</ach_trans_id>
         <amt>606.75</amt>
         <in_ts>2011-03-10 06:40:16</in_ts>
         <effective_dt/>
         <name>MARY POPPINS</name>
         <xid/>
         <prog_id>163</prog_id>
         <batch_hdr>5200SEQUOYAH RESIDENTIAL FACILI3836826351722616653PPDQUICKBOOKS1103111103110701021000020002330</batch_hdr>
         <dest_acct_no>733101000053</dest_acct_no>
         <source_inst_id>091000080</source_inst_id>
         <source_inst_name>SEQUOYAH RESIDEN</source_inst_name>
         <status>R</status>
         <trans_type>DE</trans_type>
         <categories>
           <category>
             <category_code>COF</category_code>
             <description>Questionable IAT Country (COF)</description>
             <status>NEW</status>
             <ach_source_id>106</ach_source_id>
             <source_status>DECLINE</source_status>
             <last_updated>2010-12-27 11:31:27</last_updated>
             <last_updated_by/>
           </category>
         </categories>
       </deposit>
       <deposit>
         <ach_trans_id>13236553</ach_trans_id>
         <amt>763.42</amt>
         <in_ts>2011-03-10 06:40:16</in_ts>
         <effective_dt/>
         <name>PAUL McCARTNEY</name>
         <xid/>
         <prog_id>163</prog_id>
         <batch_hdr>5200SOUTH STATE CONTRACTORS, IN6214371451722616653PPDQUICKBOOKS1103111103110701021000020002332</batch_hdr>
         <dest_acct_no>733101000053</dest_acct_no>
         <source_inst_id>091000080</source_inst_id>
         <source_inst_name>SOUTH STATE CONT</source_inst_name>
         <status>R</status>
         <trans_type>DE</trans_type>
         <categories>
           <category>
             <category_code>OTH</category_code>
             <description>OTH</description>
             <status>NEW</status>
             <ach_source_id>108</ach_source_id>
           </category>
         </categories>
       </deposit>
       <deposit>
         <ach_trans_id>13236568</ach_trans_id>
         <amt>316.42</amt>
         <in_ts>2011-03-10 06:40:16</in_ts>
         <effective_dt/>
         <name>capone12 test12</name>
         <xid/>
         <prog_id>163</prog_id>
         <batch_hdr>5200UNITED LANDSCAPES, INC.    8105490651722616653PPDQUICKBOOKS1103111103110701021000020002342</batch_hdr>
         <dest_acct_no>733101002372</dest_acct_no>
         <source_inst_id>091000080</source_inst_id>
         <source_inst_name>UNITED LANDSCAPE</source_inst_name>
         <status>R</status>
         <trans_type>DE</trans_type>
         <categories>
           <category>
             <category_code>NAM</category_code>
             <description>Name missmatch (NAM)</description>
             <status>NEW</status>
             <ach_source_id>123</ach_source_id>
           </category>
         </categories>
       </deposit>
     </deposits>
   </response_data>
   <processing_time>0.613</processing_time>
   <echo>
     <transaction_id>823441462</transaction_id>
     <provider_transaction_id>GAAP test</provider_transaction_id>
     <provider_timestamp>2017-08-18 13:00:48</provider_timestamp>
   </echo>
</response>
 
Response Description Example value
status The condition of a process or response (such as embossed card, account, freeze, and so on). Success
status_code The status of the response. 0
system_timestamp A system generated timestamp. 2011-02-02 11:11:12
response_data A structure for the response data. It can be empty but usually will contain information. <response_data>
   <new_account>   </new_account>
</response_data>
deposit_count The number of deposits in the response. 3
page The page number to be retrieved in the context of recordset paging. 1
total_record_count Number of records in the accounts list display. 61
number_of_pages Total number of pages in the accounts list display. 21
start_date The start date of a response. 2018-01-01
end_date The end date of a response. The end date must always be later than the start date, (violations will trigger a bad date range response). 2018-01-02
pending_deposits A data structure that contains information on pending deposits. <pending_deposits>
<pending_deposit></pending_deposit>
</pending_deposits>
pending_deposit A data structure that displays incoming ACH related payments that are flagged for review. <pending_deposit>
   <amt></amt>
   <in_ts></in_ts>
   <effective_dt/>
   <name/>
   <xid></xid>
   <prog_id> </prog_id>
   <batch_hdr></batch_hdr>
   <dest_acct_no></dest_acct_no>
   <source_inst_id> </source_inst_id>
   <source_inst_name> </source_inst_name>
   <status> </status>
   <trans_type> </trans_type>
   <addenda_rec> </addenda_rec>
   <categories>
     <category>
       <category_code> </category_code>
       <description> </description>
       <status> </status>
       <ach_source_id/>
     </category>
   </categories>
   <ach_trans_id> </ach_trans_id>
</pending_deposit>
ach_trans_id A unique ID for an ACH transaction. 13234257
amt A fee or transaction charge. 244
in_ts An initial time and date stamp for the creation of the record. 2011-03-10 06:39:38
effective_dt Attached to an ACH record that specifies when the payment posts. 2014-10-15 00:00:00
name In getPendingDeposits(), the name of the account receiving the flagged deposit. Fredericksons
xid An account ID that can be used instead of the PAN or other restricted information. 1294559
prog_id An ID number unique to a program. 163
batch_hdr A record of a batch of transactions. 5200STATE OF OHIO INCOME TAX REFUNDS 4311334820PPDTAXREFUNDS031
1111103110701041001030000640
dest_acct_no The destination account for a flagged pending deposit. 733101000053
source_inst_id An ID (usually a bank routing number) for the institution that originated the deposit. 041001039
source_inst_name The name of the institution that originated the deposit. STATE OF OHIO
status In getPendingDeposits(), the status of the deposit. U
trans_type Transaction Type. A short, generic transaction category. DE
categories A data structure that contains category information. <categories>
<category></category>
</categories>
category In getPendingDeposits, a data structure that contains tax information for a pending deposit. <category>
  <category_code>TAX</category_code>
   <description>Tax (TAX)</description>
   <status>NEW</status>
   <ach_source_id/>
</category>
category_code In getPendingDeposits(), the category the transaction falls within. TAX
description In getPendingDeposits(), a plain text description of a pending deposit. Tax (TAX)
ach_source_id A document or record that supports the transaction. 106
ach_trans_id A unique ID for an ACH transaction. 13234257
processing_time The time elapsed in processing the transaction. 1.723
echo A structure that displays transaction ID information. <echo>
  <transaction_id>...</transaction_id>
  <provider_transaction_id>...</provider_transaction_id>
  <provider_timestamp>...</provider_timestamp>
</echo>
transaction_id A number that represents a transaction. 12345a
provider_transaction_id Secondary transaction identifier (generated by a provider). 77bb
provider_timestamp Store a related timestamp for reporting and troubleshooting purposes. 2013-02-06 10:10:10
Code Snippet
                    # The following shell script will use cURL to call getDepositHistory
# and return the json response.

curl -d '{"apiLogin":"AbC1234-9999", "apiTransKey":"9845dk-39fdk3fj3-4483483478", "transactionId":"45k-dk3fj3-44478", "startDate":"2016-01-01", "endDate":"2016-02-01"}' \ 
-H "response-content-type: json" \ 
-X POST https://**your-full-implementation-url**/getDepositHistory
                
                    // The following Java code will make a getDepositHistory call
// and print the json response.

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.Reader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLEncoder;
import java.util. *;

class GalileoAPICall
{
    public static void main(String[] args) {
        try {
            Map<String,Object> params = new LinkedHashMap<>();
           params.put("apiLogin", "AbC1234-9999");
           params.put("apiTransKey", "9845dk-39fdk3fj3-4483483478");
           params.put("transactionId", "45k-dk3fj3-44478");
           params.put("startDate", "2016-01-01");
           params.put("endDate", "2016-02-01");
            StringBuilder postData = new StringBuilder();
            for (Map.Entry<String,Object> param : params.entrySet()) {
                if (postData.length() != 0) postData.append('&');
                postData.append(URLEncoder.encode(param.getKey(), "UTF-8"));
                postData.append('=');
                postData.append(URLEncoder.encode(String.valueOf(param.getValue()), "UTF-8"));
            }
            byte[] postDataBytes = postData.toString().getBytes("UTF-8");

            URL url = new URL("https://**your-full-implementation-url**/getDepositHistory");

            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("response-content-type", "json");
            conn.setRequestProperty("Content-Length", String.valueOf(postDataBytes.length));
            conn.setDoOutput(true);
            conn.getOutputStream().write(postDataBytes);

            String xmlOutput;

            Reader in = new BufferedReader(new InputStreamReader(conn.getInputStream(), "UTF-8"));
            for (int c; (c = in.read()) >= 0;) {
                System.out.print((char)c);
            }
        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
                
                    # The following Python code will call getDepositHistory
# and print the json response.

import requests
headers = {'response-content-type': 'json'}
payload = {'apiLogin': 'AbC1234-9999', 'apiTransKey': '9845dk-39fdk3fj3-4483483478', 'transactionId': '45k-dk3fj3-44478', 'startDate': '2016-01-01', 'endDate': '2016-02-01'}
r = requests.post(url='https://**your-full-implementation-url**/getDepositHistory', data=payload, headers=headers)
try:
    print(r.json())
except:
    print(r.status_code)
                
                    // The following PHP code will make a getDepositHistory call
// and prints the json response.

$endpoint = 'https://**your-full-implementation-url**/getDepositHistory';
$params = array('apiLogin'=>'AbC1234-9999', 'apiTransKey'=>'9845dk-39fdk3fj3-4483483478', 'transactionId'=>'45k-dk3fj3-44478', 'startDate'=>'2016-01-01', 'endDate'=>'2016-02-01');

$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $params);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('response-content-type: json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$result = curl_exec($curl);
curl_close($curl);
$json = new json_decode($result, true);
print_r($json);

                
                    // The following C# code will make a getDepositHistory call
// and print the json response.

using System;using System.IO;
using System.Net;
using System.Text;

byte[] data = Encoding.ASCII.GetBytes(
    "apiLogin=AbC1234-9999&apiTransKey=9845dk-39fdk3fj3-4483483478&transactionId=45k-dk3fj3-44478&startDate=2016-01-01&endDate=2016-02-01");
WebRequest request = WebRequest.Create("https://**your-full-implementation-url**/getDepositHistory");
request.Method = "POST"\;
request.ContentLength = data.Length;
request.Headers.Add("response-content-type", "json");
using (Stream stream = request.GetRequestStream())
{
    stream.Write(data, 0, data.Length);
}
string responseContent = null;
using (WebResponse response = request.GetResponse())
{
    using (Stream stream = response.GetResponseStream())
    {
        using (StreamReader sr = new StreamReader(stream))
        {
            responseContent = sr.ReadToEnd();
        }
    }
}
Console.WriteLine(responseContent);
                
                    # The following Ruby code will make a getDepositHistory call
# and print the json response.

require 'uri'
require 'net/http'

uri = URI("https://**your-full-implementation-url**/getDepositHistory")
https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['response-content-type'] = 'json'
request.body = {apiLogin: 'AbC1234-9999', apiTransKey: '9845dk-39fdk3fj3-4483483478', transactionId: '45k-dk3fj3-44478', startDate: '2016-01-01', endDate: '2016-02-01'}.to_json
response = https.request(request)
puts response