PATCH
/
check_deposit
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/check_deposit/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "submitted"
}'
{
  "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.

Path Parameters

id
string
required

Unique identifier for object

Body

application/json
The check_deposit to update
amount
string

Amount of money to transfer, with two decimal precision. This must match the amount stated on the check

status
string

One of submitted or error. Indicates the deposit's decisioned status in the check workflow. Filterable.

Response

200 - application/json
The check_deposit updated
account_id
string

ID of the Account receiving the deposit. Filterable.

amount
string

Amount of money to transfer, with two decimal precision. This must match the amount stated on the check

amount_discrepancy_detected
boolean

Flag indicating amount mismatch between amount and check image

back_image_file_id
string

ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images

decision_data
object

Context related to check decisioning

device
object

Information on the device that captured the images

error
string

Error message describing why a check was declined

front_image_file_id
string

ID of the .jpg file object representing an image of the back of the check. Currently we only accept JPG file format for images

id
string

Unique identifier for object

ocr_account_number
string

Account number detected in check image

ocr_amount
string

Amount detected in check image

ocr_check_number
string

Check number detected in check image

ocr_routing_number
string

Routing number detected in check image

org_id
string

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

person_id
string

ID of the Person making the deposit. This ID must be in the array of person_ids of the account receiving the deposit

rdc_provider_full
object

Full response from RDC provider

review_information
object[]

Additional context to support check reviews

risk_rating
string

Risk rating assessment by RDC provider

risk_rating_description
string

Human-readable risk rating

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.

userdata
object

Arbitrary data the user can attach to the object