Skip to main content

Verify Payee API

This resource is used to verify payee names.

Verify Payee

Verify a payee name against a bsb and account number.

Request

POST /verify-payee

Request body

Field Format Length Required Description
name string 1-140 Required The payee name to verify.
bsb string 6 Required The bsb to verify the payee name against.
accountNumber string 6-10 Required The account number to verify the payee name against.

Response

If successful, this method returns the following in the response body.

Field Format Data
links Array of Links Links to related documents and resources.
result string The result of the verification. One of MATCH, MISMATCH, NOMATCH, ERROR. See Verify Payee guide
description string The description of the result. See Verify Payee guide

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
403 FORBIDDEN Your facility may not be set up. View more.
407 PROXY AUTHENTICATION REQUIRED This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.

Upload Verify Payee File CSV

To upload a verify payee csv file, you must:

  • Create a file in the Verify Payee File format
  • Encode your POST as multipart/form-data using curl or a standard library.
  • In the multipart request send a field named file with a unique filename

Request

POST /verify-payee-files/{fileIdentifier}/upload

Request headers

Header Description
Prevent-CSRF Set to true. Required. This header is required for multipart requests to prevent Cross-Site Request Forgery

Path parameters

Parameter Name Format Description
fileIdentifier string The code that uniquely identifies the file. This value must match the file in the H (header) record of the file you upload.

Request body

Encode your POST as multipart/form-data. Provide the file contents in the multipart binary part. Provide the following in the multipart request part:

Field Format Description
file string The filename of the file you have uploaded.

Response

If successful, this method returns the Verify Payee File Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
201 CREATED The file is stored. PaymentsPlus will check the format of the file and then process each line. You must check the status of the file.
400 BAD REQUEST Prevent-CSRF header is missing or is not set to true.
422 UNPROCESSABLE ENTITY The request contained invalid data or the file was detected to be a duplicate. A file is a duplicate when the file identifier already exists.

Get Verify Payee File

Get the file details.

Request

GET /verify-payee-files/{fileIdentifier}

Path parameters

Parameter Name Format Description
fileIdentifier string The code that uniquely identifies the file.

Request body

None.

Response

If successful, this method returns a Verify Payee File Model in the response body.

HTTP Status Codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK Authorisation succeeded and your software/network can access the API.
401 UNAUTHORIZED Authorisation failed. View more.
403 FORBIDDEN Your facility may not be set up. View more.
404 NOT FOUND The fileIdentifier path parameter may be incorrect.
407 PROXY AUTHENTICATION REQUIRED This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.

Download Verify Payee File CSV Response

Request

GET /verify-payee-files/{fileIdentifier}/csv

Path parameters

Parameter Name Format Description
fileIdentifier string The code that uniquely identifies the file.

Request body

None

Response

If successful, this method returns the Verify Payee Response File.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
201 CREATED The file is stored. PaymentsPlus will check the format of the file and then process each line. You must check the status of the file.
404 NOT FOUND A Verify Payee File with the fileIdentifier was not found.
406 NOT FOUND The Accept header was not text/csv.
422 UNPROCESSABLE ENTITY The fileIdentifier parameter was invalid.

Verify Payee File Model

Field Type Description
links Array of Links Links to related documents and resources.
fileName string The file name.
fileIdentifier string The file identifier.
statusCode string The status of the file. See File status codes.
createdDate string The date the file was created in PaymentsPlus. In the format YYYY-MM-DD
fileErrors Array of Errors An array of errors detected in the file. Provided when status=ERROR. Otherwise not provided.

For example:

{
    "links": [],
    "fileName": "VerifyPayeeFile1.csv",
    "fileIdentifier": "123456789",
    "statusCode": "COMPLETE",
    "createdDate": "2025-05-08",
    "errors": []
}

File Error Model

Field Format Description
line string The line the error occurred on.
error string The error found on the line.
value string The value provided in the file.

For example:

{
    "line": "Line 1",
    "error": "Version",
    "value": "N"
}

File Status Codes

Code Description
ERROR Errors were found in the file. Errors will be returned with the file details.
PROCESSING The file is currently processing, and the verify payee checks are being submitted to the bank.
COMPLETE The file is complete and the status of the verify payee checks has been returned.
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.