Check the status of the PayID.

Check if the PayID is registered and able to accept NPP and PayTo payments. Also support validation of bsb and account number attached to the PayID.

Body Params
string
required
length between 1 and 140

The PayID to check.

string
enum
required

PayID Type. Valid Values:

  • 'PHONE’ Can be a mobile phone number or landline with area code
  • ‘EMAIL’ Email address
  • ‘ABN’ Australian Business Number
  • ‘ORG’ Organisation Name
Allowed:
string

Bsb to validate. If provided, accountNumber must be present.

string

Account number to validate. If provided, bsb must be present.

string
length between 1 and 140

Account name to check against the payId legal account name.

Responses

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json