v1

latestOpenAPI 3.1.02026-07-261520561.4 KB

Check Deposit

List Check Deposits

get/check_deposit

Query parameters

account_idstring

ID of the Account receiving the deposit. Filterable.

decisioned'true' | 'false'

Flag indicating the check was manually decisioned. Filterable.

org_idstring

ID of the organization with which the object is associated. Filterable.

statusstring

One of pending, pending_review, submitted, sent, error, canceled_OCR, or returned. Indicates the deposit's current status in the check workflow. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size check_deposit elements, starting after the check_deposit described by page_cursor. If no more check_deposits are available, the resulting list will be empty.