New Zealand payment import CSV
Use this file specification to import New Zealand payments into PaymentsPlus.
St. George customers
This file format is not available to customers of St. George.Version
The current version is 4. Upgrade to this version by following the migration notes.
File format specification
The CSV payment import file is a comma separated values file consisting of several different records.
Each field is contained within quotes. Do this so that commas and special characters are interpreted correctly.
Data considerations
Refer to the following for important data considerations.
Record types
The structure of a CSV payment import file is:
- One header record
- One or more payment records
- Zero or more remittance records
- Zero or more invoice records
- One trailer record
There are 4 different payment record types and each payment record can be accompanied with additional remittance information.
| Record Type | Description | Comment |
|---|---|---|
H |
File Header Record | One record per file. A file will consist of a mixture of one or more payments via EFT, Cheque, Remittance Only or OTT. |
E |
EFT Payment Record | One per EFT payment. An EFT payment may also contain a remittance record and zero or more invoice records. |
C |
Cheque Payment Record | One per Cheque payment. A cheque payment must be followed by a remittance record which can then be followed by zero or more invoice records. |
RO |
Remittance Only Payment Record | One per Remittance Only payment. A Remittance Only payment must be followed by a remittance record which can then be followed by zero or more invoice records. |
OTT |
Overseas Telegraphic Transfer Record | One per Overseas Telegraphic Transfer (OTT) payment. An OTT payment may also contain a remittance record and zero or more invoice records. |
R |
Remittance Record | One record per payment. Must follow an EFT, Cheque, Remittance Only or OTT record. No remittance record is required if no remittance is being sent. Cheque and Remittance Only payments require a remittance record. |
RP |
Remittance Pass Through Record | Optional - one record per remittance. Must follow a remittance record. |
I |
Invoice Record | Zero or more per payment. Must follow a remittance record. If a remittance record exists for the payment, the remittance record must appear before the invoice records. |
IP |
Invoice Pass Through Record | Optional - one record per invoice. Must follow an invoice record. |
T |
File Trailer Record | One record per file |
H - File header record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | H |
Record Type |
| 2 | Customer Code | 1/10 | Yes | Alphanumeric | Customer Code as provided by Westpac. This code uniquely identifies the client organisation within the PaymentsPlus platform. |
| 3 | Customer Name | 1/40 | Yes | Alphanumeric | Customer Name as provided by Westpac (for human readable purposes only). - For cheques, EFTs, this reference will be included as part of the bulk debit transaction data appearing on the client bank statement. - This reference may be truncated (max cheque debit reference length = 10 chars, max EFT debit reference length = 18 chars). |
| 4 | Customer File Reference | 1/20 | Yes | Alphanumeric | Customers reference for the file. |
| 5 | Scheduled Date | 8/8 | Yes | Date DDMMCCYY | The date that the file is sent for processing. A file with a past date is automatically sent for processing upon being authorised, or immediately if file authorisation is not enabled. |
| 6 | Currency | 3/3 | Yes | NZD |
Must be NZD. For Overseas payments the currency is specified in the actual payment record |
| 7 | Version | 1/1 | Yes | 4 |
This field must be present with the value of 4. If it`s not included the payment file will be processed according to an older, incompatible, version of this specification and may cause unexpected behaviour. |
E - EFT Payment Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | E |
Record Type |
| 2 | Recipient Number | 1/20 | No | Alphanumeric | Must match an existing recipient record in PaymentsPlus. This is only available as part of a premium solution, unused unless agreed with Westpac during implementation. |
| 3 | Payer Payment Reference | 1/15 | No | Alphanumeric | Payers reference for the payment. - It is recommended that this value be unique for each payment. - Appears as Payer Ref: on standard remittances. |
| 4 | Payment Amount | 4/10 | Yes | Numeric with decimal point. DDDD.CC | Amount of the payment. Positive, non-zero, 9999999.99 maximum. |
| 5 | Payee Analysis | 1/12 | Yes | Alphanumeric | This will be the analysis reference that appears on the payee`s bank statement. - Some receiving institutions expect this to be numeric |
| 6 | Payee Particulars | 1/12 | No | Alphanumeric | This will be the particulars reference that appears on the payee`s bank statement. - It is recommended that this value be unique for each payment. |
| 7 | Bank Code | 2/2 | Yes | DD | Bank Code of the account to be credited. |
| 8 | Branch Code | 4/4 | Yes | DDDD | Branch Code of the account to be credited. |
| 9 | Account Number | 1/7 | Yes | DDDDDDD | Account number of the account to be credited. |
| 10 | Account Suffix | 2/2 | Yes | DD | Account Suffix of the account to be credited. |
| 11 | Account Name | 1/20 | Yes | Alphanumeric | Account name of the account to be credited. |
| 12 | Funding Bank Code | 2/2 | Yes | DD | The bank code for the funding account. |
| 13 | Funding Branch Code | 4/4 | Yes | DDDD | The branch code for the funding account. |
| 14 | Funding Account Number | 1/7 | Yes | DDDDDDD | The account number for the funding account. |
| 15 | Funding Account Suffix | 2/2 | No | DD | The account suffix for the funding account. |
C - Cheque Payment Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | C |
Record Type |
| 2 | Recipient Number | 1/20 | No | Alphanumeric | Must match an existing recipient record in PaymentsPlus. This is only available as part of a premium solution, unused unless agreed with Westpac during implementation. |
| 3 | Payer Payment Reference | 1/15 | No | Alphanumeric | Payers reference for the payment. - It is recommended that this value be unique for each payment. - Appears as Payer Ref: on standard remittances. |
| 4 | Payment Amount | 4/10 | Yes | Numeric with decimal point. DDDD.CC |
Amount of the payment, which must be positive and non-zero. |
| 5 | Recipient Reference (Cheque Number) | 1/7 | No | Numeric | The cheque number of the cheque to be issued. Customers can either provide their own cheque numbers or allow Westpac to generate these on their behalf. - Appears as Cheque No: on standard remittances. |
| 6 | Funding Bank Code | 2/2 | Yes | DD |
The bank code for the funding account. |
| 7 | Funding Branch Code | 4/4 | Yes | DDDD |
The branch code for the funding account. |
| 8 | Funding Account Number | 1/7 | Yes | DDDDDDD |
The account number for the funding account. |
| 9 | Funding Account Suffix | 2/2 | No | DD |
The account suffix for the funding account. |
RO - Remittance Only Payment Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 2/2 | Yes | RO |
Record Type |
| 2 | Recipient Number | 1/20 | No | Alphanumeric | Must match an existing recipient record in PaymentsPlus. This is only available as part of a premium solution, unused unless agreed with Westpac during implementation. |
| 3 | Payer Payment Reference | 1/15 | No | Alphanumeric | Payers reference for the payment. It is recommended that this value be unique for each payment. Appears as Payer Ref: on standard remittances. |
| 4 | Recipient Reference | 1/18 | No | Alphanumeric | Recipient reference for the payment. Appears as Reference No:on standard remittances. |
| 5 | Payment Amount | 4/10 | Yes | Numeric with decimal point. DDDD.CC |
Amount of the payment. |
OTT - Overseas Telegraphic Transfer Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 3/3 | Yes | OTT |
Record Type |
| 2 | Recipient Number | 1/20 | No | Alphanumeric | Must match an existing recipient record in PaymentsPlus. This is only available as part of a premium solution, unused unless agreed with Westpac during implementation. |
| 3 | Payer Payment Reference | 1/15 | No | Alphanumeric | Payers reference for the payment. - It is recommended that this value be unique for each payment. - Appears as Payer Ref: on standard remittances.- This reference will NOT be included as part of the debit transaction data appearing on the client bank statement. |
| 4 | Payment Amount | 4/11 | Yes | Numeric with decimal point. DDDD.CC |
Amount of the payment, which must be positive and non-zero. |
| 5 | Payment Currency | 3/3 | Yes | ISO currency code | Must be a standard ISO currency code. eg -AUD, NZD, USD |
| 6 | Recipient Reference | 1/16 | Yes | Alphanumeric | This reference will be included as part of the credit transaction data appearing on the payee bank statement as WBC PAYPLUS-<Reference>. <Reference> may be truncated by the receiving bank.- It is recommended that this value be unique for each payment. - Appears as Reference No: on standard remittances. |
| 7 | Payee Swift Code / BIC | 8/11 | Yes | Alphanumeric | The Swift Code / Bank Identification Code (BIC) identifying the bank branch where the payee account is held. |
| 8 | Payee Account Number / IBAN | 1/40 | Yes | Alphanumeric | Account number of the account to be credited. - For payments to EU (European) countries this should be a valid International Bank Account Number (IBAN). - For payments to New Zealand bank accounts the Account Number must be prefixed with the Bank + Branch codes. - For payments to Australian bank accounts the Account Number must be prefixed with the BSB code. |
| 9 | Intermediary Swift Code / BIC | 8/11 | No | Alphanumeric | The Swift Code / Bank Identification Code (BIC) identifying the bank branch for the intermediary bank which the payment must pass through. |
| 10 | Payee Account Name | 1/128 | Yes | Alphanumeric | Account name of the account to be credited. - This value may be truncated by the receiving bank. |
| 11 | Payee Street 1 | 1/35 | Yes | Alphanumeric | The Registered Address associated with the payee bank Account. |
| 12 | Payee Street 2 | 1/35 | No | Alphanumeric | The Registered Address associated with the payee bank Account. |
| 13 | Payee Street 3 | 1/35 | No | Alphanumeric | The Registered Address associated with the payee bank Account. |
| 14 | Payee City | 1/25 | Yes | Alphanumeric | The City of the registered address associated with the payee bank Account. |
| 15 | Payee State | 1/3 | No | Alphanumeric | The State of the registered address associated with the payee bank Account. |
| 16 | Payee Post Code | 1/9 | No | Alphanumeric | The Post Code of the registered address associated with the payee bank Account. |
| 17 | Payee Country | 2/2 | Yes | Alpha | The Country of the registered address associated with the payee bank Account. Two character country code. E.g. AU, NZ. |
| 18 | Funding Amount | 4/11 | No | Numeric with decimal point. DDDD.CC |
Funding Amount for the payment. - Only necessary when dealer rates are being utilised. |
| 19 | Funding Currency | 3/3 | No | ISO currency code | Funding Currency for the payment. - Only necessary when dealer rates are being utilised. |
| 20 | Dealer Reference | 1/16 | No | Alphanumeric | The reference for a pre-arranged dealer currency exchange rate. - Only necessary when dealer rates are being utilised. |
| 21 | Exchange Rate | 6/13 | No | Numeric with decimal point. D.CCCC |
A pre-arranged dealer currency exchange rate. - Only necessary when dealer rates are being utilised. - The Payment Amount must equal the Funding Amount * Exchange Rate. |
| 22 | Funding Bank Code | 2/2 | Yes | DD |
The bank code for the funding account. |
| 23 | Funding Branch Code | 4/4 | Yes | DDDD |
The branch code for the funding account. |
| 24 | Funding Account Number | 1/7 | Yes | DDDDDDD |
The account number for the funding account. |
| 25 | Funding Account Suffix | 2/2 | No | DD |
The account suffix for the funding account. |
| 26 | Foreign Currency Funding Account Identifier | 1/20 | No | Alphanumeric | The identifier for a foreign currency funding account. - Only necessary when dealer rates are being utilised. |
R - Remittance Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | R |
Record Type |
| 2 | Remittance Delivery Type | 3/11 | Yes | Alphanumeric | The delivery type for the remittance associated with this payment. Must be one of, - POST - remittance will be delivered to the payee via post.- POST_RETURN - remittance will be returned to the customer via post.- POST_OS - remittance will be delivered to the payee via international post.- POST_MULTI - remittances/cheques for the same address will the consolidated together in the same envelope and delivered to the payee via post.- FAX - remittance delivered via facsimile.- EMAIL - remittance delivered via email.- NONE - no remittance will be provided.If no remittance record is provided a remittance will not be delivered to the payee which is equivalent to providing a remittance record of type NONE. |
| 3 | Payee Name | 1/35 | Yes | Alphanumeric | Name of the payee. - An extended payee name length (100 chars) is possible under some circumstances upon request. |
| 4 | Addressee Name | 1/35 | No | Alphanumeric | Defaults to Payee Name. Displayed on remittances above the address line. |
| 5 | Street 1 | 1/35 | No | Alphanumeric | Required for POST, POST_OS and POST_MULTI remittance delivery type. |
| 6 | Street 2 | 1/35 | No | Alphanumeric | Address line 2 |
| 7 | Street 3 | 1/35 | No | Alphanumeric | Address line 3 |
| 8 | City | 1/40(25) | No | Alphanumeric | Required for POST, POST_OS and POST_MULTI remittance delivery type.- Printed remittances are limited to 25 chars. |
| 9 | State | 1/3 | No | Alphanumeric | Required for POST and POST_MULTI remittance delivery type. |
| 10 | Post Code | 1/9 | No | Alphanumeric | Required for POST and POST_MULTI remittance delivery type. |
| 11 | Country | 2/2 | No | Alpha | Two character country code. E.g. AU, NZ. |
| 12 | Fax | 1/15 | No | Alphanumeric | Required for FAX remittance delivery type. |
| 13 | 1/128 | No | Alphanumeric | Required for EMAIL remittance delivery type. |
|
| 14 | Remittance Layout Code | 1/2 | No | Numeric | Must be positive and greater than zero. The remittance layout codes will be agreed with Westpac during implementation. |
| 15 | Return To Address Identifier | 1/1 | No | Alphanumeric | An identifier representing a previously arranged return to postal address. Address details and identifier will be agreed with Westpac during implementation. |
RP - Remittance Pass through Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 2/2 | Yes | RP |
Record Type |
| 2 | Pass through Data | 1/120 | No | Alphanumeric | Pass through data specific to the client implementation (appears in PPS settlement file as 03A record position 381->500). |
I - Invoice Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | I |
Record Type |
| 2 | Payers Invoice Number | 1/20(10) | No | Alphanumeric | The payers reference for the invoice. Printed remittances are limited to 10 chars. Appears as Invoice Number on standard remittances. |
| 3 | Recipient Invoice Number | 1/20 | No | Alphanumeric | The recipients reference for the invoice. Available on printed remittances upon special request only (Additional CRN). Appears as Recipient Invoice Number on standard remittances. |
| 4 | Issued Date | 8/8 | No | Date DDMMCCYY |
The date the invoice was issued. Appears as Invoice Date on standard remittances. |
| 5 | Due Date | 8/8 | No | Date DDMMCCYY |
The date the invoice is due for payment. Appears as Due Date on standard remittances. Available on printed remittances only upon special request. |
| 6 | Invoice Amount | 4/10 | No | Numeric with decimal point. DDDD.CC |
The amount of the invoice. If the invoice is negative (a credit note) prefix with -. Appears as Invoice Amounton standard remittances. |
| 7 | Invoice Amount Paid | 4/10 | No | Numeric with decimal point. DDDD.CC |
The paid amount of the invoice. Appears as Amount Paid on standard remittances. |
| 8 | Invoice Description | 1/80 | No | Alphanumeric | Invoice Description. Appears as Invoice Description on standard remittances. |
| 9 | Deduction Amount | 4/10 | No | Numeric with decimal point. DDDD.CC |
The amount of the deduction/discount. Appears as Deduction Amount on standard remittances. |
| 10 | Deduction Description | 1/80 | No | Alphanumeric | Description of the deduction/discount. Appears as Deduction Description on standard remittances. |
IP - Invoice Pass through Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 2/2 | Yes | IP |
Record Type |
| 2 | Pass through Data | 1/120 | No | Alphanumeric | Pass through data specific to the client implementation (appears in PPS settlement file as 03 record position 381->500). |
T - Trailer Record
| Field Number | Field Name | Min/Max Length | Required | Format | Description |
|---|---|---|---|---|---|
| 1 | Record Type | 1/1 | Yes | T |
Record Type |
| 2 | Total Payment Count | 1/10 | Yes | Numeric NNN |
Total number of payments in the payment file. This should add up to the count of all the E, C, RO and OTT records in the file. |
| 3 | Total Payment Amount | 1/15 | Yes | Numeric DDDDDD.CC |
Total amount of payments in the payment file. This must add up to the sum of all Payment Amount fields on each of the E, C, RO and OTT records in the file. |
New Zealand payment import CSV migration notes.
Clients migrating from the v1/v2/v3 file specification should take note of the following changes introduced by v4 of the New Zealand payment import CSV file specification.
H - File Header Record
Version field (7) should have a value of 4
E - EFT Payment Record
- Account Name (12) has been restricted to 20 chars.
- Payee Reference (5) has been restricted to 12 chars.
- New field Payee Analysis (6).
- New field Payee Particulars (7).
- Bank Code (8) was previously field 6.
- Branch Code (9) was previously field 7.
- Account Number (10) was previously field 8.
- Account Suffix (11) was previously field 9.
- Account Name (12) was previously field 10.
- Funding Bank Code (13) was previously field 11.
- Funding Branch Code (14) was previously field 12.
- Funding Account Number (15) was previously field 13.
- Funding Account Suffix (16) was previously field 14.
C - Cheque Payment Record
- New field Funding Bank Code (6)
- New field Funding Branch Code (7)
- New field Funding Account Number (8)
- New field Funding Account Suffix (9)
RO - Remittance Only Payment Record
No significant changes.
OTT - Overseas Telegraphic Transfer Record
- Payer Payment Reference (3) has been restricted to 15 chars.
- Recipient Reference (6) has been restricted to 16 chars.
- Payee Account Name (10) has been restricted to 35 chars.
- Payee Street 1 (11) has been restricted to 35 chars.
- Payee Street 2 (12) has been restricted to 35 chars.
- Payee Street 3 (13) has been restricted to 35 chars.
- Payee City (14) has been restricted to 25 chars.
- Payee State (15) has been restricted to 3 chars.
- Payee Postcode has been restricted to 9 chars.
- Dealer Reference (20) was previously field 22.
- Exchange Rate (21) was previously field 23.
- Funding BSB Number (22) was previously field 20.
- Funding Account Number (23) was previously field 21.
R - Remittance Record
- Payee Name (3) has been restricted to 35 chars.
- Addressee Name (4) has been restricted to 35 chars.
- Street 1 (5) has been restricted to 35 chars.
- Street 2 (6) has been restricted to 35 chars.
- Street 3 (7) has been restricted to 35 chars.
- State (9) has been restricted to 3 chars.
- Post Code (10) has been restricted to 9 chars.
- Fax (12) has been restricted to 15 chars.
RP - Remittance Pass through Record
No significant changes.
I - Invoice Record
- New field Invoice Amount Paid (7).
- Invoice Description (8) was previously field 7.
- Deduction Amount (9) was previously field 8.
- Deduction Description (10) was previously field 9.
IP - Invoice Pass through Record
No significant changes.
T - Trailer Record
No significant changes.