Skip to main content

Verify Payee Input File

Version

The current version is 1.

File format specification

The CSV payment import file is a comma separated values file consisting of several different records.

Each field is contained within quotes. Do this so that commas and special characters are interpreted correctly.

Record types

The structure of a Verify Payee file is:

  • One header record
  • One or more verify records
  • One trailer record
Record Type Description Comment
H File Header record One record per file.
V Verify Payee record One per account you wish to verify.
T File Trailer Record One record per file.

H - File header record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes H Record Type
2 Customer Code 1/10 Yes Alphanumeric Customer Code as provided by Qvalent. This code uniquely identifies the client organisation within the PaymentsPlus platform.
3 Customer Name 1/40 Yes Alphanumeric Customer Name as provided by Qvalent (for human readable purposes only).
4 Customer File Reference 1/20 Yes Alphanumeric Customers reference for the file.
5 Version 1/1 Yes 1 This field must be present with the value of 1.

V - Verify Payee record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes V Record Type
2 Name 1/100 Yes Alphanumeric Payee name or account name of the account to be verified.
3 BSB 6/7 Yes Numeric NNNNNN BSB number of the account to be verified. With or without the – is accepted.
4 Account Number 6/9 Yes Numeric Account number of the account to be verified.

T - Trailer record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes T Record Type
2 Total Record Count 1/10 Yes Numeric NNN Total number of records in the file. This should add up to the count of all the V records in the file.

Sample file

"H","TEST","Test Facility","FILE123","1"
"V","Payee Name","032-006","123465"
"V","Payee Name Two","032006","123466"
"T","2"

Verify Payee Response File

This file details the results of a verify payee file that has been processed.

Version

The current version is 1.

File format specification

The CSV payment import file is a comma separated values file consisting of several different records.

Each field is contained within quotes. Do this so that commas and special characters are interpreted correctly.

Record types

The structure of a Verify Payee response file is:

  • One header record
  • One or more verify records
  • One trailer record
Record Type Description Comment
H File Header record One record per file.
V Verify Payee response record One per account that was verified.
T File Trailer Record One record per file.

H - File header record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes H Record Type
2 Customer Code 1/10 Yes Alphanumeric Customer Code as provided by Qvalent. This code uniquely identifies the client organisation within the PaymentsPlus platform.
3 Customer Name 1/40 Yes Alphanumeric Customer Name as provided by Qvalent (for human readable purposes only).
4 Customer File Reference 1/20 Yes Alphanumeric Customers reference for the file.
5 Version 1/1 Yes 1 This field must be present with the value of 1.

V - Verify Payee record

Field Number Field Name Format Description
1 Record Type V Record Type
2 Name Alphanumeric Payee name or account name of the account to be credited.
3 BSB Numeric NNN-NNN BSB number of the account that was verified.
4 Account Number Numeric Account number of the account to be credited.
4 Verfied Account Name Alphanumeric The verified account name against the account when available.
5 Result Alpha One of the following: MATCH, MISMATCH, NOMATCH, ERROR, STRONGEST_MATCH, LOWER_MATCH, INSUFFICIENT_DATA, ACCOUNT_CLOSED_NE, LIMIT_REACHED
6 Description Alpha The description of the verify payee check result. (see table below).
Result Descriptions
MATCH The name you've entered appears to match payments made by other customers to this account.
NOMATCH We can't find enough payments made by other customers to this account.
STRONGEST_MATCH The account is in the name of 'matchedAccountName'.
LOWER_MATCH * The account is in the name of 'matchedAccountName'. However, we can't find many payments made to this account.
* The account is in the name of 'matchedAccountName'.However, we don’t see this name used by other customers to pay this account.
* We could not confirm the account name match. However, we see this name is commonly used to pay this account.
* The account name entered does not match the account. However, we see this name is commonly used to pay this account.
* The account is in the name of 'matchedAccountName'. The name entered does not match the account. However, we see it’s commonly used for payments made to this account.
INSUFFICIENT_DATA We could not confirm the account name match. We also can't find many payments made to this account.
MISMATCH * The name you've entered doesn't match payments made by other customers to this account.
* We could not confirm the account name match. We also don’t see this name used by other customers to pay this account.
* The account name entered does not match the account. We also can't find many payments made to this account.
* The account is in the name of 'matchedAccountName'. The name entered doesn’t match the account. We also can't find many payments made to this account.
* The account name entered does not match the account. We also don’t see this name used by other customers to pay this account.
* The account is in the name of 'matchedAccountName'. The name entered doesn’t match the account. We also don’t see it used by other customers to pay this account.
* The account name entered does not match the account.
* The account is in the name of 'matchedAccountName'. The name entered doesn’t match the account.
ERROR * There's a technical issue and we can't check if the name you've entered is commonly used for this account.
* We could not confirm the account name match.
* We could not confirm the account name match. We also don’t see this name used by other customers to pay this account.
ACCOUNT_CLOSED_NE This account is closed or doesn't exist. Contact the payee to confirm the details.
LIMIT_REACHED API Request Limit Reached

T - Trailer record

Field Number Field Name Min/Max Length Required Format Description
1 Record Type 1/1 Yes T Record Type
2 Total Record Count 1/10 Yes Numeric NNN Total number of records in the file. This should add up to the count of all the V records in the file.

Sample file

H,TEST,Test Facility,FILE123,1
V,Payee Name,032-006,123465,PAYEE NAME,STRONGEST_MATCH,The name you've entered appears to match payments made by other customers to this account. Learn more: https://paymentsplusdev1-wbc.office.qvalent.com/docs/user-guides/user-guide#verify-payee
V,Payee Name Two,032006,123466,PAYEE NAME,STRONGEST_MATCH,The name you've entered appears to match payments made by other customers to this account. Learn more: https://paymentsplusdev1-wbc.office.qvalent.com/docs/user-guides/user-guide#verify-payee
T,2
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.