Previous topic

Charges

Next topic

Transactions

This Page

Deposits

class fattmerchant.controllers.deposits.DepositsController(request)

Class to interface with deposits within the Fattmerchant API

list(options)

Gets a list of deposit batches within a certain date range from the API

Parameters:options (dict) –

A dictionary with any optional query params

Note

start_date or end_date is required

{
    "start_date": "1970-01-01",
    "end_date": "1970-01-01",
    "timezone": "EST",
    "timezoneOffset": 0
}
Returns:A list of deposit batch objects
Return type:Deposit Batch
Raises:InvalidRequestDataException – Raised if start_date is not provided or end_date is not provided
get(options)

Gets a list of deposit batch details within a certain date range from the API

Parameters:options (dict) –

A dictionary with any optional query params

Note

start_date or end_date is required

{
    "start_date": "1970-01-01",
    "end_date": "1970-01-01",
    "timezone": "EST",
    "timezoneOffset": 0
}
Returns:A list of deposit details objects
Return type:Deposit Details
Raises:InvalidRequestDataException – Raised if start_date is not provided or end_date is not provided