APIPay In endpointsTransaction utilities

Capture check (RDC)

Beta
View as MarkdownOpen in Claude

Captures a check for Remote Deposit Capture (RDC) using the provided check images and details. This endpoint handles the OCR extraction of check data including MICR, routing number, account number, and amount. See the RDC guide for more details.

Request

This endpoint expects an object.
entryPointstringRequired

The entity’s entrypoint identifier. Learn more.

frontImagestringRequired

Base64-encoded front check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check clearly with no partial, blurry, or illegible portions.

rearImagestringRequired

Base64-encoded rear check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check clearly with no partial, blurry, or illegible portions.

checkAmountintegerRequired

Check amount in cents (maximum 32-bit integer value).

Response

Success response with check processing results.
successboolean
Indicates whether the check processing was successful.
processDatestring

The date and time when the check was processed (ISO 8601 format).

amountDiscrepancyDetectedboolean

Flag indicating whether there’s a discrepancy between the provided amount and the OCR-detected amount.

endorsementDetectedboolean
Flag indicating whether an endorsement was detected on the check.
checkTypedouble

Identifier for the type of check. Personal = 1 Business = 2 Only personal checks are supported for check capture.

idstringOptional

Unique ID for the check capture, to be used with the /api/MoneyIn/getpaid endpoint.

ocrMicrstringOptional

The OCR-extracted MICR (Magnetic Ink Character Recognition) line from the check.

ocrMicrStatusstringOptional
Status of the MICR extraction process.
ocrMicrConfidencestringOptional

Confidence score for the MICR extraction (0 to 100).

ocrAccountNumberstringOptional
The bank account number extracted from the check.
ocrRoutingNumberstringOptional
The bank routing number extracted from the check.
ocrCheckNumberstringOptional
The check number extracted from the check.
ocrCheckTranCodestringOptional
The transaction code extracted from the check.
ocrAmountstringOptional
The amount extracted via OCR from the check.
ocrAmountStatusstringOptional
Status of the amount extraction process.
ocrAmountConfidencestringOptional

Confidence score for the amount extraction (0 to 100).

errorslist of stringsOptional
List of error messages that occurred during processing.
messageslist of stringsOptional
List of informational messages about the processing.
carLarMatchConfidencestringOptional

Confidence score for the match between Courtesy Amount Recognition (CAR) and Legal Amount Recognition (LAR).

carLarMatchStatusstringOptional

Status of the CAR/LAR match.

frontImagestringOptional

Processed front image of the check (Base64-encoded).

rearImagestringOptional

Processed rear image of the check (Base64-encoded).

referenceNumberstringOptional
Reference number for the transaction.
pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error