Skip to main content

Rockend REST payment import file

This page 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.
Disclaimer

The information contained in this publication is provided for learning purposes only and is subject to change. Revisions may be issued from time to time that encompass changes or additions to this module.

This is a guide only and it is not comprehensive. It does not impinge on or overrule any formal arrangement you may enter into with the Bank. The Bank and its officers shall not have any liability for any losses of any kind incurred in connection with any action, inaction or decision taken in reliance on the information herein or for any inaccuracies, errors or omissions. In this publication references to the "Bank" are to Westpac Banking Corporation ABN 33 007 457 141 and to any of its operating Divisions, including BankSA and St.George.