Skip to Navigation | Skip to Content


Introduction to Payments

RAVEN is a processing engine capable of accepting a wide range of payment types for processing. For example, card transactions, electronic transfers in multiple countries using a variety of clearing systems, requests to have paper checks issued, incoming bank transfers and even scanned paper checks for electronic deposit. However, no matter how payments are submitted or what type they are, the best way to think of RAVEN payments is as field-value pairs. For example, the simplest possible card payment consists of the following field-value pairs:

PRN - 840033
PymtType - cc_debit
CardNumber -4000000000000010
Expiry - 0933
Currency - CAD
Amount - 3340

Similarly, responses from RAVEN are best thought of as field-value pairs. Responses will typically echo the original request, and add additional values as appropriate. If the above example was successfully processed RAVEN would return the following field-value pairs as a response. TrackingNumber, ApprovalCode and Status represent the result of processing.

PRN - 840033
PymtType - cc_debit
CardNumber - 400000*******0010
Expiry -
Currency - CAD
Amount - 3340
TrackingNumber - 5123534
ApprovalCode - 40887
Status - Approved

When a payment is submitted to RAVEN the field-value pairs are encoded in a form suitable to the submission mechanism.  For example, the simple card payment discussed above can be represented as a line in a batch file to be uploaded to RAVEN:

RavenPaymentFile_v2.2
PRN, PymtType, CardNumber, Expiry, Currency, Amount
840033, cc_debit,4000000000000010, 0933, CAD, 3340
RavenFooter, 1, 3340

Or as a URL encoded string forming the body of  an HTTPS POST to the RAVEN API:

Amount=5493&PymtType=cc_debit&PRN=840033&Expiry=0933&Currency=CAD&CardNumber=4000000000000010

Each type of payment supported by RAVEN has its own section, such as “Card Payments” or “EFT Payments”. These sections outline the rules for processing each type of payment and include tables showing which values need to be included in the payment request and which values will appear in the response.