API reference
The BankRec REST API is RESTful. The API authorisation framework is HTTP Basic Auth.
You send JSON formatted requests and the API returns JSON formatted responses. Because the REST API is based on open standards, you can use any web development language to access the API.
Access depends on the enabled capabilities of your BankRec facility.
Our APIs
Statements
List configured statements, their accounts, and statement dates. Download individual statement files.
Balances
List accounts and dates with balance information, and fetch balance data.
API keys
Use your existing key to get a new key and automate your API key renewal.
API collection & environment
These files are used to import the BankRec API Environment and Collection of API's into Postman for use and testing.
| Version | File | Description | Date |
|---|---|---|---|
| 1.0.0 | Test Environment | Environment setting for testing | 1/08/2026 |
| 1.0.0 | API Collection | A Collection of API calls for testing | 1/08/2026 |
To test your network connectivity and API credentials are working correctly, use the Root API.
Getting started
- Sign-in to BankRec to get your API keys.
- This API is RESTful.
- Determine the base URL for the Test environment.
- Send your API key as the HTTP Basic Auth username. Leave the password blank.
- You send JSON formatted requests and the API returns JSON formatted responses.
- You must put in place error handling based on HTTP status codes.
- Statements and Balances are the most important resources.
Read next:
Base URL
Use the BankRec REST APIs in these environments:
| Environment | Description | URL |
|---|---|---|
| Support | This is the Test environment. Use your test API keys to make calls to the test URI. |
https://api.bankrec.support.qvalent.com/rest/v1 |
| Production | This is the Live environment. Use your production API keys to make calls to the live URI. |
https://api.bankrec.westpac.com.au/rest/v1 |
Versioning
The current version of the API is v1.
Our change log outlines changes between various API versions to help our clients better integrate with our API service.
If we make any backwards incompatible changes we will release a new major version of the API.
Resources
The following changes will not result in a new API version:
- Adding new resources.
- Supporting new HTTP verbs.
- Changing the length or format of IDs. You can assume IDs we generate will not exceed 255 characters. You should be able to handle IDs of up to 255 characters.
- Adding new optional request parameters.
- Adding new properties in responses.
- Changing the order of properties in requests and responses.
- Changing wording of error message designed to be displayed to users.
- Improved error reporting when an invalid request is received.
- Appending new optional fields to, or re-purposing filler fields in reports and files.
Your software must be written to handle these types of changes.
Security
The following changes will not result in a new API version:
- Adding or removing TLS ciphers.
- Changing supported TLS versions.
- Other changes made to improve security.
If you believe we have made a backwards-incompatible change, please report a defect.
Credentials and security
Authentication and headers
Authentication to the API is via HTTP Basic Auth. All API requests must be made over HTTPS.
For example:
GET /rest/v1 HTTP/1.1
Host: api.bankrec.westpac.com.au
Authorization: Basic cXZ0ZXN0YXBpa2V5Og==
Accept: application/json
| Request header | Description |
|---|---|
Authorization |
When you access a resource you must use your API key. You must send an API key as the Basic Authentication username. Leave the password blank. |
Accept |
Set to application-json. Required. |
API credentials
API Key
You must provide the API Key to access the API. The API Key allows you to view statements and balances, and provides full access to the API.
To get these values:
- Sign-in to BankRec in the test or production environment.
- To get an API key, navigate to REST API → API Keys.
From this screen you can create additional keys as required, or you can click on the key name to view the details key. When a key is created you will be shown the full API key value. Once you leave that page the full key will not be able to be seen again. If you don't note the value down you will need to create a new key to get access.
API keys expire after 1 year, and then you must use a new key. You can automate API key renewal.
Each resource in this API requires your API Key to access.
Sending an invalid API key returns a 401 Unauthorized HTTP status code.
To test authentication, send a GET to the base URL.
IP Whitelisting
You must whitelist the IP addresses you wish to connect to the API with. Any IP addresses not whitelisted through the portal will not be allowed to connect to the API.
To whitelist an IP address:
- Sign-in to BankRec in the test or production environment.
- Navigate to REST API → IP Whitelist.
From this screen you can add, edit, and remove IP addresses that have been whitelisted. An IP address range can be used by following CIDR Notation.
Transport layer security
You must secure your connection using Transport Layer Security (TLS) 1.2 over HTTPS.
DDOS Protection
This API has Distributed Denial-of-Service (DDOS) protection. DDOS protection is used to prevent malicious users using all the available resources.
HTTP verbs
The standard HTTP verbs used are:
| Verb | Purpose |
|---|---|
| GET | Read a resource |
| PUT | Create or replace a resource when URL is known |
| POST | Create a resource when URL is not known |
| PATCH | Update details of a resource |
| DELETE | Delete a resource |
PUT request and omit a field, the server removes or defaults the field value.
HATEOAS and pagination
If available, each response from the API includes an array of contextual HATEOAS links. You can follow links returned in responses to related resources.
Open help URLs in your browser to access developer help (usually this reference).
Resources which return lists use a standard structure:
- The
dataJSON property holds up to 20 items. - More results can be found by following
nextandprevlinks.
See Links for the response body.
Links
The response body contains links in most responses generated by this API.
For example:
{
"rel": "",
"href": "",
"requestMethod": ""
}
| Field | Format | Data |
|---|---|---|
rel |
string |
The relationship to the resource. Open help URLs in a browser to view this developer reference. next and prev are used for paginated resources. |
href |
string |
URL of a related document or resource. |
requestMethod |
string |
HTTP Verb |
Dates
Dates are requested and returned as a string in the following formats:
| Reference | Format | Description |
|---|---|---|
date |
YYYY-MM-DD |
For dates with no time component, use the ISO-8601 short date format. |
date-time |
YYYY-MM-DDTHH:mm:ssZ |
For dates with a time component, use the ISO-8601 extended format. |
date-month |
YYYY-MM |
For dates with no day component, use the ISO-8601 year and month format. This format is used to filter large result sets by month and year. |
For example:
{
"statementDate": "2026-08-17",
"transactionDateTime": "2026-08-17T03:48:40+00:00",
"month": "2026-08"
}
Resource summary
This API reference is organised by resource type. Each resource type has one or more data models and one or more methods.
Root
For Root resource details, see Root API.
| Action | HTTP request | Description |
|---|---|---|
| Get | GET | Get information about your facility. Use to test your network connectivity and API credentials are working correctly. |
API Keys
For API Keys resource details, see API Keys API.
| Action | HTTP request | Description |
|---|---|---|
| Get latest | GET /api-keys/latest |
Get your latest API Key and automate your key renewal code. |
Statements
For Statements resource details, see Statements API.
| Action | HTTP request | Description |
|---|---|---|
| List statement configs | GET /statements |
List configured statements for your facility. |
| List statement accounts | GET /statements/{configCode}/accounts |
List accounts for a particular statement. |
| List statement dates | GET /statements/{configCode} |
List available statement dates. |
| Get statement file | GET /statements/{configCode}/{date} |
Download an individual statement file. |
| Get statement file (index) | GET /statements/{configCode}/{date}/{index} |
Download an individual statement file. This index endpoint is only required for certain file formats. Index begins at 1. |
Balances
For Balances resource details, see Balances API.
| Action | HTTP request | Description |
|---|---|---|
| List accounts | GET /balances/accounts |
List accounts with available balance information. |
| List account balance dates | GET /balances/accounts/{account} |
List dates with available balance information for an account. |
| Get balance | GET /balances/accounts/{account}/{date} |
Get balance information. |
Errors
Error handling
If you receive one of these responses, wait 20 seconds and then re-send the same request.
429 Too Many Requests503 Service Unavailable- A transient network error, such as a time-out or closed socket
If you receive a 422 Unprocessable Entity you may display the error message to your user and allow them to correct the data.
If you receive any other response code, you should log the response code and response body.
See HTTP Status Codes.
Error responses
The response body for all HTTP errors includes additional error details.
For example:
{
"links": [],
"status": "",
"requestMethod": "",
"requestUrl": "",
"customerMessage": "",
"developerMessage": "",
"errors": []
}
| Field | Format | Data |
|---|---|---|
links |
Array of Links | One or more links related to the error. |
status |
string |
HTTP status code. |
requestMethod |
string |
HTTP method used in the request that resulted in this error. |
requestUrl |
string |
URL used in the request that resulted in this error. |
customerMessage |
string |
A user friendly message you can display to your customers. |
developerMessage |
string |
A developer friendly message that may provide more information. |
errors |
Array of Field Errors | (optional) A list of validation errors that may be applicable to the response. |
Field errors
The response body includes field-level validation errors.
For example:
{
"messages": [],
"fieldName": "",
"fieldValue": ""
}
| Field | Format | Data |
|---|---|---|
messages |
Array of string |
A list of error messages you can display to your customers. Do not rely on error messages as we may change them without notice. |
fieldName |
string |
The name of the field in the request that resulted in this error. |
fieldValue |
string |
The value of the field provided in the request that resulted in this error. |
HTTP status codes
BankRec REST API returns standard HTTP status codes for successful and error responses.
| Status Code | Description | More information |
|---|---|---|
200 |
OK | The request has succeeded. |
201 |
CREATED | The server has created the resource you requested. If you created a transaction, you must use the status field to determine if the transaction was approved. The Location header points to the new resource. |
202 |
ACCEPTED | The request has been accepted for processing, but the processing has not completed. For transactions, this response code is returned if the banking network is slow to respond when processing a transaction. The status of the transaction will be pending. To find out if a transaction is approved or declined, send a request to get transaction details. |
204 |
NO CONTENT | Response to a successful request that won't be returning a body. This response code is returned for DELETE requests. |
400 |
BAD REQUEST | The request could not be understood by the server due to malformed syntax. This response code is returned if you send query parameters on a PUT, POST or PATCH request. |
401 |
UNAUTHORIZED | View more. |
403 |
FORBIDDEN | View more. |
404 |
NOT FOUND | The server has not found anything matching the Request-URI. The response body may contain more information. |
405 |
METHOD NOT ALLOWED | A request was made of a resource using a request method not supported by that resource. For example, you sent a POST to a resource that only allows GET. Refer to the documentation of the resource for supported methods. |
406 |
NOT ACCEPTABLE | The server can not send the representation requested by the client. For example, the accept header provided was not application/json. |
407 |
PROXY AUTHENTICATION REQUIRED | This error is returned by your proxy server, not BankRec. You need to configure a proxy username and password in order to access the internet. |
409 |
CONFLICT | The server can not process the request as it has conflicted with another request. For example, this occurs if you attempt to create two customers with the same customer number simultaneously. |
415 |
UNSUPPORTED_MEDIA_TYPE | The server can not process the content type which was provided. The content type header provided was not application/json. |
422 |
UNPROCESSABLE ENTITY | View more. |
429 |
TOO MANY REQUESTS | View more. |
500 |
INTERNAL SERVER ERROR | View more. |
501 |
NOT IMPLEMENTED | The server does not recognize the request method. Use one of the standard HTTP verbs. |
503 |
SERVICE UNAVAILABLE | View more. |
401 Unauthorized
The server can not authenticate the details in the Authorization header. The response body contains more specific information.
This indicates that you have not passed a valid API key, the key has expired, the IP address you are using has not been whitelisted, or the Authorization header is not formatted correctly. Correctly formatted requests include a header like this:
Authorization: Basic cXZ0ZXN0YXBpa2V5Og==
The letters after Basic are the base-64 encoded representation of your API key.
See Authentication and Headers.
403 Forbidden
A valid API key was provided, but it does not have access to the requested resource.
Facility setup incomplete
Your facility configuration is not completed. Contact your Westpac representative.
Facility is not live
Your facility is not live in the Production environment. This error is not returned in the Support (test) environment. Contact your Westpac representative.
422 Unprocessable Entity
The server can not process the content of the request. The response body indicates which parameters are in error. You may display the error messages to users.
You should resend the request with corrected parameters.
429 Too Many Requests
When a request is rejected due to rate limiting you have sent too many requests in a given amount of time. If you send more than 5 simultaneous requests, you may receive this response code. In addition, certain endpoints may have their own rate limiting, such as downloading a file.
500 Internal Server Error
The server encountered an unexpected condition which prevented it from fulfilling the request.
You should not resend the request. The server may have completed some of the request processing. Contact BankRec Technical Support. Provide the following information:
- the BankRec customer code for your facility,
- the method you sent in the request (e.g.
GET,POST), - the URL you sent in the request,
- the date/time of the request,
- the response body returned by the server (if any).
503 Service Unavailable
The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
If you continue to experience problems, contact BankRec Technical Support. Provide the following information:
- the BankRec buyer code for your facility,
- the method you sent in the request (e.g.
GET,POST), - the URL you sent in the request,
- the date/time of the request,
- the response body returned by the server (if any).