The check object contains the data extracted from check images that have been deposited to a Helix account.

check Object

Property

Data Type (length)

Description

checkAmount

decimal

The amount for which the check was written.

checkImages

array

An array of checkImage objects.

checkNumber

long integer (64-bit 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.

holdCode

string

Hold Code representing a hold placed on check deposit funds.

holdCodeDescription

string

Hold Code description of a holdCode.

payerAccountNumberMasked

string

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

The name of the payer’s financial institution from where the check was drawn.

payerRoutingNumber

string

The routing number of the payer’s financial institution from where the check was drawn.

returnReason

string

Return reason description of a returnReasonCode. This field is present only on a returned check.

returnReasonCode

string

Return reason code representing a return or a reversal of a check.
This field is present only on a returned check.

checkImage Object

Property

Data type (length)

Description

downloadUrl

string

GET url with a file content response object (similar to /bankdocument/download).

imageType

enum

Image representing an original check or a replacement check image. Possible values:

  • CheckFront: Image representing front of the original check
  • CheckBack: Image representing back of the original check
  • ReturnCheckFront: Image representing front of the replacement check image
  • ReturnCheckBack: Image representing back of the replacement check image