API referencePay In endpointsTransaction utilities

Capture check (RDC)

Beta

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.

Headers

requestTokenstringRequired

Request

This endpoint expects an object.
entryPointstringRequired

The paypoint’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.

idstring or null

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

ocrMicrstring or null

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

ocrMicrStatusstring or null
Status of the MICR extraction process.
ocrMicrConfidencestring or null

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

ocrAccountNumberstring or null
The bank account number extracted from the check.
ocrRoutingNumberstring or null
The bank routing number extracted from the check.
ocrCheckNumberstring or null
The check number extracted from the check.
ocrCheckTranCodestring or null
The transaction code extracted from the check.
ocrAmountstring or null
The amount extracted via OCR from the check.
ocrAmountStatusstring or null
Status of the amount extraction process.
ocrAmountConfidencestring or null

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

errorslist of strings or null
List of error messages that occurred during processing.
messageslist of strings or null
List of informational messages about the processing.
carLarMatchConfidencestring or null

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

carLarMatchStatusstring or null

Status of the CAR/LAR match.

frontImagestring or null

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

rearImagestring or null

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

referenceNumberstring or null
Reference number for the transaction.
pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.

Errors