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

GET /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.
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.