Use Remote Deposit Capture (API)
Learn how to use remote deposit capture (RDC) to convert paper checks received in-person into electronic payments via the API
Remote Deposit Capture (RDC) is a service that allows you to convert paper checks received in-person into electronic payments without physically depositing them at a bank. This guide explains how to implement RDC via the API.
RDC uses Back Office Conversion (BOC), which only supports consumer checks received in-person at a point-of-sale or staffed payment location. Some checks aren’t eligible, including mailed, drop box, business, cashier’s, government, and insurance checks. See Capturing in-person checks for full eligibility details.
The implementation process consists of two main API calls:
- Check image capture and OCR extraction
- Payment processing using the extracted check information
Before you begin, make sure you read Capturing in-person checks to understand the key concepts and requirements for Remote Deposit Capture (RDC).
Step 1: Process check images
First, send the check images to Payabli for processing using the /CheckCapture/CheckProcessing endpoint. You need to send the front and back images of the check in JPEG or PNG format, base64 encoded.
A successful response includes the extracted check information, including the OCR account and routing numbers, as well as the check amount.
If the check processing fails, the response includes error information to help you troubleshoot the issue. Some errors appear in the errors array of 200 response, and validation errors are returned as a 400 response.
Amount mismatches
The checkAmount you send must match the amount that OCR reads from the check. By default, the scan fails when the two amounts don’t match. The response has success set to false, amountDiscrepancyDetected set to true, and this error in the errors array: The amount on the check does not match the amount provided.
Your organization or paypoint can choose to accept these scans instead. When this setting is on, a scan with mismatched amounts succeeds. The response still has amountDiscrepancyDetected set to true, and the messages array includes a warning. The array can also include other warnings, such as a missing endorsement.
Payabli stores the check with the amount that you sent in checkAmount, so use that amount for totalAmount in step 2. Convert it from cents to dollars first. For example, a checkAmount of 120000 becomes a totalAmount of 1200.00. The merchant accepts liability for an incorrect amount, such as a return or adjustment. Show the warning to the merchant so they can verify the amount before they submit the payment. A scan where OCR can’t read the account or routing number still fails, even with this setting on.
Step 2: Process payment
After successfully processing the check images, use the extracted information to complete the payment transaction.
Send a POST request to /v2/MoneyIn/getpaid:
This request has some differences from the standard transaction, pay attention to the following fields:
A successful request returns a 201 response.
Implementation recommendations
When implementing RDC, consider the following recommendations, which can help create a smoother user experience and reduce errors.
Data validation
Before submitting to the API:
- Ensure check images are correctly encoded and within size limits
- Verify the check amount sent to
/CheckCapture/CheckProcessingis in cents (integer value), and the amount sent to/MoneyIn/getpaiduses dot (.) decimal notation - Check that the required parameters are correctly formatted
Error handling strategies
When implementing error handling, consider the following scenarios and strategies:
Testing recommendations
When testing your RDC implementation, consider the following scenarios:
- Image quality testing: Test with varied image qualities and lighting conditions.
- Error handling: Test with intentionally poor images and various check types to verify error handling.
- End-to-end flow: Test the complete flow from image capture to payment processing.
- Integration testing: Verify proper integration with your existing systems.
Related resources
See these related resources to help you get the most out of Payabli.
Prerequisites
- Capturing in-person checks - Learn how to use remote deposit capture (RDC) to convert paper checks into electronic payments