Payment processing

Payment processing

Pay your international and domestic beneficiaries via multiple payment channels, including multiple remittance layout and delivery options.

Supported payment channels:

  • AU/NZ Electronic Funds Transfer (EFT)
  • AU/NZ Cheque (including Bank and Corporate cheque types)
  • AU/NZ Overseas Telegraphic Transfer (OTT)
  • AU/NZ Automated Clearing House (ACH)
  • AU BPAY
  • AU Real Time Gross Settlement (RTGS)

You can control the processing of your files using one of our three authorisation modes:

  • No authorisation (straight through processing.)
  • Single authorisation (payment files must be authorised once before being scheduled for processing.)
  • Dual authorisation (payment files must be authorised twice before being scheduled for processing.)

Authorisation value limits can also be configured to ensure per transaction or per day limits are not exceeded by individual authorisers.

Payment notification can be delivered via remittance advice sent to your payment recipients in either email, fax or paper (mailed).

A full payment history is available via a web based portal including access to all reconciliation data in addition to any previously sent remittance advices.

File specifications

Australian payment import CSV

Send Australian domestic payments into PaymentsPlus and reconcile using the Australian domestic CSV response file.

New Zealand payment import CSV

Send New Zealand domestic payments into PaymentsPlus and reconcile using the International CSV response file.

Rockend REST payment import file

Send a Rockend REST supported payment file into PaymentsPlus and reconcile using the Rockend REST response CSV file.

Australian payment import CSV

Use this file specification to import Australian Domestic payments into PaymentsPlus.

The current version is 4. Upgrade to this version by following the Migration Notes for V2/V3.

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 7 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, BPAY, RTGS, Remittance Only, OTT or ACH.
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.
B BPAY Payment Record One per BPAY payment A BPAY payment may also contain a remittance record and zero or more invoice records.
RT Real Time Payment Record One per Real Time (RTGS) payment. A RTGS payment may also contain a remittance record and 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.
ACH Citibank Automated Clearing House Record One per Citibank Automated Clearing House (ACH) payment. An ACH payment may also contain a remittance record and zero or more invoice records.
R Remittance Record One record per payment. Must follow an E, C, B, RT, RO, OTT or ACH 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 Qvalent. This code uniquely identifies the client organisation within the PaymentsPlus platform.
3 Customer Name 1/40 Yes Alphanumeric Customer Name as provided by Qvalent (for human readable purposes only).
4 Customer File Reference 1/20 Yes Alphanumeric Customers reference for the file.
- 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).
5 Scheduled Date 8/8 Yes Date DDMMCCYY The date that the file is to be processed.
6 Currency 3/3 Yes AUD Must be AUD. 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, which must be positive and non-zero.
5 Recipient Reference (Lodgement Reference) 1/18 Yes Alphanumeric This will be the lodgement reference that appears on the payee's bank statement. It is recommended that this value be unique for each payment. Appears as Reference No: on standard remittances.
6 BSB Number 6/7 Yes BSB-BSB Bank State Branch number of the account to be credited.
7 Account Number 1/9 Yes Alphanumeric Account number of the account to be credited.
8 Account Name 1/32 Yes Alphanumeric Account name of the account to be credited.
9 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
10 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

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. Cheque numbers must be either all provided, or not provided at all. Appears as Cheque No:on standard remittances. It is recommended that this value be unique for each payment. Whether or not the customer will provide cheque numbers will be arranged during implementation.
6 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
7 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

B - BPAY Payment Record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes B 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 BPAY Biller Number 1/10 Yes Numeric BPAY Biller Number.
6 Recipient Reference (BPAY CRN) 1/20 Yes Numeric BPAY Customer Reference Number. Appears as CRN:on standard remittances.
7 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
8 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

