List Payments

Retrieve a list of payments from your account.

Parameters
Parameter Type Required Default Description
filters[account_id] Int No N/A Funding source id to filter payments by
filters[file_id] Int No N/A Only return payments uploaded from the file specified. File ID is listed in the Reports > Payment Files page.
filters[method_id] Int No N/A Method to filter payments by. method_id=1 is ACH, method_id=2 is Check
filters[status_id] Int No N/A Only return payments with the specified status. There is a full list of payment statuses under Resources > Payment Statuses in this documentation.
filters[postage_id] Int No N/A Only return payments with the specified postage id. There is a full list of postage ids under Resources > Postage
filters[payee_name] String No N/A Return payments where payee name matches provided string (with wildcard after)
filters[payee_name] String No N/A Return payments where payee name matches provided string (with wildcard after)
filters[payee_address] String No N/A Return payments where address matches provided string (with wildcard after)
filters[memo] String No N/A Return payments where memo matches provided string (with wildcard after)
filters[is_digital] Int (Boolean) No N/A 1 to only return digital payments (digital checks/ach), 0 to only match printed checks.
filters[by_date] String No N/A To filter by date, you specify the date field you want to filter by here as well as the date parameter (outlined next). The date field should be one of the following..
  • created_ts - date payment was created
  • updated_ts - date the payment was last updated
  • deleted_ts - date a payment was deleted
  • issue_ts - date a payment should be issued on (used when payments had an issue date set on them on add
  • sent_ts - date a payment was actually sent
  • cancelled_ts - date a payment was cancelled
  • returned_ts - date a payment was marked as returned
  • cleared_ts - date a payment was marked as posted/cashed
  • claimed_ts - date a digital check was claimed
filters[date] String or Array No N/A This can be passed as a string or an array, if it's an array then the payments are filtered by the daterange and the first item in the array is the beginning date, the second is the end date. If it's a single string passed it'll return all payments where the date field is that day.
Sample Response
{"status":0,"errors":[],"error_message":"","payments":{"1":{"id":"1","payee_id":null,"account_id":null,"client_invoice_id":null,"file_id":null, "batch_id":null,"status_id":"2","postage_id":null,"guid":"c4ca4238a0b923820dcc509a6f75849b","created_ts":"2019-09-22 05:46:05","updated_ts":null,"deleted_ts":null,"issue_ts":null, "sent_ts":null,"cancelled_ts":null,"returned_ts":null,"cleared_ts":null,"claimed_ts":null,"payee_name":"A Payee","payee_address":"123 Some St. City, ST 33434", "memo":null,"amount":"100.00","fees":"0.00","flagged":"0","confirmed":"1","claimed":"0","is_digital":"0","deleted":"0"}}}