List user accounts

POST /account/list
Api key auth

Retrieve a list of all accounts associated with the authenticated user. Returns account details including balances, currencies, and status.

application/json

Body Required

  • data object Required

    The actual request data to be processed

  • signature string Required

    ed25519 signature of the data, signed with user's private key

  • publicKey string Required

    User's derived public key for signature verification

  • timestamp integer Required

    Unix timestamp when the request was created (milliseconds)

  • nonce string Required

    Unique nonce to prevent replay attacks

Responses

  • 200 application/json

    Accounts retrieved successfully

    Hide response attributes Show response attributes object
    • success boolean
    • accounts array[object]
      Hide accounts attributes Show accounts attributes object
      • id string

        Unique account identifier

      • name string

        Account name

      • type string

        Account type

        Values are checking, savings, business, or escrow.

      • currency string

        Account currency code

      • balance number

        Current account balance

      • availableBalance number

        Available balance (excluding holds)

      • status string

        Account status

        Values are active, inactive, suspended, or closed.

      • createdAt string(date-time)

        When the account was created

      • lastActivity string(date-time)

        Last activity on the account

    • totalCount integer

      Total number of accounts
  • 401

    Authentication failed

  • 429

    Rate limit exceeded

  • 500

    Internal server error

POST /account/list 
curl \
 --request POST 'https://pay-api.aiic.nz/v1/account/list' \
 --header "X-Public-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{},"signature":"base64-encoded-signature","publicKey":"base64-encoded-public-key","timestamp":1703123456789,"nonce":"abc123-def456-ghi789"}'
Request examples 
{
  "data": {},
  "signature": "base64-encoded-signature",
  "publicKey": "base64-encoded-public-key",
  "timestamp": 1703123456789,
  "nonce": "abc123-def456-ghi789"
}
Response examples (200) 
{
  "success": true,
  "accounts": [
    {
      "id": "acc_123",
      "name": "Main Account",
      "type": "checking",
      "currency": "NZD",
      "balance": 5000,
      "availableBalance": 4500,
      "status": "active",
      "createdAt": "2025-05-04T09:42:00Z",
      "lastActivity": "2025-05-04T09:42:00Z"
    }
  ],
  "totalCount": 3
}