Purpose

Use PayID Enquiry to:

• Check whether a PayID is registered and NPP and PayTo reachable for payments
• Validate the BSB and account number attached to the PayID; and
• Validate whether a customer‑provided/expected account name matches the Full Legal Account Name associated with the PayID (PayID Name Matching)

PayID Name Matching

Our proprietary PayID matching logic is designed specifically for these real‑world conditions, measuring how “close” two names are, then applying additional validation rules to make the outcome more reliable for payments use cases.

Request Body

Required:

• payID (string, length 5–50): PayID to check
• payIDType (enum): PHONE | EMAIL | ABN | ORG

Optional (for PayID name matching)

• accountName (string, length 1–140): Expected account name used for PayID name matching
• bsb (string): Bsb to validate. If provided, accountNumber must be present.
• accountNumber (string): Account number to validate. If provided, bsb must be present.

PayID validation

The following validation is applied based on the payIDType:

PayID Type: PHONE

• Validation:

  Text

  /^\+[0-9]{1,3}-[1-9][0-9]{1,29}$/

• Examples of accepted values: +61-40012313

• Examples of rejected values: 0400123123, +614123123

PayID Type: EMAIL

• Validation:

  /^(?:[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?.)+a-z0-9 ?)$/

• Examples of accepted values: [email protected], [email protected], [email protected], [email protected], [email protected]
• Examples of rejected values: [email protected], user@, @example.com, user@example, [email protected], [email protected], [email protected], [email protected], [email protected], user [email protected]

PayID Type: ABN

• Validation:

  /^((\d{9})|(\d{11}))$/

• Examples of accepted values: 123456789, 000123456, 12345678901, 00000000000, 98765432109
• Examples of rejected values: 12345678, 1234567890, 123456789012, 12345AB789, 123-456-789, 123456789, 123456789

PayID Type: ORG

• Validation:

  /^\S[a-z0-9!\"#$%&'()*+,./:;<=>?@\[\] ^_`{|}~-]*\S$

• Examples of accepted values: acme123, acme-co, acme.co, acme_company, org+test, abc@xyz, name!test, Acme, acme org, acme
• Examples of rejected values: acme , a, acme\norg, acme\torg

Responses

200 success

{
  "payID":"+61-400123456",
  "bsb": "132-456",
  "accountNumber": "132465879",
  "payIDType":"PHONE",
  "accountName": "Jonathan George Smith"
  }

{
    "AccountStatus": {
        "nppReachable": true,
        "paytoReachable": true,
        "accountServices": [
            "sct",
            "x2p1",
            "mpis"
        ],
        "validBsb": false,
        "validAccountNumber": false,
        "aliasName": "Jonathan Smith",
        "validAccountName": true
    }
}

400 bad request

{
  "payID":"+61-469887654"
  }  

{
    "message": "[object has missing required properties ([\"payIDType\"])]",
    "details": {
        "failureCode": "ERR0.03",
        "failureReason": "[object has missing required properties ([\"payIDType\"])]"
    }
}

{
  "payID":"australian lithium exploration services proprietary limited",
  "payIDType":"EMAIL",
  "bsb": "182222",
  "accountNumber": "132456789"
  }

{
    "message": "PayID format is incorrect",
    "details": {
        "failureCode": "ERR0.03",
        "failureReason": "PayID format is incorrect"
    }
}

401 invalid authorization header

{
    "message": "Unauthorized",
    "details": {
        "failureCode": "ERR0.02",
        "failureReason": "Unauthorized"
    }
}

404 account not found

{
    "message": "PayID not found",
    "details": {
        "failureCode": "ERR0.03",
        "failureReason": "PayID not found"
    }
}

Test Data

To test the name matching outcomes, the Full Legal Account Name (FLAN) attached to the PayIDs have been provided below. When you invoke the PayID Enquiry endpoint, you will set the accountName, this will be matched against the FLAN (in the table below) and a match result will be returned.

• A Match will include the following in the api response: "validAccountName": true
• A No Match will include the following in the api response: "validAccountName": false

Example:

{
  "payID":"[email protected]",
  "payIDType":"EMAIL",
  "accountName": "Michael Williams"
  }

{
    "AccountStatus": {
        "nppReachable": true,
        "paytoReachable": true,
        "accountServices": [
            "sct",
            "x2p1",
            "mpis"
        ],
        "aliasName": "M Williams",
        "validAccountName": true
    }
}

Test Scenarios

To simulate the complete end to end process from looking up a PayID, matching the expected account names to making a payment, use the below PayIDs

Failure Scenrios

Bank Accounts