RT - Real Time Payment Record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 2/2 Yes RT 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 Recipient Reference (Lodgement 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.
6 BSB Number 6/7 Yes BSB-BSB Bank State Branch number of the account to be credited.
7 Account Number 1/15 Yes Alphanumeric Account number of the account to be credited.
8 Account Name 1/35 Yes Alphanumeric Account name of the account to be credited.
9 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
10 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

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 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 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 AU (Australia) the Account Number must be prefixed with the BSB Number.
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/140 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 Must be AUDor USD. If blank defaults to the currency of the payer's funding account.
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. The Payment Amount must equal the Funding Amount * Exchange Rate. Only necessary when dealer rates are being utilised.
22 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
23 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

ACH - Citibank Automated Clearing House Record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 3/3 Yes ACH 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 Payment Currency 3/3 Yes ISO currency code Must be a standard ISO currency code. eg -AUD, NZD, USD
6 Recipient Reference 1/14 Yes Alphanumeric This reference will be included as part of the credit transaction data appearing on the payee bank statement. This reference may be truncated by the receiving bank. It is recommended that this value be unique for each payment. These references may be truncated by the receiving bank. Appears as Reference No: on standard remittances.
7 Routing Code 1/20 *No Alphanumeric The Routing Code is used to identify the bank in the foreign country. Typically only used for payments into United States and Canada. If no Routing Code is provided a BIC and IBAN must be provided instead.
8 Account Number 1/40 *No Alphanumeric Account number of the account to be credited. Typically only used for payments into United States and Canada. If no Routing Code is provided a BIC and IBAN must be provided instead.
9 Swift Code / BIC 8/11 *No Alphanumeric The Swift Code / Bank Identification Code (BIC) identifying the bank branch where the payee account is held. This field must be provided when there is no Routing Code or Account Number values.
10 IBAN 1/40 *No Alphanumeric An IBAN can be provided in lieu of a Routing Code and Account Number to specify the payee account details.
11 Payee Account Name 1/140 Yes Alphanumeric Account name of the account to be credited. This field must be provided when there is no Routing Code or Account Number values.
12 Payee Street 1 1/35 Yes Alphanumeric The Registered Address associated with the payee bank account.
13 Payee Street 2 1/35 No Alphanumeric The Registered Address associated with the payee bank account.
14 Payee Street 3 1/35 No Alphanumeric The Registered Address associated with the payee bank account.
15 Payee City 1/25 Yes Alphanumeric The City of the registered address associated with the payee bank account.
16 Payee State 1/3 No Alphanumeric The State of the registered address associated with the payee bank account.
17 Payee Post Code 1/9 No Alphanumeric The Post Code of the registered address associated with the payee bank account.
18 Payee Country 2/2 Yes Alpha The Country of the payment is being sent to. Payments can currently be sent via ACH to the following countries: AT, BE, CA, DE, DK, ES, FI, FR, GB, GR, HK, IE, IT, NL, PT, SG, UK, US.
19 Funding BSB Number 6/7 No BSB-BSB The Bank State Branch number for the funding account. Must be registered in PaymentsPlus prior to use.
20 Funding Account Number 1/9 No Alphanumeric The account number for the funding account. Must be registered in PaymentsPlus prior to use.

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 Email 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 sTotal number of payments in the payment file. This should add up to the count of all the E, C, B, RO, RT 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, B, RO, RT and OTT records in the file.

Sample file

H,TESTPAYER,TESTPAYER,TESTFILE001,26082016,AUD,4
E,,REF00001,36.04,REF00001,062-000,000002,Payee 02,032-000,000007
R,EMAIL,Payee 01,Addressee 01,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,test@test.com,1,1
I,1000000001,1000000001,26082016,01092016,36.04,36.04,Desc 1,0,Ded Desc 1
C,,REF00002,718.65,100008,032-000,000007
R,POST,Payee 02,Addressee 02,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,,1,1
I,2000000001,2000000001,26082016,01092016,359.32,359.32,Desc 2,0,Ded Desc 2
I,2000000002,2000000002,26082016,01092016,359.33,359.33,Desc 3,0,Ded Desc 3
B,,REF00003,191.57,401234,1234500012,032-000,000007
B,,REF00004,69.95,401234,1234500013,032-000,000007
RT,,REF00005,123.23,REF00005,062-000,000002,Payee 5,032-000,000007
R,EMAIL,Payee 05,Addressee 05,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,test@test.com,2,1
RO,,REF00006,REF00006,16.35
R,EMAIL,Payee 06,Addressee 06,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,test@test.com,2,1
OTT,,REF00007,759.63,USD,REF00007,WBC12345XXX,032000000026,,Payee 07,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,995.58,AUD,0123456789,0.7630,032-000,000007
R,EMAIL,Payee 07,Addressee 07,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,test@test.com,2,1
ACH,,REF00008,1439.46,CAD,REF00009,123456789,000000033,,,Payee 08,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,CA,032-000,000007
R,EMAIL,Payee 08,Addressee 08,Level 1,Wallsend Plaza,,Wallsend,NSW,2287,AU,,pp_dev1@qvalent.com,2,1
T,8,3354.88

Sample remittance layout

Sample Remittance Layout

Explaining IBAN's and routing codes

See IBAN's and routing codes.

Payment currencies

See Australian domestic payment currencies.

International data limitations

See International data limitations.

Migration notes for V2/V3 clients

Clients migrating from the V2/V3 file specification should take note of the following changes introduced by this V4 file specification.

H - File Header Record

  • Version field (7) should have a value of 4

E - EFT Payment Record

  • No significant changes.

C - Cheque Payment Record

  • No significant changes.

B - BPAY Payment Record

  • No significant changes.

RT - Real Time Payment Record

  • Recipient Reference (5) has been restricted to 16 chars.

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.

ACH - Citibank Automated Clearing House Record

  • Payer Payment Reference (3) has been restricted to 15 chars.

  • Recipient Reference (6) has been restricted to 14 chars.

  • Payee Account Name (11) has been restricted to 35 chars.

  • New mandatory field Payee Street 1 (12).

  • New field Payee Street 2 (13).

  • New field Payee Street 3 (14).

  • New mandatory field Payee City (15).

  • New field Payee State (16).

  • New field Payee Post Code (17).

  • Payee Country (18) was previously field 12.

  • Funding BSB Number (19) was previously field 13.

  • Funding Account Number (20) was previously field 14.

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.

New Zealand payment import CSV

Use this file specification to import New Zealand Domestic payments into PaymentsPlus.

The current version is 4. Upgrade to this version by following the Migration Notes for V1/V2/V3.

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 to be processed.
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, which must be positive and non-zero.
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 No DD The bank code for the funding account.
13 Funding Branch Code 4/4 No DDDD The branch code for the funding account.
14 Funding Account Number 1/7 No 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 No DD The bank code for the funding account.
7 Funding Branch Code 4/4 No DDDD The branch code for the funding account.
8 Funding Account Number 1/7 No 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.
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/140 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 No DD The bank code for the funding account.
23 Funding Branch Code 4/4 No DDDD The branch code for the funding account.
24 Funding Account Number 1/7 No 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 Email 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.

Explaining IBAN's and routing codes

See IBAN's and routing codes.

Payment currencies

See New Zealand domestic payment currencies.

International data limitations

See International data limitations.

Migration notes for v1/V2/V3 clients

Clients migrating from the V1/V2/V3 file specification should take note of the following changes introduced by this V4 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.

Rockend REST payment import file

This section provides a specification for the Rockend REST supported PPS payment file which can be used to import payments into the PaymentsPlus solution.

Record Types

The PPS payment file is a fixed width file consisting of several different line types and fields.

Type Description Comment
01 File Header Record One record per file. A header record will consist of one or more 02 records.
02 Payment Record One per payment (EFT, BPAY, Cheque or Remittance Only.) A payment record may consist of a single 03A record. A payment record may consist of one or more 03 records. A mandatory 03 record is required for all BPAY payments.
03A Additional Payment Data Record One per payment (payment record extension.) This is an optional record (agreed during implementation.)
03 Invoice Record One per invoice (or remittance line.) An invoice record typically represents invoice or remittance line detail data that is used in remittance generation. For BPAY payment the Biller Code and Customer Reference Number (CRN) must appear on this record.
099 Trailer Record One record per file. A trailer record contains file and record totals used for ensuring the validity of the file contents.
Important Notes:
  • The PPS payment file is a sequential file. The record size is a fixed block of 500 characters in length.
  • At the end of each record please ensure you include a carriage return.
  • Only characters from the ASCII character set should be included in the file. Non-ascii characters will cause the file to be flagged as invalid and as such the file will not be processed.
  • The alphanumeric field type (marked by 'x' under column heading 'Type') is left justified and blank filled in general unless stated otherwise.
  • The numeric field type (marked by '9' under column heading 'Type') is right justified and zero filled in general unless stated otherwise.

File Header Record

Field Field Name Position Size Format Required Notes
H1 Record identifier 01-02 2 9 Yes MUST BE 01
H2 Customer identifier 03-10 8 x Yes Must all be in upper case. This is a unique customer identifier to identify customer within PaymentsPlus. Allocated by Westpac at the start of the customer implementation.
H3 File date 11-16 6 9 Yes DDMMYY - must be a valid date, future dates are allowable.
H4 Creation Time 17-22 6 9 Yes HHMMSS - together with File Date above, used to detect duplicate files.
H5 Name of Remitter 23-38 16 x See Notes Mandatory for EFTs. Optional for Cheques.
H6 Payer Reference 39-48 10 x See Notes Mandatory for EFTs. Optional for Cheques. Will appear on Payer`s statement line 2.
H7 Header Filler 49-500 451 x N/A Reserved

Payment Record

Field Field Name Position Size Format Required Notes
C1 Record identifier 01-02 2 9 Yes Must be 02
C2 Reference/Creditor 03-17 15 x No A Unique reference/creditor number. For BPAY, the first 9 chars are an optional sequence number. First 9 chars appear in cheque audit error file sub-file3
C3 Amount 18-30 13 9 Yes Amount is to two decimal places with implied decimal point. Format is 9(11)v99. Maximum value of 99,999,999.99 applies.
C4 Currency 31-33 3 x Yes For AU customer, currency should be AUD
C5 Addressee Name 34-68 35 x Yes Addressee name will be used for the postal address. (This will also be used as a payee name on cheques and EFTs if no additional payee is specified in a 03A record, field D12).
C6 Payee Address 1 69-103 35 x See Notes Mandatory for Delivery Types: P, M and O. For email remittances, this is the recipient's Email address. An email address may overflow into Payee Address 2 and 3 allowing a maximum of 80 characters.
C7 Payee Address 2 104-138 35 x No An email address may overflow into Payee Address 2 and 3 allowing a maximum of 80 characters.
C8 Payee Address 3 139-173 35 x No An email address may overflow into Payee Address 3 (10 chars) allowing a maximum of 80 characters.
C9 Payee City 174-198 25 x See Notes Mandatory for Delivery Types: P, M and O.
C10 Payee Filler 1 199-200 2 x N/A Reserved (fill with spaces).
C11 Payee State 201-203 3 x See Notes Mandatory for Delivery Types: P,M and O.
C12 Payee Filler 2 204-208 5 x N/A Reserved (fill with spaces).
C13 Payee Postcode 209-217 9 x See Notes Mandatory for Delivery Types: P, M and O.
C14 Payment Type 218-218 1 x Yes Refer to Valid Payment/Remittance Types.
B - BPay
C - Cheque
D - Direct Entry (EFT)
R - Remittance Only
C15 Remittance Type 219-219 1 x Yes Refer to Valid Payment/Remittance Types.
P' - Print remittance
F - Fax remittance
N - No remittance
E - E-mail Remittance
C16 Delivery Type 220-220 1 x Yes Refer to Valid Payment/Remittance Types.
M - Multiple remittances to same payee printed and posted in one envelope.
N - No remittance.
O - Posted overseas.
P - Posted next day.
R - Returned to customer next day.
C17 Delivery Priority 221-221 1 x Yes 3 - Next Day Delivery
C18 Payee Bank/State Number 222-224 3 x See Notes Mandatory for EFTs.
C19 Hyphen 225 1 x See Notes Mandatory for EFTs. Set to hyphen (-).
C20 Payee Branch Number 226-228 3 x See Notes Mandatory for EFTs.
C21 Payee Account Number 229-237 9 x See Notes Mandatory for EFTs. Right justified, space filled.
C22 Payee Fax Number 238-252 15 x See Notes Mandatory for Remittance Type F. The fax number should contain the area code of the state you are calling, with no imbedded space, brackets, dashes or special characters.
C23 Statement Narrative 253-270 18 x See Notes Mandatory for EFTs. Optional for cheques Will appear on Payee statement.
C24 Remarks 271-305 35 x No Message to the Payee.
C25 Cheque Number 306-312 7 x See Notes Mandatory for cheques if customer chooses to allocate their own cheque numbers. Can be customer-allocated or Westpac-allocated (agreed during implementation.) Can be 6 or 7 digits (agreed during implementation.) Right justified and zero filled.
*C26 Remittance Layout Code 313-314 2 9 No Used when multiple remittance layouts have been specified.
*C27 Return To Address Indicator 315 1 9 No Used when multiple return to addresses have been specified. Maximum of 10 return to addresses possible.
*C28 Funding Bank/State Number 316-318 3 x See Notes Mandatory when using multiple "pay from" accounts.
*C29 Hyphen 319 1 x See Notes Mandatory when using multiple "pay from" accounts. Set to hyphen (-).
*C30 Funding Branch Number 320-322 3 x See Notes Mandatory when using multiple "pay from" accounts.
*C31 Funding Account Number 23-331 9 x See Notes Mandatory when using multiple "pay from" accounts. Right justified, space filled.
*C32 Payment Filler 332-500 169 x N/A Reserved
Note: Generally fields C26 to C32 are optional and as such these fields may be replaced with customised client data where necessary and agreed during implementation. Special processing instructions can be applied to this customised client data to enable functionality beyond what is normally considered a standard implementation. Additional costs may be associated with customised file processing / remittance delivery.

Additional Payment Data Record

This is an optional record that is used for handling customised client data, agreement to use this record must be negotiated with Westpac during implementation. Special processing instructions can be applied to this customised client data to enable functionality beyond what is normally considered a standard implementation. Additional costs may be associated with customised file processing / remittance delivery.

Field Field Name Position Size Format Required Notes
D1 Record Identifier 01-02 2 x Yes Must be 03
D2 Record Type 03-03 1 x Yes Must be A
D2a Stationery 04-04 1 x Yes G or S (agreed during implementation)
D2b Filler 05-12 8 x N/A Reserved (fill with spaces).
D3 Invoice date 13-18 6 9 N/A Reserved (fill with spaces).
D4 Invoice Amount 19-31 13 9 N/A Reserved (fill with zeroes).
D5 Sign for invoice amount 32-32 1 x N/A + or -
D6 Invoice amount paid 33-45 13 9 N/A Reserved (fill with zeroes).
D7 Sign for amount paid 46-46 1 x N/A + or -
D8 Filler 47-126 80 x N/A Reserved (fill with spaces).
D9 Deduction amount 127-139 13 9 N/A Reserved (fill with zeroes).
D10 Filler 140-219 80 x N/A Reserved (fill with spaces).
D11 Filler 220-229 10 9 N/A Reserved (fill with spaces).
D12 Payee Name 230-334 105 x Yes Name on Cheque, also used for EFTs.
D13 Filler 335-335 1 x N/A Reserved (fill with spaces).
*D14 Chq Payee Addr1 336-375 40 x No Printed on the Bottom of Cheque Remittance
*D15 Chq Payee Addr2 376-415 40 x No Printed on the Bottom of Cheque Remittance
*D16 Chq Payee Addr3 416-455 40 x No Printed on the Bottom of Cheque Remittance
*D17 Chq Payee Addr4 456-489 40 x No Printed on the Bottom of Cheque Remittance
*D18 Filler 490-500 11 x N/A Reserved (fill with spaces).
Note: Generally fields D14 to D18 are optional and as such these fields may be replaced with customised client data where necessary and agreed during implementation. Special processing instructions can be applied to this customised client data to enable functionality beyond what is normally considered a standard implementation. Additional costs may be associated with customised file processing / remittance delivery.

Invoice (or Remittance Line) Record

  • For EFT, CHEQUE and Remittance Only transactions, one or many Invoice records per Payment record are allowed.
  • For BPAY Batch transactions, exactly one "Invoice" record per Payment record is allowed.
Field Field Name Position Size Format Required Notes
I1 Record Identifier 01-02 2 9 Yes Must be 03
I2 Invoice number 03-12 10 x No
I3 Invoice date 13-18 6 9 No DDMMYY
I4 Invoice Amount 19-31 13 9 No Format is 9(11)V99.
I5 Sign for invoice amount 32-32 1 x No + or -
I6 Invoice amount paid 33-45 13 9 No Format is 9(11)V99.
I7 Sign for amount paid 46-46 1 x No + or -
I8 Invoice description 47-126 80 x No
I9 Deduction amount 127-139 13 9 No Format is 9(11)V99.
I10 Deduction description 140-219 80 x No Additional Information (agreed during implementation).
I11 Biller Number 220-229 10 9 See Notes Mandatory for BPAY where it is the BPAY Biller Code.
I12 Customer Reference Number 230-249 20 x See Notes Mandatory for BPAY where it is the BPAY CRN (usually a credit card number).
I13 Additional CRN 250-269 20 x N/A Reserved For BPAY, it is an additional BPAY CRN (optional).
I14 Service Code 270-276 7 x N/A Reserved For BPAY, it is a BPAY Service Code (optional).
I15 Invoice Filler 277-500 224 x N/A Reserved

Trailer Record

Field Field Name Position Size Format Required Notes
T1 Record Identifier 01-02 2 9 Yes Must be 99
T2 Number of payment records 03-07 5 9 Yes 99999 (total of all 02 records in file)
T3 Number of invoice records 08-12 5 9 Yes 99999 (total of all 03 records in file)
T4 Hash File Total 13-27 15 9 Yes Format is 9(13)V99. The total of Amount for all the payment entries. Maximum file total amount is $99,999,999.99
T5 Trailer Filler 28-500 473 x N/A Reserved

Valid payment/remittance types

Payment Type Remittance Type Delivery Type Delivery Priority Remarks
B E N 3 BPAY payment, Email remittance.
B F N 3 BPAY payment, Fax remittance.
B N N 3 BPAY payment, No remittance.
B P M 3 BPAY payment, Multiple remittances to same payee printed and posted in one envelope.
B P P 3 BPAY payment, Printed remittance, Posted next day.
B P R 3 BPAY payment, Printed remittance, Returned to customer next day.
C P M 3 Cheque payment, Multiple remittances to same payee printed and posted in one envelope.
C P O 3 Cheque payment, Printed remittance, Posted overseas.
C P P 3 Cheque payment, Printed remittance, Posted next day.
C P R 3 Cheque payment, Printed remittance, Returned to customer next day.
D E N 3 EFT payment, Email remittance.
D F N 3 EFT payment, Fax remittance.
D N N 3 EFT payment, No remittance.
D P M 3 EFT payment, Multiple remittances to same payee printed and posted in one envelope.
D P P 3 EFT payment, Printed remittance, Posted next day.
D P R 3 EFT payment, Printed remittance, Returned to customer next day.
R P P 3 Remittance only payment, Printed remittance, Posted next day.
R P R 3 Remittance only payment, Printed
R P M 3 Remittance only payment, Multiple remittances to same payee printed and posted in one envelope.
R P O 3 Remittance only payment, Printed remittance, Posted overseas.
R E N 3 Remittance only payment, Email remittance.
R F N 3 Remittance only payment, Fax remittance.

Australian domestic response CSV

This section provides a specification for the PaymentsPlus Australian Domestic CSV response file format. Use this file specification to reconcile Australian Domestic payments.

The current version is 1.

File format specification

The file format is a CSV (Comma Separated Value) file consisting of a single header row followed by a number of payment records.

A field may be encapsulated in quotes (") to ensure that formatting notation present in fields does not interrupt the file (e.g. if the field contains a comma).

A valid quote character (') in a field will be encoded as a double quote (").

A CSV remittance file will be produced for each input file provided into PaymentsPlus. Additional remittance files may be produced to update payments which have been subsequently declined by other financial institutions.

Field Field Name Format Description
1 Pay From Account Alphanumeric The payee account that payments were made from.
2 Your Bank Reference Alphanumeric The buyer bank reference that the payment was included in. Payments to recipients will be bulked debited per payment type against the buyer according to the payment file they were contained in.
3 Payment Type Alphanumeric The payment instrument of the payment. E.g. Cheque, Direct Entry or BPay.
4 Remittance Type Alphanumeric The remittance type of the payment. E.g. None, Email, Fax, Post.
5 Buyer Reference Alphanumeric A buyer provided reference to uniquely identify the payment.
6 Bank Ref/Cheq# Alphanumeric A recipient reference for the payment which will appear as the cheque number or lodgement reference for the recipient.
7 Success 0, 1 or blank A code to indicate the success or failure of the payment. 0 = failed 1 = successful Blank = response not yet received from external system
8 Status Code Alphanumeric A unique code identifying the status of the payment. Refer to Payments Status Codes page for further information.
9 Status Description Alphanumeric A description more elaborately describing the status of the payment.
10 Payment Date Date dd mmm yyyy The date that the payment was made.
11 Recipient Code Alphanumeric The payee/recipient name that the payment was made to.
12 Recipient Name Alphanumeric The payee/recipient name that the payment was made to.
13 Recipient Account Alphanumeric The account that the payment was made to.
14 Currency Alphanumeric The currency of the payment.
15 Amount Number N,NNN.NN The amount of the payment in dollars. E.g. 1.23 for one dollar and twenty three cents.
16 Addressee Name Alphanumeric The remittance addressee name.
17 Recipient Address 1 Alphanumeric The first address line.
18 Recipient Address 2 Alphanumeric The second address line.
19 Recipient Address 3 Alphanumeric The third address line.
20 Recipient City Alphanumeric The recipient city.
21 Recipient State Alphanumeric The recipient state.
22 Recipient Post Code Alphanumeric The recipient postal code.
23 Recipient Fax Number N The recipient fax number for the recipient.
24 Recipient Email Email The recipient email address.

Sample file

"Pay From Account","Your Bank Reference","Payment Type","Remittance Type","Buyer Reference","Bank Ref/Cheq#","Success","Status","Status Description","Payment Date","Recipient Code","Recipient Name","Recipient Account","Currency","Amount","Addressee Name","Recipient Address 1","Recipient Address 2","Recipient Address 3","Recipient City","Recipient State","Recipient Post Code","Recipient Fax","Recipient Email"
"032-000 000007","BATCH001","Direct Entry","None","PAYMENT001","PAYMENT001","1","Success","Approved or completed successfully","14 Nov 2011","","Example Customer","032-000 000015","AUD","1,000.00","Example Customer","Level 1","Wallsend Plaza","","Wallsend","NSW","2290","0249510055","example@example.com"

International response CSV

This section provides a specification for the PaymentsPlus International CSV response file format. Use this file specification to reconcile International payments.

The current version is 1.

File format specification

The file format is a CSV (Comma Separated Value) file consisting of a single header row followed by a number of payment records.

A field may be encapsulated in quotes (") to ensure that formatting notation present in fields does not interrupt the file (e.g. if the field contains a comma).

A valid quote character (') in a field will be encoded as a double quote (").

A CSV remittance file will be produced for each input file provided into PaymentsPlus. Additional remittance files may be produced to update payments which have been subsequently declined by other financial institutions.

Field Field Name Format Description
1 Pay From Account Alphanumeric The payee account that payments were made from.
2 Your Bank Reference Alphanumeric The buyer bank reference that the payment was included in. Payments to recipients will be bulked debited per payment type against the buyer according to the payment file they were contained in.
3 Payment Type Alphanumeric The payment instrument of the payment. E.g. Cheque, Direct Entry or BPay.
4 Remittance Type Alphanumeric The remittance type of the payment. E.g. None, Email, Fax, Post.
5 Buyer Reference Alphanumeric A buyer provided reference to uniquely identify the payment.
6 Bank Ref/Cheq# Alphanumeric A recipient reference for the payment which will appear as the cheque number or lodgement reference for the recipient.
7 Success 0, 1 or blank A code to indicate the success or failure of the payment. 0 = failed 1 = successful Blank = response not yet received from external system
8 Status Code Alphanumeric A unique code identifying the status of the payment. Refer to Payments Status Codes page for further information.
9 Status Description Alphanumeric A description more elaborately describing the status of the payment.
10 Payment Date Date dd mmm yyyy The date that the payment was made.
11 Recipient Code Alphanumeric The payee/recipient name that the payment was made to.
12 Recipient Name Alphanumeric The payee/recipient name that the payment was made to.
13 Recipient Account Alphanumeric The account that the payment was made to.
14 Currency Alphanumeric The currency of the payment.
15 Amount Number N,NNN.NN The amount of the payment in dollars. E.g. 1,234.45.
16 Addressee Name Alphanumeric The remittance addressee name.
17 Recipient Address 1 Alphanumeric The first address line.
18 Recipient Address 2 Alphanumeric The second address line.
19 Recipient Address 3 Alphanumeric The third address line.
20 Recipient City Alphanumeric The recipient city.
21 Recipient State Alphanumeric The recipient state.
22 Recipient Post Code Alphanumeric The recipient postal code.
23 Recipient Country Alphanumeric The recipient country name.
24 Recipient Fax Number N The recipient fax number for the recipient.
25 Recipient Email Email The recipient email address.
26 Funding Currency Alphanumeric The funding currency of the payment.
27 Funding Amount Number N,NNN.NN The funding amount of the payment in dollars. This is the amount provided by the customer and not the converted amount.
28 Exchange Rate Number NNN.NNNNN The currency exchange rate. This is the amount provided by the customer and not necessarily the rate used to exchange the currency.
29 Exchange Reference Alphanumeric The currency exchange dealer reference, if provided.

Sample File

Pay From Account,Your Bank Reference,Payment Type,Remittance Type,Buyer Reference,Bank Ref/Cheq#,Success,Status,Status Description,Payment Date,Recipient Code,Recipient Name,Recipient Account,Currency,Amount,Addressee Name,Recipient Address 1,Recipient Address 2,Recipient Address 3,Recipient City,Recipient State,Recipient Post Code,Recipient Country,Recipient Fax,Recipient Email,Funding Currency,Funding Amount,Exchange Rate,Exchange Reference
032-000 000007,BATCH001,Direct Entry,None,PAYMENT001,PAYMENT001,1,Success,Approved or completed successfully,14 Nov 2011,,Example Customer,032-000 00015,USD,"1,000.00",Example Customer,Level 1,Wallsend Plaza,,Wallsend,NSW,2290,Australia,0249510055,example@example.com,AUD,"1,000.00",1.0000,XCREF123

Rockend REST response CSV

This section provides a specification for the PaymentsPlus Rockend REST CSV remittance file format.

File format specification

The file format is a CSV (Comma Separated Value) file consisting of a single header row followed by a number of payment records.

A field may be encapsulated in quotes (") to ensure that formatting notation present in fields does not interrupt the file (e.g. if the field contains a comma).

A valid quote character (') in a field will be encoded as a double quote (").

A CSV remittance file will be produced for each input file provided into PaymentsPlus. Additional remittance files may be produced to update payments which have been subsequently declined by other financial institutions.

Field Field Name Format Description
1 Pay From Account Alphanumeric The payee account that payments were made from.
2 Your Bank Reference Alphanumeric The buyer bank reference that the payment was included in. Payments to recipients will be bulked debited per payment type against the buyer according to the payment file they were contained in.
3 Payment Type Alphanumeric The payment instrument of the payment. E.g. Cheque, Direct Entry or BPay.
4 Remittance Type Alphanumeric The remittance type of the payment. E.g. None, Email, Fax, Post.
5 Buyer Reference Alphanumeric A buyer provided reference to uniquely identify the payment.
6 Bank Ref/Cheq# Alphanumeric A recipient reference for the payment which will appear as the cheque number or lodgement reference for the recipient.
7 Status Code Alphanumeric A unique code identifying the status of the payment. Refer to Payments Status Codes page for further information.
8 Status Description Alphanumeric A description more elaborately describing the status of the payment.
9 Payment Date Date dd mmm yyyy The date that the payment was made.
10 Recipient Code Alphanumeric The payee/recipient name that the payment was made to.
11 Recipient Name Alphanumeric The payee/recipient name that the payment was made to.
12 Recipient Account Alphanumeric The account that the payment was made to.
13 Currency Alphanumeric The currency of the payment.
14 Amount Number N,NNN.NN The amount of the payment in dollars. E.g. 1,234.45.
15 Recipient Address 1 Alphanumeric The first address line.
16 Recipient Address 2 Alphanumeric The second address line.
17 Recipient City Alphanumeric The recipient city.
18 Recipient State Alphanumeric The recipient state.
19 Recipient Post Code Alphanumeric The recipient postal code.
20 Recipient Fax Number N The recipient fax number for the recipient.
21 Recipient Email Email The recipient email address.

Sample file

Pay From Account,Your Bank Reference,Payment Type,Remittance Type,Buyer Reference,Bank Ref/Cheq#,Status,Status Description,Payment Date,Recipient Code,Recipient Name,Recipient Account,Currency,Amount,Recipient Address 1,Recipient Address 2,Recipient City,Recipient State,Recipient Post Code,Recipient Fax,Recipient Email
032-000 000007,BATCH001,Direct Entry,None,PAYMENT001,PAYMENT001,Success,Approved or completed successfully,14 Nov 2011,,Example Customer,032-000 000015,AUD,"1,000.00",Level 1,Wallsend Plaza,Wallsend,NSW,2290,0249510055,example@example.com