A deposit is when you receive funds from <<company_name>>. You can retrieve individual deposits, as well as list all deposits. Deposits are made on varying schedules, depending on your payout schedule and industry.
If Processing through certain processors, you may query for a list of deposits by providing the year of the deposits and the status of the deposit as the final two path parameters /{year}/{status} - status defaults to a 3 - or filter the query using Query parameter values
Filter Parameters
The following filter parameters are available for this query.
| parameter | description |
|---|---|
start_date | Search for transactions beginning on a particular date. Format date as a mm/dd/yy string.
Default is the date for the first transaction in DB. By default the |
end_date | Search for transactions ending on a particular date. Format date as a mm/dd/yy string.
Default is the date for the most recent transaction in DB. By default the |
amount | Search for a specific amount. Format as a string with whole numbers and up to two decimals as necessary.
By default the |
amount_from | Search for a "from amount" to return all transactions equal to or greater than value entered. Format as a string with whole numbers and up to two decimals as necessary.
By default the |
amount_to | Search for a "to amount" to return all transactions equal to or less than the value entered. Format as a string with whole numbers and up to two decimals as necessary.
By default the |
limit | The number of results to return when viewing a page. See PAGING below for more details. |
skip | The number of results to skip before returning results. See PAGING below for more details. |
Paging
This endpoint provides query filter parameters allowing you to limit the number of results returned when fetching the deposit list.
limit- The number of results to return when viewing a page. For example, setting limit to 20 means that, at most, 20 results will be returned in the request.skip- The number of results to skip before returning results. For example, setting skip to 20 means that the API will discard the first 20 results.
By using these two parameters you can efficiently “page” through results, only returning items that are within the requested bounds.
To demonstrate, let’s use the parameters to display the first page of your deposit results:
`GET /deposits/{year}/{status}/?limit=20&skip=0`Since the offset is set to 0, the API will not discard any results. Paired with a limit of 20, we will only see the first 20 results (1 through 20).
`GET /deposits/{year}/{status}?limit=20&skip=20`By setting an offset of 20, the API will discard the first 20 results. Paired again with a limit of 20, we will see the second page of results (21 through 40).
The Maximum number of deposits returned per API call is 250. If you require more than 250 then you should use the limit and offset parameters above.