Affordability API

The test data that we provide for the Affordability API service has been designed to mimic a real life user. This means that just a like a real user would spend and receive funds throughout the day - our test accounts have been designed to do the same thing. Therefore you should expect to see new transaction records being created throughout the day, and the account balances adjusted accordingly.

🚧

You can use our sandbox environment for free - contact us (via the "help" icon at the bottom of the page) to have your API key activated for Affordability.

📘

Ensure that you pass the institution code AU00000 when using the test accounts

loginId

password

Wentworth-Smith

whislter

POST /users/ea3a81/connections HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN                                           
Content-Type: application/json

{
 "loginId": "Wentworth-Smith",
 "password": "whislter",
 "institution":{
   "id":"AU00000"
 }
}

👍

Once you have created a test connection you can access the Affordability, Income and Expense endpoints for this user. The Affordability endpoint returns links to Income and Expense resources or you can use these endpoints independently without Affordability.

POST /users/{user.id}/affordability HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Did this page help you?