GET
/
check_deposit
List Check Deposits
curl --request GET \
  --url https://api.treasuryprime.com/check_deposit \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "account_id": "acct_1234567890",
      "amount": "100.00",
      "amount_discrepancy_detected": false,
      "back_image_file_id": "file_0987654321",
      "created_at": "2017-11-02T11:55:14Z",
      "decision_data": {},
      "device": {
        "os_name": "ios",
        "os_version": "12"
      },
      "error": null,
      "front_image_file_id": "file_1234567890",
      "id": "chk_1029384756",
      "ocr_account_number": "1234567890",
      "ocr_amount": "100.00",
      "ocr_check_number": "5250",
      "ocr_routing_number": "021001208",
      "org_id": "org_1gwmpv3payf",
      "person_id": "owner_1234567890",
      "rdc_provider_full": {},
      "review_information": [],
      "risk_rating": "Accept",
      "risk_rating_description": "Risk rating assessment by RDC provider",
      "status": "submitted",
      "updated_at": "2017-11-02T11:56:31Z",
      "userdata": null
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
account_id
string

ID of the Account receiving the deposit. Filterable.

​
decisioned
enum<string>

Flag indicating the check was manually decisioned. Filterable.

Available options:
true,
false
​
org_id
string

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

​
status
string

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

​
page_cursor
string

Pagination cursor, value is the object ID.

​
page_size
integer
default:100

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

Required range: x >= 1
​
from_date
string

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

​
to_date
string

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

Response

200 - application/json

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.

The response is of type object.