POST /check_deposits
endpoint. The API will process the deposit, update the associated account, and return the status of the deposit.
Required Fields
- Account ID: The unique identifier for the account where the check will be deposited.
- Device: Information on the device that captured the images
- Check Front Image: The image file of the front of the check.
- Check Back Image: The image file of the back of the check.
- Amount: The amount of the check deposit, with two decimal precision.
- Person ID: ID of the Person making the deposit.
Example Request
Example Response
Deposit Status Tracking
After submitting a check deposit, you can track its status using theGET /check_deposits/{deposit_id}
endpoint. This endpoint returns details about the deposit, including whether it has been processed, is still pending, or has been rejected.
Status Codes
- Pending Review Check has been initiated successfully through the TP API and is pending the response from CheckAlt
- Submitted Check has been submitted successfully through CheckAlt to be grouped onto the X9 file to the bank
-
Sent We keep all checks in
submitted
status and at the 5 business day mark, AM EST, check will be set toSent
- Approved The deposit has been successfully processed.
-
Error Check has either failed immediately from TP’s end or has been Rejected by CheckAlt
-
Common Errors
- Invalid Image Quality: The image does not meet the required resolution or clarity.
- Duplicate Check: The same check has already been submitted and processed.
- Invalid Account: The account ID provided does not exist or is incorrect.
-
Common Errors
- Returned Check has been returned by the Fed
- canceled_ocr Check has been cancelled
-
Declined Check could not be processed for collection by the bank
- NOTE: This status is only available at certain bank*