Skip to main content

CSV PayTo Agreements report

The CSV PayTo Agreements report lists PayTo Agreements in your facility. Download the report from QuickStream using the REST API or the PayTo Agreements page when you are signed in.

Report format

The report is plain text using UTF-8 character encoding. All records except the last are separated by the CR LF end-of-line marker. Fields may be enclosed in double quotes. If double quotes enclose a field, then a double quote appearing inside a field is escaped by preceding it with another double quote.

There are two types of rows in the transaction export:

  1. Header row
  2. Detail row

The header row is the first row in the file. It contains the column headings. For example:

Payee Reference,Agreement Token,Agreement Status

The header row is then followed by many detail rows. A detail row represents a single PayTo Agreement. For example:

YOUR_REFERENCE,C09805698824154,ACTIVE

Handling additional columns

From time to time additional columns may be added to the format. Your software must be written to handle these types of changes.

Check the change log for when new columns are added to the report.

CSV report version 1

Column Value Description
A Payee Reference Your reference for this PayTo Agreement.
B Agreement Token A unique identifier for the PayTo Agreement which can be used for Payments.
C Agreement Status The status of the PayTo Agreement. See PayTo Agreement Status.
D Customer ID QuickStream's unique identifier for the customer. This customer is created automatically when using the Create endpoint or from your server when using Create Customer and then Create for Customer. See Customers API for more.
E Customer Number Your unique reference for the customer.
F Supplier Business Code The code that uniquely identifies your business and that references your Payee account details.
G Respond By Time The date and time a Payer should approve or decline the PayTo Agreement.
H Purpose The reason for the PayTo Agreement.
I Description Describes what the PayTo Agreement was established for.
J Start Date The starting date from which Payments may be initiated against the PayTo Agreement.
K End Date The last date from which Payments may be initiated against the PayTo Agreement.
L Automatic Renewal true when there is no endDate and the PayTo Agreement is automatically renewed.
M Additional Information A free-text field in which other information relevant to the PayTo Agreement is provided.
N Frequency The frequency with which payments can be initiated for this PayTo Agreement.
O Number Of Payments Permitted Qualifies the frequency in terms of the number of instructions to be created and processed during the specified period.
P Point In Time Qualifies the frequency in terms of an exact point in time or moment within the specified period.
Q Agreement Type The type of agreement.
R First Payment Amount An amount different from the payment amount, as it includes the costs associated with the first debited amount.
S Last Payment Amount The last payment amount different to the payment amount.
T Payment Amount The fixed amount to be debited.
U Maximum Payment Amount The maximum amount that may be paid, per payment.
V First Payment Due The date of the first payment is predefined in the PayTo Agreement.
W Last Payment Due The date of the last payment is predefined in the PayTo Agreement.
X Payer Type The type of Payer.
Y Payer ID Your unique customer identifier for this Payer.
Z Payer Name The name of the Payer.
AA Ultimate Payer Name The trading name of an organisation or the name of the receiver of goods or services.
AB Payer Reference Your reference for this Payer.
AC BSB The masked BSB for the Payer's payment account.
AD Account Number The masked Account number for the Payer's payment account.
AE Pay ID Type The PayID type.
AF Pay ID The masked PayID for the Payer's payment account.

Sample

Payee Reference,Agreement Token,Agreement Status,Customer ID,Customer Number,Supplier Business Code,Respond By Time,Purpose,Description,Start Date,End Date,Automatic Renewal,Additional Information,Frequency,Number Of Payments Permitted,Point In Time,Agreement Type,First Payment Amount,Last Payment Amount,Payment Amount,Maximum Payment Amount,First Payment Due,Last Payment Due,Payer Type,Payer ID,Payer Name,Ultimate Payer Name,Payer Reference,BSB,Account Number,Pay ID Type,Pay ID
INV759002453,C09805495592383,ACTIVE,288988302,CUSTOMERA,YOUR_SUPPLIER_BUSINESS,24 Jan 2025 07:33 AEST,Utility Payments,Your monthly utility payments,01 Oct 2025,,Yes,,Monthly,,,Fixed,,,AUD 100.05,,,,Individual,PS19400650001,AMIRA FONTIUS,AMIRA FONTIUS,PY19000890013,xxx-002,xxxxxx465,,
INV79448457A,C09805369296969,CANCELLED,288988303,CUSTOMERB,YOUR_SUPPLIER_BUSINESS,29 Jan 2024 11:42 AEDT,Other Service-related Payments,Your gym membership payments,29 Jan 2024,08 Nov 2025,,Gym Membership Payment for Joe,Adhoc,1,,Variable,AUD 3.00,AUD 5.00,AUD 2.00,AUD 5.00,29 Jan 2024,08 Nov 2025,Individual,032000123456,JOE GARCIA,JOE GARCIA,GM199787444,,,EMAL,j****@e****.com
Westpac Privacy Statement

Privacy Statement (for individuals whose personal information may be collected - in this clause referred to as "you"). All personal information we collect about you is collected, used and disclosed by us in accordance with our Privacy Statement which is available at Privacy Statement or by calling us through your relationship manager or Westpac representative. Our Privacy Statement also provides information about how you can access and correct your personal information and make a complaint. You do not have to provide us with any personal information but, if you don't, we may not be able to process an application or a request for a product or service.