Scanned Check Payments

RAVEN Processing

Scanned check payments are used to submit scanned paper checks to RAVEN for processing. Depending on the country and clearing system the processing may be completely electronic or it may involve substantial manual processing (most currencies). The scanned check processing cycle is as follows:

  1. You send your Request file containing check requests with a payment type of
    “scanned_document” to RAVEN.
  2. RAVEN will attempt to process the file.
  3. If the file is rejected, RAVEN will produce a Reject response file.
  4. If the file is accepted, RAVEN will validate the requests, generate a Receipt file and queue the valid requests for processing.
  5. The first stage of processing is to convert the scanned document to the appropriate type for the country and currency specified.
  6. After conversion the items are queued for processing.
  7. When the batch is transmitted to the bank for processing, RAVEN will generate a Result file.
  8. RAVEN will receive notice of items returned as NSF or invalid. These will be reported as received in a Return file

Request fields

Each detail line in a file representing a scanned check payment specifies a check written on a customer’s bank account. Each payment detail line consists of field values separated by commas, in the same order and position as the field names in the Field names line. The column ‘Req/Rsp’ indicates if the field forms part of the request to RAVEN (Req)or part of the response from RAVEN (Rsp). Except as noted, RAVEN will echo all request fields in the response.

The supported fields are:

Field Names Type Max. Size Req/Rsp Remarks
PRN N 6 M The 6 digit payment routing number assigned to you.
ClearingCountry A 2 M On of the value 2 character ISO country codes.
Currency A 3 M One of the valid 3 character ISO country codes.
PymtType A 25 M scanned_document
Amount N 10 M Value supplied in base unit of currency, with no decimal. E.g. $150.00 is 15000.
BankNumber N 9 M 8 digit transit-ABA number followed by a check digit. As printed on the customer’s check.
AccountNumber N+(s, -) 17 M The number of the customer’s account that is to be debited.

Leading zeros should be preserved. The space characters do NOT count when calculating the field length and will be removed prior to processing the payment.

SerialNumber N 10 O Serial number as printed on the check. Leading zeros should be preserved. In the case of US items this must be extracted from the “on us” field.
HasBackImage A 25 M Must be true
MICRLine T 100 M The MIRC line as printed on the bottom of the check including punctuation, leading zeros and internal spaces.
OnUsNumber T 50 M The “on us” portion of the micr line including punctuation, leading zeros and internal spaces.
Auxiliary N 25 O Where applicable, must contain auxiliary “on us” field.
SequenceNumber N 10 M Sequence number of the item in the file.
TextKey N 2 O Where applicable, must contain the text key field.
Image See discussion below.
AccountName T 22 O The customer’s name exactly as the customer has supplied when setting up their bank account. This is mandatory for PPD.
Description T 16 O If present, this text may be displayed to the individual receiving the debit. It will not affect processing. Use the shortest possible value.
Reference T 30 O Information the merchant may supply at their discretion identifying the payment or customer. Will be echoed on reports.
Reference2 T 30 O Information the merchant may supply at their discretion identifying the payment or customer. Will be echoed on reports.
Reference3 T 30 O Information the merchant may supply at their discretion identifying the payment or customer. Will be echoed on reports.
Comment T 1000 O Information the merchant may supply at their discretion. Will be echoed on reports.

Image Data

Image data must be supplied for scanned documents. The line immediately following each payment line contains:

BinaryBlock,Image,16476:: <CR>
This is then followed by the specified number of bytes of binary image data. The image data must represent a TIFF document containing black and white CCIT Group 4 encoded data at 200 DPI.

The image data is then followed by <CR> after which the next payment line begins. Assuming the following file header:

RavenPaymentFile_v2.2,Controller:DigitalCheck,Version:6249PaymentRoutingNumber, PaymentStatusCode, ClearingCountryCode, CurrencyCode, BankNumber, CustomerAccountNumber, SerialNumber, Amount, PaymentType, HasBackImage, MICRLine, CustomerOnUsNumber, Auxiliary, CustomerAccountName, PaymentReference, TextKey, ErrorCode, Message, SequenceNumber

A complete scanned document looks as follows:

208116,valid,US,USD,000008002,16188981748,,4000,scanned_document,true,:000008002: 16188981748<,16188981748/,,,,,,,1 BinaryBlock,Image,16476::

<16476 bytes of b&w TIFF CCIT group 4 encoded binary data>

The image data is a single image consisting of the front of the document followed by the back of the document.

Response fields

Scanned checks are converted to EFT payments of the appropriate type. For example, in the case of USD documents either a US ACH or US IRD item will be generated. The result file generated will reflect those types.