Demo Bank
Find out how to use Akahu's Demo Bank to test your integration
For non-production environments, Akahu offers a Demo Bank connection for application development and testing. Demo Bank can be used for both one-off and enduring connections. It is also possible to connect to Demo Bank in MyAkahu for Personal App development.
Demo Bank is useful for testing purposes, however it does not fully mimic the behaviour of live connections. Please check our feature support table to see what functionality is currently available. We strongly recommend that you test your application with real institutions before going live.
Connecting to Demo Bank
There are two ways to connect to Demo Bank:
-
For Personal Apps, you can connect by logging in to MyAkahu, navigating to the "Connections" page, and connecting Demo Bank. After Demo Bank is connected to your Akahu account, you must also select and share specific Demo Bank accounts with your Personal App via the "Developers" page.
-
For Full Apps, you can connect Demo Bank during the Akahu OAuth flow. Demo Bank will only be available as a connection for non-production environments.
When connecting to Demo Bank, you'll be prompted to enter a username and password. You may enter any value into these fields to continue. In order to simulate an incorrect credential error, the password "Password1" can be entered.
The next screen will simulate a multi-factor authentication screen by asking a simple math question. You must answer this question correctly to complete the connection flow.
Feature support
The following features are supported for Demo Bank connections.
| Enduring access | One-off access | |
|---|---|---|
| Account data | ✅ | ✅ |
| Transaction data | ✖️ | ✅ |
| Party (identity) data | ✅ | ✅ |
| Transfers | ✅ | N/A |
| Payments | ✅ | N/A |
| Webhooks | ✅ | N/A |
For further information about using Demo Bank with enduring access features, please see the enduring access section below.
Enduring access
The information below is relevant if you are using Demo Bank connections with enduring access.
Accounts
Demo Bank has 4 static accounts:
| Name | Account Number | Type | Notes |
|---|---|---|---|
| Demo Checking | 99-9999-9999999-91 | CHECKING | A checking account is useful for testing payments |
| Demo Savings | 99-9999-9999999-92 | SAVINGS | A savings account that can't make payments |
| Demo Overdrawn | 99-9999-9999999-93 | CHECKING | A checking account that has a negative balance |
| Demo Kiwisaver | 99-9999-9999999-94 | KIWISAVER | A KiwiSaver account which cannot make payments |
Transactions
Transaction data is not currently supported for Demo Bank accounts connected with enduring access.
Transaction related API endpoints will not return any data for Demo Bank accounts.
Payments
Demo Bank allows you to request payments with specific amounts to simulate various failure states. Payments of amounts not listed in the table below will return successful responses.
The destination account must be a valid NZ bank account number. This means that payment requests where the destination account number is a Demo Bank account number (starting with 99-9999) will be rejected by the API.
| Amount | Status | Status Code | Notes |
|---|---|---|---|
| 5.02 | ERROR | INTERNAL_ERROR | An internal Akahu error |
| 5.03 | ERROR | BANK_ERROR | An unknown bank error |
| 5.10 | DECLINED | AKAHU_LIMIT_EXCEEDED | Amount exceeds an Akahu-defined payment limit |
| 5.11 | DECLINED | INVALID_ACCOUNT | Account doesn't have PAYMENT_FROM attribute (payments only) |
| 5.12 | DECLINED | INVALID_ACCOUNT | Account doesn't have TRANSFER_FROM attribute (transfers only) |
| 5.13 | DECLINED | INVALID_ACCOUNT | Destination account doesn't have TRANSFER_TO attribute (transfers only) |
| 5.14 | DECLINED | INVALID_ACCOUNT | Source and destination are the same account |
| 5.15 | DECLINED | INSUFFICIENT_FUNDS | |
| 5.16 | DECLINED | SINGLE_LIMIT_EXCEEDED | Payment exceeds a bank-defined single payment limit |
| 5.17 | DECLINED | DAILY_LIMIT_EXCEEDED | Payment exceeds a bank-defined daily payment limit |
| 5.18 | PENDING_APPROVAL | N/A | Forces payment into PENDING_APPROVAL state and triggers an MFA payment flow |
| 5.19 | DECLINED | AUTHENTICATION_FAILED | Simulates a failed payment due to Akahu being unable to authenticate with the user's financial institution |
| 5.20 | SENT | N/A | Sets a 30 second delay on payment processing |
| 5.21 | CANCELLED | USER_CANCELLED | Sets a 60 second delay then cancels the payment |
Since these payments are simulated, the source account balance will not change after the payment is made.
Demo Bank does not contain real money.
Transfers
Demo Bank transfers between the static accounts will always be marked SENT, unless you request more than the account "has", in which case it will be marked DECLINED with Status code INSUFFICIENT_FUNDS.
Since these transfers are simulated, the source and destination account balance will not change after the transfer is made.
Demo Bank does not contain real money.
Webhooks
| Supported | Not supported |
|---|---|
| TOKEN | TRANSACTION |
| ACCOUNT | |
| PAYMENT | |
| TRANSFER |
Updated 8 days ago