Card Issue Payments
Card issue requests are used to trigger the manufacturing and shipping of payment cards. The cards can be shipped in bulk or mailed out individually, depending on the arrangement that has been made.
Request and Response Fields
The fields supported for Card Issue payments are described in the following table. 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 column O/C/M indicates if a field is optional, conditional or mandatory.
| Field Names | Type | Max. Size | Req/Rsp | O/C/M | Remarks |
|---|---|---|---|---|---|
| PRN | N | 6 | Req | M | The 6-digit payment routing number assigned to you. |
| PymtType | T | 25 | Req | M | The type of payment to be issued. For outbound card payments, the PaymentType will always be: chq_issue_credit. |
| Honorific | T | 4 | Req | M | One of: Mr, Mrs or Miss |
| FirstName | T | 50 | Req | M | Cardholder’s first name. |
| FamilyName | T | 50 | Req | M | Cadholder’s family name. |
| Amount | N | 10 | Req | M | Amount, in the currency of card. Value supplied in base unit of currency, with no decimal. E.g. $150.00 is 15000. If the optional AccountAmount field is supplied, then the Amount field must be zero. In this case, the Amount will be returned in the result file. |
| Currency | A | 3 | Req | M | The three-character ISO currency code (e.g. USD, EUR, GBP) the card will be valued in. |
| AccountAmount | N | 10 | Req | O | Amount in the currency of the account associated with the payment routing number. The value of the check will be determined when the check is printed, based on the exchange rate in effect at that time. If this value is present and is NOT zero, then the amount field must be zero. Value is supplied in base unit of currency, with no decimal. E.g. $150.00 is 15000 |
| Description | T | 60 | Req | O | Memo or Payment Reference to be printed on the check. If this field is not identified in Field Names line, then the value will default to “Promotion Name”. If this field is present, but empty, then no value will be printed. |
| Reference | T | 30 | Req | O | Information the merchant may supply at their discretion identifying the payment or beneficiary. Will be echoed on reports. Will not be printed on the check. May be used to support the mail merge service. In the case of batch files this field is recommended but optional, in all other cases (RAPI, Virtual Terminal) this field is mandatory and must be unique in the file. |
| Reference2-4 | T | 100 | Req | O | Three additional reference fields, containing information the merchant may supply at their discretion identifying the payment or customer. Will be not echoed on reports. Will not be printed on check. May be used to support the mail merge service. |
| Address Information | |||||
| AddressLine1-4 | T | 60 each | Req | M | Address lines of the beneficiary. Up to four may be supplied. If present, these will be printed on the mail merge letter in a location suitable for insertion into a window envelope.
NOTE: At least one address line is mandatory for fulfilment. |
| City | T | 50 | Req | M | City the check will be mailed to.
NOTE: This field is mandatory for fulfillment. |
| ProvState | T | 50 | Req | M | The Province, Department, Canton or State the check will be mailed to.
NOTE: Where applicable, this field is mandatory for fulfillment. |
| PostalCode | T | 10 | Req | M | The postal or zip code the check will be mailed to.
NOTE: Where applicable, this field is mandatory for fulfillment. |
| CustomerCountry | A | 2 | Req | O | The two-character ISO country code (e.g. US, GB) used to verify the country the check will be mailed to.
NOTE: This field is mandatory for all checks issued. |
| PhoneNumber | N+(-) | 30 | Req | M | Cardholder’s phone number. |
| BirthDate | N+(-) | 10 | Req | M | Cardholder’s date of birth for identity check. Must be in YYYY-MM-DD format. |
| BirthCity | T | 50 | Req | M | Cardholder identity check. |
| T | 100 | Req | M | Cardholder’s email. | |
| Password | T | 20 | Req | O | Used for activation where required. Must be at least 6 characters in length. |
| PasswordHint | T | 50 | Req | O | Hint for the password. For example: “Mother’s maiden name”. |
| AccountName | T | 25 | Req | O | The name printed on the card. Use under advisement, only applicable to some services. |
| ReturnAddressLine1-5 | T | 60 each | Req | O | Your return address lines. Up to five may be supplied. If present, the return address is available to be printed on the mail merge letter. If not present, the return address will default to the mailing address held on file for your company.
NOTE: If the ReturnAddressLine1 is null, RAVEN assumes the rest of the return address lines are null and defaults to the mailing address held on file for your company. |
| ShipmentMethod | A | 25 | Req | O | If present, the check will be fulfilled using the method specified. The default fulfilment method is post. The possible choices are:
|
| Comment | T | 1000 | Req | O | Information the merchant may supply at their discretion. Will be echoed on reports. Will not be printed on cheques. Can be used as a merge field for the mail merge letter template. |
| SerialNumber | N | 15 | Serial number of the card. This is not the “Card Number” from the front of the card, but rather an internal number that is used to identify the card. It can be used to identify the card without disclosing the “Card Number”. | ||
| Status | T | 50 | Rsp | M | One of the following status codes.
|
| TrackingNumber | N | 9 | Rsp | M | RAVEN will return a unique tracking number for each payment processed. |
| ChequeNumber | N | 13 | Rsp | C | If successfully printed, this will be the serial number of the check. |
| EffectiveDate | N | 8 | Rsp | C | If successfully printed, this will be the date printed on the check in DDMMYYYY format. |
| ShipmentTrackingNumber | AN | 100 | Rsp | C | If a check has been requested with a ShipmentMethod of courier, this field will contain the courier company’s tracking number; otherwise, it will be empty. |
| FormattedAmount | N | 15 | Rsp | M | Decimal formatted amount of item. |
| TicketExchangeRate | N | 10 | Rsp | M | Exchange rate for the account the funds will be drawn on. |
| FormattedTicketAmount | N | 15 | Rsp | M | Amount to be withdrawn. |
| TicketCurrency | A | 3 | Rsp | M | ISO currency code of account from which funds will be drawn. |
Card issue requests are used to trigger the manufacturing and shipping of payment cards. Manufactured cards can be shipped in bulk or individually mailed out depending on the arrangement that has been made.