Bpay Biller Lookup
GET/v1/payments/bpay/biller/:billerCode
Validate / lookup Bpay Biller value
Required States: ACTIVE
In order to validate lookup a BPAY biller successfully, the following criteria must be met:
- The party must be
ACTIVE - The provided BPAY Biller Code must be valid
This operation provides a facility to retrieve BPAY biller information to aid in BPAY payment initiation use cases. It returns data such as:
- BPAY Biller Code
- Industry ANZSIC Code
- Short Name
- Long Name
- CRN Type
- CRN Location
- BPAY View Enabled
- Accepted Payment Methods
- Valid CRN Lengths
Please Note: The data returned is subject to the underlying core banking system and the data made available via service interfaces. Some core banking systems only provide basic data for BSBs and may not provide additional data such as:
- Accepted payment methods
- BPAY view availability
- Industry ANZSIC codes
- etc.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 500
- 503
OK
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001) or Party not in required status (PAR003001)
Party not found (PAR004001) or Biller not found (PAY004002)
Capability not configured for this tenant (CRT022003)
General internal server error (GEN100000) or Service error (GEN100001)
All connector targets are currently unhealthy (CRT103001)