Check
The check object contains the data extracted from check images that have been deposited to a CorePro account.
check Object
The check object contains the data extracted from check images that have been deposited to a CorePro account.
details
Property | Data Type (length) |
Description |
---|---|---|
checkNumber |
integer | The number of the check written. It is the last group of numbers in the MICR line and will match the numbers in the top right corner of the check. |
checkAmount |
decimal | The amount for which the check was written. |
checkImages |
list of checkImage objects |
|
payerAccountNumberMasked |
string (25) | Payer Account Number Masked with a first character as x followed by the last 4 digits of the account number (i.e., x1234) |
payerInstitutionDescription |
string (50) | The name of the payer’s financial institution from where the check was drawn. |
payerRoutingNumber |
string (10) | The routing number of the payer’s financial institution from where the check was drawn. |
returnReasonCode |
string (10) | Return reason code representing a return or a reversal of a check. This field is present only on a returned check. |
returnReason |
string (100) | Return reason description of a returnReasonCode . This field is present only on a returned check. |
holdCode |
string (10) | Hold Code representing a hold placed on check deposit funds. |
holdCodeDescription |
string (50) | Hold Code description of a holdCode . |
checkImage Object
Represents the check image data needed for retrieval of the check image.
details
Property | Data Type (length) |
Description |
---|---|---|
downloadUrl |
string | GET url with a response object of fileContent similar to /bankdocument/download |
imageType |
string |
Image representing an original check or a replacement check image
|