Skip to main content

CSV payment upload file

The CSV payment upload file is sent to process a batch of payments. The system responds with a CSV payment response report.

File format

CSV Card Payments Only Account Tokens Supported AUD or NZD Pre-Auth Not Supported

The CSV format is the simplest format. It specifies only the required fields. This format supports only card payments.

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

To upload a payment file in this format you must

  • Send the parameter format with CSV or CSV_TOKENS.
  • Use only one currency per file.
  • Use only one supplier business code per file.
  • In the Account Number field, use only all card PANs for CSV or all account tokens for CSV_TOKENS files.

Header row

Column Value
A Transaction Number
B Merchant ID
C Account Number
D Customer Number
E Transaction Amount
F Expiry Date
G Currency
H Customer Name
I Transaction Type
J Capture ID
K Invoice Number
L Merchant Name
M Merchant Street Address
N Merchant Location
O Merchant State
P Merchant Country
Q Merchant Postcode
R Sub-merchant ID

The header row is optional.

Detail rows

Column Value Required Length Data Type Description
A Transaction Number Required 1-100 characters AN A unique reference for a transaction.
B Merchant ID Required 1-20 characters AN A reference to the supplier business you wish to process the payment for. Must be the same for every transaction in the file. Create a separate file for each different supplier business code.
C Account Number Required when Customer Number is not provided. Up to 20 digits or characters N or AN The full card number, or an account token. Use only all card PANs for CSV or all account tokens for a CSV_TOKENS file. Provide blank for refunds as QuickStream will use the original account.
D Customer Number Required when Account Number is not provided. 1-100 characters AN Your customer's number.
E Transaction Amount Required 1-11 digits including decimal point (Up to 99999999.99) N The transaction amount in dollars and cents. If this is a refund, this the amount you wish to refund up to the original payment amount.
F Expiry Date Optional 4 digits N The expiry date of the card in MMYY format. E.g. January 2021 is 0121
G Currency Optional 3 characters A AUD or NZD. Defaults to AUD when not provided. Must be the same for every transaction in the file. Create a separate file for each currency.
H Customer Name Optional 1-256 characters AN An optional customer name. This is for human readable purposes only.
I Transaction Type Optional 1 character A Blank or R. Leave this field blank to indicate a payment. Use R to indicate a refund.
J Capture ID Required when Transaction Type is R. 8-20 digits N The receipt number provided for the original payment.
K Invoice Number Optional 1-256 characters AN An optional reference for this transaction. Often this is an invoice number.
L Merchant Name Required for Aggregator merchants only. 1-22 characters AN See Soft descriptors for Aggregators.
M Merchant Street Address Required for Aggregator merchants only. 2-48 characters AN See Soft descriptors for Aggregators.
N Merchant Location Required for Aggregator merchants only. 1-13 characters AN See Soft descriptors for Aggregators.
O Merchant State Required for Aggregator merchants only. 2-3 characters A One of NSW, ACT, VIC, QLD, NT, SA, WA, TAS. See Soft descriptors for Aggregators.
P Merchant Country Required for Aggregator merchants only. 2 characters A AU only. See Soft descriptors for Aggregators.
Q Merchant Postcode Required for Aggregator merchants only. 4 characters N See Soft descriptors for Aggregators.
R Sub-merchant ID Required for Aggregator merchants only. 1-15 characters AN See Soft descriptors for Aggregators.

Do not include any further columns.

Minimal file with card number format = CSV

"Transaction Number","Merchant ID","Account Number","Customer Number","Transaction Amount","Expiry Date"
"123456","SUPPLIERBUSINESSCODE","4242424242424242","CUSTOMERA","100.00","0121"

Minimal file with customer number and account token format = CSV_TOKENS

"Transaction Number","Merchant ID","Account Number","Customer Number","Transaction Amount","Expiry Date"
"123456","SUPPLIERBUSINESSCODE","CUST89455677","CUSTOMERA","100.00","0121"

Full file with card number and refund format = CSV

"Transaction Number","Merchant ID","Account Number","Customer Number","Transaction Amount","Expiry Date","Currency","Customer Name","Transaction Type","Capture ID","Invoice Number"
"123457","SUPPLIERBUSINESSCODE","4242424242424242","CUSTOMERA","200.00","0121","AUD","Customer A","","","INVOICE2"
"123458","SUPPLIERBUSINESSCODE","","CUSTOMERA","100.00","","AUD","Customer A","R","1222684604","INVOICE1"

Note:

  • Transactions using this format are flagged as Recurring transactions (i.e. Mastercard or Visa Recurring). Use this format when you hold a valid direct debit agreement from the cardholder. In addition, for Visa Recurring, the first transaction has to be authorised with a valid card expiry date. If the transaction is a one-off transaction, you must use a different file format. Under no circumstances may you perform one-off transaction using this format.
  • Refunds are a potential avenue for fraud. Check your merchant agreement for information about performing refunds. You must provide the receipt number of the transaction you wish to refund in Capture ID.

Soft descriptors for aggregators

To use these fields a merchant facility must be set up in Westpac systems to use soft-descriptors. Providing soft-descriptors for transactions to merchant facilities which are not set up to use them will have no effect.

Read more about Soft descriptors for Aggregators.

Use these fields in columns L to R in this format.

Field Required Description
Merchant Name Required for Aggregator merchants only. Maximum 22 characters.
Must be in the format AggregatorName*SubMerchantName.
For example:
  • AggregatorName is Jane's Transactions, abbreviated to JAT.
  • SubMerchantName name is Jill's Bikes.
  • The value of this field may be JAT*JillsBikes.
AggregatorName can be either in full or abbreviated and must be 3 characters.
Westpac may suggest a three character aggregator name during your implementation.
Merchant Street Address Required for Aggregator merchants only. Maximum 48 characters.
The street address of the sub-merchant's trading address.
It is a scheme requirement to populate the street address as part of the payment. Westpac does not hold the street address information for sub-merchants and it will not appear on the cardholder's or merchant's statement.
Must contain the street address lines only:
  • Include the city or suburb in Merchant Location.
  • Include the state in Merchant State.
  • Include the country in Merchant Country.
  • Include the post code in Merchant Post Code.
Merchant Location Required for Aggregator merchants only. Maximum 13 characters.
The city or suburb of the sub-merchant's trading address.
Merchant State Required for Aggregator merchants only. Maximum 3 characters.
The state of the sub-merchant's trading address. One of:
  • NSW
  • ACT
  • VIC
  • QLD
  • NT
  • SA
  • WA
  • TAS
Merchant Country Required for Aggregator merchants only. Maximum 2 characters.
Must be set to AU.
The sub-merchant must be registered in Australia and have a presence and process payments within Australia.
Merchant Postcode Required for Aggregator merchants only. Maximum 4 characters.
The postal code of the sub-merchant's trading address.
Sub-merchant ID Required for Aggregator merchants only. Maximum 15 chracters.
A unique identifier for your sub-merchant. The aggregator allocates the sub-merchant identifier. Westpac does not allocate this value.

Do not include any further columns.

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.