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. 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 in a username and password. You may enter value into these fields to continue.
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.
Enduring Consent
If your application is requesting enduring consent in the OAuth flow, the information below is relevant.
Accounts
The 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 |
Payments and Transfers
Demo Bank allows you to request payments and transfers with specific amounts to simulate various failure states. Payments and transfers of amounts not listed in the table below will return successful responses.
Amount | Status | Status Text | Notes |
---|---|---|---|
5.02 | ERROR | Internal Error | An internal Akahu error |
5.03 | ERROR | Bank Error | An unknown bank error |
5.10 | DECLINED | Payment Limit Exceeded | Account going over a Akahu-defined payment limit |
5.11 | DECLINED | Account Error - Not allowed to make payments | Account not having PAYMENT_FROM attribute |
5.12 | DECLINED | Account Error - Not allowed to make transfers | Account not having TRANSFER_FROM attribute |
5.13 | DECLINED | Account Error - Not allowed to receive transfers | Destination account not having TRANSFER_TO attribute |
5.14 | DECLINED | Account Error - Not allowed to pay the same account | |
5.15 | DECLINED | Insufficient Balance | |
5.16 | DECLINED | Single Amount Exceeded Bank | Payment will exceed a bank-defined single payment limit |
5.17 | DECLINED | Daily Amount Exceeded Bank | Payment will exceed a bank-defined daily payment limit |
5.18 | Forces payment into PENDING_APPROVAL state and triggers a MFA payment flow | ||
5.20 | Sets a 30 second delay on payment processing | ||
5.21 | CANCELLED | The payment was cancelled due to the apps configured timeout window passing | Sets a 30 second delay then cancels the payment |
Webhooks
Supported | Not supported |
---|---|
TOKEN | IDENTITY |
ACCOUNT | TRANSACTION |
PAYMENT | INCOME |
TRANSFER |
Identity and parties
Not supported
Transactions
Not supported
Income
Not supported
One-Off Consent
If your application is requesting one-off consent in the OAuth-like flow, Demo Bank will return a mock identity response. The verify name endpoint is also supported.
Updated 16 days ago