Our BSB API returns a list of BSB numbers or lets you find a specific BSB number that can be charged by Pay Advantage.
This could be used to verify a customers BSB in your own systems or help identify BSBs that can be entered by your customer.
Note that BSBs must support electronic transactions to be used for direct debit requests. This can be checked using the query parameter '/bsb?electronic=true' with the first endpoint.
Endpoints
GET '/reference/bsb'
GET '/reference/bsb/{bsbnumber}'Returns a list of all BSBs that can be charged by Pay Advantage. If there are no BSBs that match your search you will be returned an empty list.
BSBs that are marked as "Electronic": false cannot be used with the Direct Debit API for generating and authorising direct debit requests. This list can be filtered using this parameter in the request GET '/reference/bsb?electronic=true'
Example Request
curl -L -X GET 'https://api.payadvantage.com.au/v3/reference/bsb' \
-H 'Authorization: Bearer {access_token}' Example Responses
STATUS 200 // Successful
[
{
"Number": "012002",
"Bank": "ANZ ANZ Smart Choice",
"Electronic": true
},
{
"Number": "012003",
"Bank": "ANZ Merged",
"Electronic": false
},
{
...
}
]Query Parameters
Parameter used in the GET function URL.
| electronic boolean |
|---|
| Indicates if the BSB supports electronic transactions. If true the BSB can be used for direct debit requests and vice-versa. |
Returns a specific BSB using the bsbNumber as an identifier. The BSB number must always be 6 digits long, with no additional characters or padding. If the BSB number could not be found, the response will be a HTTP 404 as the endpoint is technically incorrect.
Example Request
curl -L -X GET 'https://api.payadvantage.com.au/v3/reference/bsb/{bsbNumber}' \
-H 'Authorization: Bearer {access_token}' Example Responses
STATUS 200 // Successful
{
"Number": "012002",
"Bank": "ANZ ANZ Smart Choice",
"Electronic": true
}
Comments
0 comments
Please sign in to leave a comment.