Skip to main content

Recurring Billing export file format

Outstanding failed payments

This report shows recurring billing customers that have declined credit card transactions or returned bank account direct debits.

Column Name Comment Example
Customer Number The customer number for the failed transaction. 574753Q
Customer Name The name of the customer. Jane Doe
Receipt Number The PayWay internal receipt number for this transaction. Quote this number when contacting PayWay customer care about this transaction. 122020832
Currency The currency of the transaction that was performed. AUD
Principal Amount The amount before the surcharge has been added. 14.95
Surcharge Amount The surcharge amount is calculated from the Principal Amount based on your surcharge rates. 1.50
Payment Amount The total amount the customer will be debited, it is equal to the Principal Amount plus the Surcharge Amount. 16.45
Date The settlement date for the transaction in the format dd MMM yyyy. 18 DEC 2006
Automatic Retry Date The date the transaction will be retried if automatic retry is enabled in the format dd MMM yyyy. This will be blank if the transaction will not be retried (eg. the response code indicates a problem with the customer's details, such as invalid account number). This column will only be displayed if automatic retry of failed payments is enabled. 22 DEC 2006
Email Address The customer's email address. jdoe@example.com
Phone Number The customer's phone number, will contain only numbers, spaces and +. 02 4734 4441
Street Address 1 The customer's street address. 1 Barrington Place
Street Address 2 The customer's street address. Unit 3
City The name of the customer's city. Sydney
State The customer's state code, this will be one of the following: NSW, ACT, VIC, TAS, SA, WA, NT, QLD NSW
Postcode The customer's 4 digit postcode. 2000
Custom Field 1 Custom fields are used to store extra information about your customers and payments. If you have setup custom fields, the column heading will change to the name of your custom field.
Custom Field 2
Custom Field 3
Custom Field 4

Customers with final payment due

This report shows customers that are reaching the end of their regular recurring billing payment schedule. If you click "Stop Remaining Payments", the customer will be included in this report for the month containing their last payment.

Column Name Comment Example
Customer Number The customer number for the failed transaction. 574753Q
Customer Name The name of the customer. Jane Doe
Final Payment Date The date the final payment will be processed. 18 DEC 2006
Email Address The customer's email address. jdoe@example.com
Phone Number The customer's phone number, will contain only numbers, spaces and +. 02 4734 4441
Street Address 1 The customer's street address. 1 Barrington Place
Street Address 2 The customer's street address. Unit 3
City The name of the customer's city. Sydney
State The customer's state code, this will be one of the following: NSW, ACT, VIC, TAS, SA, WA, NT, QLD NSW
Postcode The customer's 4 digit postcode. 2000
Custom Field 1 Custom fields are used to store extra information about your customers and payments. If you have setup custom fields, the column heading will change to the name of your custom field.
Custom Field 2
Custom Field 3
Custom Field 4

Customers with expiring credit cards

This report shows customers who have credit cards that are due to expire. Customers that have had all remaining payments stopped are not included in this report.

Column Name Comment Example
Customer Number The customer number for the failed transaction. 574753Q
Customer Name The name of the customer. Jane Doe
Email Address The customer's email address. jdoe@example.com
Phone Number The customer's phone number, will contain only numbers, spaces and +. 02 4734 4441
Street Address 1 The customer's street address. 1 Barrington Place
Street Address 2 The customer's street address. Unit 3
City The name of the customer's city. Sydney
State The customer's state code, this will be one of the following: NSW, ACT, VIC, TAS, SA, WA, NT, QLD NSW
Postcode The customer's 4 digit postcode. 2000
Custom Field 1 Custom fields are used to store extra information about your customers and payments. If you have setup custom fields, the column heading will change to the name of your custom field.
Custom Field 2
Custom Field 3
Custom Field 4

New customers

This report shows customers that were created in the specified month. Many of the fields will be empty for variable customers as the values depend on what you include in your uploaded file.

Column Name Comment Example
Customer Number The customer number for the failed transaction. 574753Q
Customer Name The name of the customer. Jane Doe
Date Added The date the customer was created in the format dd MMM yyyy. 18 DEC 2014
Standard Plan The name of the standard plan the customer is signed up to. This will be blank if the customer is not on a standard plan. 12 x $14.95 per week
Date of First Payment For a regular customer, the first date the customer will be debited in the format dd MMM yyyy. 23 DEC 2014
Date of Next Payment The next payment date for a regular series of debits, or blank if the customer is on a variable series of debits. 23 DEC 2014
Frequency For a regular customer, the frequency at which the customer will be debited. Weekly
Next Payment Principal Amount For a regular customer, the amount before the surcharge amount is added for the next payment only. 20.00
Next Payment Surcharge Amount For a regular customer, the surcharge amount Is calculated from the Next Payment Principal Amount based on the surcharge rates for the customer. 1.50
Next Payment Amount For a regular customer, the amount of the next customer debit. This can be different from the regular amount debited. 12.50
Principal Amount For a regular customer, the amount before the surcharge has been added. 14.95
Surcharge Amount For a regular customer, the surcharge amount is calculated from the Principal Amount based on the surcharge rates for the customer. 1.50
Payment Amount For a regular customer, the total amount the customer will be debited for each regular payment. Equal to the Principal Amount plus the Surcharge Amount. 16.45
Final Payment Principal Amount For a regular customer, the amount of the final customer debit before any surcharge is added. If the schedule continues until further notice, this field will be blank. 100.00
Final Payment Surcharge Amount For a regular customer, the surcharge amount is calculated from the Final Payment Principal Amount and the surcharge rates for the customer. 1.50
Final Payment Amount For a regular customer, the total amount the customer will be debited for their final payment. This can be different to the regular payment amount. 101.50
Total Number of Payments For a regular customer, the total number of payments the customer will be debited. This will be blank if the customer is to be debited indefinitely. 12
Payments Remaining For a regular customer, the number of payments remaining. This will be blank if the customer is to be debited indefinitely. 9
User Created The name of the user who created the customer. This will be blank for customers that have signed up on the Internet. John Smith
Date of Final Payment For a regular customer with a set number of payments, the date that the last payment will be created. 23 DEC 2015
Email Address The customer's email address. jdoe@example.com
Phone Number The customer's phone number, will contain only numbers, spaces and +. 02 4734 4441
Street Address 1 The customer's street address. 1 Barrington Place
Street Address 2 The customer's street address. Unit 3
City The name of the customer's city. Sydney
State The customer's state code, this will be one of the following: NSW, ACT, VIC, TAS, SA, WA, NT, QLD NSW
Postcode The customer's 4 digit postcode. 2000
BPAY Ref This is the Reference Number that must be entered in order to make a BPAY transaction. 10000000000024
BPAY Ref for Excel This is the same as the "BPAY Ref" field, but formatted so that it will display correctly in Excel. 10000000000024
Custom Field 1 Custom fields are used to store extra information about your customers and payments. If you have setup custom fields, the column heading will change to the name of your custom field.
Custom Field 2
Custom Field 3
Custom Field 4

Current customers

This report shows all your current Recurring Billing customers including those with outstanding failed payments. This report shows new customers, customers with final payment due and all customers in the middle of their recurring billing payment schedule. Customers on a variable payment schedule remain on this report until you "Stop all Remaining Payments". Many of the fields will be empty for variable customers as the values depend on what you include in your uploaded file.

Column Name Comment Example
Customer Number The customer number for the failed transaction. 574753Q
Customer Name The name of the customer. Jane Doe
Date Added The date the customer was created in the format dd MMM yyyy. 18 DEC 2014
Standard Plan The name of the standard plan the customer is signed up to. 12 x $14.95 per week
Date of First Payment The first date the customer will be debited in the format dd MMM yyyy. 23 DEC 2014
Date of Next Payment The next payment date for a regular series of debits, or blank if the customer is on a variable series of debits. 23 DEC 2014
Frequency The frequency at which the customer will be debited. Weekly
Next Payment Principal Amount For a regular customer, the amount before the surcharge amount is added for the next payment only. 20.00
Next Payment Surcharge Amount For a regular customer, the surcharge amount Is calculated from the Next Payment Principal Amount based on the surcharge rates for the customer. 1.50
Next Payment Amount For a regular customer, the amount of the next customer debit. This can be different from the regular amount debited. 12.50
Principal Amount For a regular customer, the amount before the surcharge has been added. 14.95
Surcharge Amount For a regular customer, the surcharge amount is calculated from the Principal Amount based on your surcharge rates. 1.50
Payment Amount For a regular customer, the total amount the customer will be debited; it is equal to the Principal Amount plus the Surcharge Amount. 16.45
Final Payment Principal Amount For a regular customer, the amount of the final customer debit before any surcharge is added. If the schedule continues until further notice, this field will be blank. 100.00
Final Payment Surcharge Amount For a regular customer, the surcharge amount is calculated from the Final Payment Principal Amount and the surcharge rates for the customer. 1.50
Final Payment Amount For a regular customer, the total amount the customer will be debited for their final payment. This can be different to the regular payment amount. 101.50
Total Number of Payments For a regular customer, the total number of payments the customer will be debited. This will be blank if customer is to be debited indefinitely. 12
Payments Remaining For a regular customer, the number of payments remaining. This will be blank if the customer is to be debited indefinitely. 9
User Created The name of the user who created the customer. This will be blank for customers that have signed up on the Internet. John Smith
Date of Final Payment For a regular customer with a set number of payments, the date that the last payment will be created. 23 DEC 2015
Email Address The customer's email address. jdoe@example.com
Phone Number The customer's phone number, will contain only numbers, spaces and +. 02 4734 4441
Street Address 1 The customer's street address. 1 Barrington Place
Street Address 2 The customer's street address. Unit 3
City The name of the customer's city. Sydney
State The customer's state code, this will be one of the following: NSW, ACT, VIC, TAS, SA, WA, NT, QLD NSW
Postcode The customer's 4 digit postcode. 2000
BPAY Ref This is the Reference Number that must be entered in order to make a BPAY transaction. 10000000000024
BPAY Ref for Excel This is the same as the "BPAY Ref" field, but formatted so that it will display correctly in Excel. 10000000000024
Custom Field 1 Custom fields are used to store extra information about your customers and payments. If you have setup custom fields, the column heading will change to the name of your custom field.
Custom Field 2
Custom Field 3
Custom Field 4
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.