AKakahu
Accounts

List all accounts

Changed on

Get a list of all accounts that the user has connected to your application.

ℹ️

The format for the returned account depends on the permissions you have!

For more details see:

  • 📚 Accessing account data guide
  • 📖 Account model
get/accounts

Request

  • Base URL
    https://api.akahu.io/v1
  • URL
    https://api.akahu.io/v1/accounts
  • Auth
    HTTP bearer

Headers

X-Akahu-Idstring required

Your App ID Token.

Response

Successful response.

successboolean

Example response

{
  "items": [
    {
      "_id": "acc_c01234567890123456789012345",
      "_migrated": "acc_c01234567890123456789012344",
      "_authorisation": "authorisation_c01234567890123456789012345",
      "connection": {
        "_id": "conn_cjgaac5at000001qi2yw8ftil",
        "name": "My Bank",
        "logo": "https://cdn.akahu.nz/logos/connections/conn_cjgaac5at000001qi2yw8ftil",
        "connection_type": "official"
      },
      "name": "Demo Account",
      "status": "ACTIVE",
      "balance": {
        "currency": "NZD",
        "current": 99.9,
        "available": 99.9,
        "limit": 1000
      },
      "type": "CHECKING",
      "attributes": [
        "TRANSACTIONS",
        "PAYMENT_TO",
        "PAYMENT_FROM"
      ],
      "formatted_account": "12-1234-1234567-12",
      "payment_consents": [
        {
          "_id": "consent_c01234567890123456789012345",
          "single_limit": 1000,
          "periodic_limit": {
            "amount": 1000,
            "frequency": "DAILY"
          },
          "payees": [
            {
              "name": "Bilbo Baggins",
              "account_number": "12-1234-1234567-12"
            }
          ]
        }
      ],
      "meta": {
        "holder": "MR DEMO HOLDER & MS DEMO HOLDER",
        "loan_details": {
          "purpose": "HOME",
          "type": "TABLE",
          "interest": {
            "rate": 4.5,
            "type": "FIXED",
            "expires_at": "2021-01-01T12:00:00.000Z"
          },
          "interest_only_expires_at": "2021-01-01T12:00:00.000Z",
          "term": {
            "years": 30,
            "months": 5
          },
          "matures_at": "2021-01-01T12:00:00.000Z",
          "initial_principal": 100000,
          "repayment": {
            "frequency": "MONTHLY",
            "next_date": "2021-01-01T12:00:00.000Z",
            "next_amount": 1000
          }
        }
      },
      "refreshed": {
        "balance": "2021-01-01T12:00:00.000Z",
        "meta": "2021-01-01T12:00:00.000Z",
        "transactions": "2021-01-01T12:00:00.000Z",
        "party": "2021-01-01T12:00:00.000Z"
      }
    }
  ]
}

Changes

  • 52ef70f3df76Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new CHECKING enum value to the // response property for the response status

    • warning

      added the new CREDITCARD enum value to the // response property for the response status

    • warning

      added the new FOREIGN enum value to the // response property for the response status

    • warning

      added the new INVESTMENT enum value to the // response property for the response status

    • warning

      added the new KIWISAVER enum value to the // response property for the response status

    • warning

      added the new PAYMENT_FROM enum value to the /// response property for the response status

    • warning

      added the new PAYMENT_TO enum value to the /// response property for the response status

    • warning

      added the new REWARDS enum value to the // response property for the response status

    • warning

      added the new SAVINGS enum value to the // response property for the response status

    • warning

      added the new TAX enum value to the // response property for the response status

    • warning

      added the new TERMDEPOSIT enum value to the // response property for the response status

    • warning

      added the new WALLET enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the CREDIT CARD enum value from the // response property for the response status

    • info

      removed the DEPOSITORY enum value from the // response property for the response status

    • info

      removed the STATEMENTS enum value from the /// response property for the response status

    • info

      removed the TRANSACTION_EXPORTS enum value from the /// response property for the response status

    • info

      the // response's property pattern ^acc_[a-z0-9]{25,27}$ was added for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status