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:

NameAccount NumberTypeNotes
Demo Checking99-9999-9999999-91CHECKINGA checking account is useful for testing payments
Demo Savings99-9999-9999999-92SAVINGSA savings account that can't make payments
Demo Overdrawn99-9999-9999999-93CHECKINGA checking account that has a negative balance
Demo Kiwisaver99-9999-9999999-94KIWISAVERA 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.

AmountStatusStatus TextNotes
5.02ERRORInternal ErrorAn internal Akahu error
5.03ERRORBank ErrorAn unknown bank error
5.10DECLINEDPayment Limit ExceededAccount going over a Akahu-defined payment limit
5.11DECLINEDAccount Error - Not allowed to make paymentsAccount not having PAYMENT_FROM attribute
5.12DECLINEDAccount Error - Not allowed to make transfersAccount not having TRANSFER_FROM attribute
5.13DECLINEDAccount Error - Not allowed to receive transfersDestination account not having TRANSFER_TO attribute
5.14DECLINEDAccount Error - Not allowed to pay the same account
5.15DECLINEDInsufficient Balance
5.16DECLINEDSingle Amount Exceeded BankPayment will exceed a bank-defined single payment limit
5.17DECLINEDDaily Amount Exceeded BankPayment will exceed a bank-defined daily payment limit
5.18Forces payment into PENDING_APPROVAL state and triggers a MFA payment flow
5.20Sets a 30 second delay on payment processing
5.21CANCELLEDThe payment was cancelled due to the apps configured timeout window passingSets a 30 second delay then cancels the payment

Webhooks

SupportedNot supported
TOKENIDENTITY
ACCOUNTTRANSACTION
PAYMENTINCOME
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.


Did this page help you?