BSB Lookup
GET/v1/payments/bsb/:bsb
Validate / lookup BSB value
Required States: ACTIVE
In order to validate a payment successfully, the following criteria must be met:
- The party must be
ACTIVE - The provided BSB must be valid and exist in the BSB directory
This operation provides a facility to validate an OFI (Other Financial Institution) BSB (Bank State Branch) number. The operation will return the BSB details for the provided BSB number. Results may vary depending on the underlying core banking system or alternative data provider being utilised.
Please Note: The AusPayNet BSB Directory is the primary source of truth for BSB data in Australia. This data source is published on a monthly cadence and as a result, valid BSBs may not be present in the directory if they have been created recently (within the last month).
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 BSB not found (PAY004001)
Capability not configured for this tenant (CRT022003)
General internal server error (GEN100000) or Service error (GEN100001)
All connector targets are currently unhealthy (CRT103001)