New Zealand response CSV
This page provides a specification for the PaymentsPlus New Zealand CSV response file format. Use this file specification to reconcile New Zealand payments.
Version
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 | Customer File Reference 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 | Record Type The payment instrument of the payment. E.g. Cheque, Direct Entry or BPay. |
| 4 | Remittance Type | Alphanumeric | Remittance Delivery Type The remittance type of the payment. E.g. None, Email, Fax, Post. |
| 5 | Buyer Reference | Alphanumeric | Payer Payment Reference A buyer provided reference to uniquely identify the payment. |
| 6 | Bank Ref/Cheq# | Alphanumeric | Recipient Reference (Lodgement Reference) 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 | Payee Name 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 | 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"
"03 2002 0000007 00","TESTFILE001","NZ Direct Entry","None","PAYREF00001","ANALYSIS001","1","SUCCESS","Completed successfully","10 Dec 2025",,"Payee 01","03 2002 000008 12","NZD","10.10",,,,,,,,,