checkCapture

Process Check Capture

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.

post/CheckCapture/CheckProcessing

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/CheckCapture/CheckProcessing
  • Auth: HTTP bearer

Request body

entryPointstring required

The entity's entrypoint identifier. Learn more.

frontImagestring required

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

rearImagestring required

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

checkAmountinteger required

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

Response

Success response with check processing results.

idstring

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

successboolean required

Indicates whether the check processing was successful.

processDatestring required

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

ocrMicrstring

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

ocrMicrStatusstring

Status of the MICR extraction process.

ocrMicrConfidencestring

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

ocrAccountNumberstring

The bank account number extracted from the check.

ocrRoutingNumberstring

The bank routing number extracted from the check.

ocrCheckNumberstring

The check number extracted from the check.

ocrCheckTranCodestring

The transaction code extracted from the check.

ocrAmountstring

The amount extracted via OCR from the check.

ocrAmountStatusstring

Status of the amount extraction process.

ocrAmountConfidencestring

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

amountDiscrepancyDetectedboolean required

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

endorsementDetectedboolean required

Flag indicating whether an endorsement was detected on the check.

errorsstring[]

List of error messages that occurred during processing.

messagesstring[]

List of informational messages about the processing.

carLarMatchConfidencestring

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

carLarMatchStatusstring

Status of the CAR/LAR match.

frontImagestring

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

rearImagestring

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

checkTypenumber double required

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

referenceNumberstring

Reference number for the transaction.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

Changes

No recorded changes to this operation across all 1 revision of this API.