v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Check Deposit

Create a Check Deposit

post/check_deposit

Request body

account_idstring required

ID of the Account receiving the deposit. Filterable.

amountstring required

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

back_image_file_idstring required

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

decisioned'true' | 'false'

Flag indicating the check was manually decisioned. Filterable.

front_image_file_idstring required

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

person_idstring required

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

statusstring

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

userdataobject

Arbitrary data the user can attach to the object

Response

The check_deposit created

account_idstring

ID of the Account receiving the deposit. Filterable.

amountstring

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

amount_discrepancy_detectedboolean

Flag indicating amount mismatch between amount and check image

back_image_file_idstring

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

decisioned'true' | 'false'

Flag indicating the check was manually decisioned. Filterable.

errorstring

Error message describing why a check was declined

front_image_file_idstring

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

idstring

Unique identifier for object

ocr_account_numberstring

Account number detected in check image

ocr_amountstring

Amount detected in check image

ocr_check_numberstring

Check number detected in check image

ocr_routing_numberstring

Routing number detected in check image

org_idstring

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

person_idstring

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_fullobject

Full response from RDC provider

review_informationobject[]

Additional context to support check reviews

risk_ratingstring

Risk rating assessment by RDC provider

risk_rating_descriptionstring

Human-readable risk rating

statusstring

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

userdataobject

Arbitrary data the user can attach to the object