Shows list of your merchant's deposits filtered by the batched_at date by default
Results may be filtered by specifying a date range; for example, to filter by a date range, query /deposit?page=1&startDate=2025-01-01&endDate=2025-01-02 to search between January 1st, 2025 and January 2nd, 2025. You may also want to specify a timezone since Stax defaults to UTC time if no timezone is specified. Stax supports US time zones. (Possible values: 'HST' | 'HDT' | 'AKST' | 'AKDT' | 'PDT' | 'PST' | 'MST' | 'MDT' | 'CST' | 'CDT' | 'EST' | 'EDT' | 'UTC)
If a non-US time zone is needed, it is recommended to use the timeZoneOffset parameter to designate a numeric offset value from UTC (-4, 1, etc.). If a timezone is specified, the resulting timestamp data, such as the batched_at date will also be in the given timezone.
Testing: While you are developing in a sandbox account, you can take advantage of our "Simulate Settlement" feature to populate deposit information in your account. Any transactions which have been made on the test account can be mock settled, which will give you instant access to deposit information which would typically only be available at least 1 day after the related transaction was made. To use this feature, visit your sandbox account in Stax, go to Reports->Deposit Report, and click the "Simulate Settlements" button. When using this Simulate Settlements feature, the transaction_id in the deposit detail may appear null for a few minutes, but then should populate with the appropriate value when there should be an associated transaction_id. In production, you should not expect this value to show as null.
Production: In production settled transactions get added to the deposit reporting and will sync into Stax starting at 6pm UTC.
