Custom Settings Configuration
Step 1: Configuration of the CheckForce API Custom Setting
Custom Settings
By generating and configuring the Payology Mobile Check Capture App's Custom Setting, the Salesforce Administrator can determine the messages displayed to users within the mobile check capture process, assign the license provided by Check21.com, enable debugging mode, select whether endorsement validation is required, and importantly enable amount and/or duplicate validation.
Generating a Custom Settings Record
To begin the generation process, the Salesforce Administrator must first navigate to the Custom Settings navigation item in Setup. To do so, please follow these steps:
- Click the Gear icon on the top right-hand corner of the window.
- Click "Setup".
- In the left-hand side input box type "Custom Setting".
- Click the navigation item labeled "Custom Settings".
- Find "CheckForce API Custom Settings".
- Click the "Manage" button to the left of the name.
- Click the "New" button.
Generating a Custom Settings Record
After being redirected to the new Custom Setting record, the Salesforce Administrator must provide the appropriate data points within the visible fields. Below is a grid describing the fields, recommendations, and requirements.
| Field Name | Description | Recommendations | Required |
|---|---|---|---|
| Name | Name of Custom Setting | "API" | Yes |
| Activate Check Creation | Used to activate check record creation within Payology Select or Payology Prime. | False | No |
| API Content | In future versions, additional authorization data points will be required. | Blank | No |
| API Key | In future versions, additional authorization data points will be required. | Blank | No |
| Check Endorsement Validation | Used to determine whether the rear check image has an endorsement. This function directly impacts performance of the check capture process. Unless the receiver and check payer are the same person or organization, this function should not be used. | False | No |
| Redirect Link | If using Community Cloud or Force.com components, this link will be utilized on completion of the check capture process, redirecting the user to the provided website. This field supports tokens (i.e. passing the Check Capture Submission record) | The Check21.com team recommends using these tokens within this link to capture the generated capture record ID. | If redirecting a user to an external site on check capture completion, this field is required. Otherwise, no. |
| MCC Duplication Validation | If enabled, all checks captured using the App will be analyzed to determine whether they have been captured previously. If so, the check capture status will change to "Duplicated". | The Check21.com team recommends enabling this function. | No |
| Expected Amount Validation | If enabled, the check amount entered by the user during the capture process will be compared to the amount provided within the "expected amount" field in the check capture record. The check capture status will change to "Expected Amount Does Not Match" if the two amounts do not match. | If underpayments or over-payments are not allowed, the Check21.com team recommends enabling this function. | No |
| Log Transaction | If enabled, the debugging process will be added to the check capture workflow. For each check image captured, a debug file will be generated and related to the capture record. | If developers or end-customers encounter issues in the check capture process, the Check21.com team recommends enabling this function temporarily. | No |
| Mobile License Number | Mobile or Scanner Endpoint license number provided by the Check21.com team. | License Number | Yes |
| Use Mobile License Number | If enabled, all check images captured will be submitted to the Mobile Endpoint. Otherwise, they will be submitted to the Scanner Endpoint. | The Check21.com team recommends enabling this function if capturing images through a mobile device. If using a flatbed scanner, please disable this function. | No |
| OCR License Number | OCR Endpoint license number provided by the Check21.com team. | License Number | If enabling Validate Endorsement function, this license number is required. Otherwise, it may be left blank. |
| Amount Validation Message | Error message displayed if user entered amount is not greater than "$0.00". | "Please enter an amount greater than $0.00." | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Missing Data Message | Error message displayed if user clicks "next" without capturing an image or entering an amount. | Please snap a photo of your check, enter the amount, and click next. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Front Image Submission Error Message | Error message displayed if front check image submitted fails to process correctly. | The check could not be processed, please retry. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Front Image Missing Message | Error message displayed if rear image of check is submitted prior to the front check image. | The front image of the check is required. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Processing Image Message | Error message displayed if rear image of check is submitted prior to the completion of the front check image processing. | Please wait while we process this check and try clicking next again. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Rear Image Missing Message | Error message is displayed if user entered amount is greater than $0.00, front check image has been processed successfully and user clicked "next" without capturing the rear check image. | The rear image of the check is required. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Record ID Insert Failed Message | Error message displayed if Check Capture Submission record failed to create in Salesforce. | An error has occurred. Please retry submitting your check or call customer support if you continue to encounter issues. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Invalid Account Failed Message | Error message is displayed if an Account ID was provided within the parameter of the URL but does not exist in Salesforce. | Account ID provided invalid. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Invalid Contact Failed Message | Error message is displayed if an Contact ID was provided within the parameter of the URL but does not exist in Salesforce. | Contact ID provided invalid. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Invalid User Failed Message | Error message is displayed if an User ID was provided within the parameter of the URL but does not exist in Salesforce. | User ID Provided invalid. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Home Page Message | Message shown within the first step of the Check Capture UI. | All payments submitted before 9PM EST will be settled the same business day. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Front Image Missing Message | Error message displayed if rear image of check is submitted prior to the front check image. | Please snap a photo of the front of the check before attempting to capture the rear image of the check. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Check Capture Resubmit Message | Error message displayed if check image capture process fails. | Unfortunately, we could not properly capture the check image. Please resubmit the check again. | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Duplicated Error Message | Error message displayed if user entered/confirmed check data matches previously captured data/records. | Duplicated check | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Incorrect Exp Amount Message | Error message displayed if user entered/confirmed amount does not match the expected amount (field on check capture submission record). | The typed amount is not the expected amount | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Upload Success Message | Text message will be shown to the user when the image is uploaded with success. | Upload with success! | If using the Community Cloud or the Force.com functions, this field is required. Otherwise, it may be left blank. |
| Payment Method Object | Out-of-Package Object/Record which will be created upon successful Check Capture Submission Record update. | If using Payology Prime PayPrimePayment_MethodC If using Payology Lite it is payliteCheckc | No |
| Payment Allocation Object | Out-of-Package Object/Record which will point to Allocations of the Check, it's not created automatically. | If using Payology Prime PayPrimePayment_Allocationc If using Payology Lite it is payliteCheck_Allocationc | No |
| Payment Check Submission ID | Out-of-Package Object/Record, it is the name of the field that will create a Relationship between Payology Mobile Check Capture and Check Object | This field need to be created manually and the API name need to be set here | No |
Next Steps
To continue the configuration process, Salesforce Administrators or Developers must understand the Redirect URL tokenization process (when not using Native Mobile Apps). For detailed information on the token usage, please see the next section, labeled Using Tokens in URL Parameters.
Updated 8 months ago