> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aropay.aro.media/llms.txt
> Use this file to discover all available pages before exploring further.

# Create wallet

> Create a custodial wallet (server-generated EOA, key encrypted at
rest) or register an external watch-only address. For external
wallets pass **either** `address` **or** `nota` (a Notareum address
card), never both. Accounts can hold at most 10 wallets; the first
becomes primary.




## OpenAPI

````yaml /api-reference/openapi.yaml post /wallets
openapi: 3.1.0
info:
  title: AroPay API
  version: 1.0.0
  description: |
    The AroPay API for orchestrating sealed, private payments on public
    ledgers, built on the Aro Confidential Rails (Zama Protocol FHE). The
    current deployment is an MVP sandbox for B2B users on Ethereum Sepolia,
    with Mainnet to follow.

    Every response (except the flat Sandbox probes)
    uses the shared envelope: `{ "ok": true, "data": … }` on success and
    `{ "ok": false, "error": { "code", "message", "details?" } }` on failure.

    Amounts are decimal strings in human units (e.g. `"125.50"`). Write
    requests must send `Content-Type: application/json`.
  contact:
    name: Aro Media
    url: https://aro.media
servers:
  - url: https://aropay.aro.media/api/v1
    description: Sandbox
  - url: http://aropay.localhost:3000/api/v1
    description: Local development
security:
  - apiKeyAuth: []
  - sessionCookie: []
tags:
  - name: Auth
    description: Password, TOTP, and passkey login; session inspection and logout.
  - name: Profile & security
    description: Profile, password, two-factor authentication, and passkey management.
    x-group: Profile & security
  - name: API keys
    description: Programmatic credentials. Creation and revocation are session-only.
  - name: Wallets
    description: Custodial and external (watch-only) wallets.
  - name: Balances
    description: Balance triples and lightweight gas reads.
  - name: Money movement
    description: Faucet funding, minting, transfers, and redemptions.
  - name: Transactions
    description: History, single-transaction reads, and notarized receipts.
  - name: Sandbox
    description: Unauthenticated status and echo probes with a flat response shape.
paths:
  /wallets:
    post:
      tags:
        - Wallets
      summary: Create wallet
      description: |
        Create a custodial wallet (server-generated EOA, key encrypted at
        rest) or register an external watch-only address. For external
        wallets pass **either** `address` **or** `nota` (a Notareum address
        card), never both. Accounts can hold at most 10 wallets; the first
        becomes primary.
      operationId: createWallet
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: Custodial
                  required:
                    - type
                  properties:
                    type:
                      const: custodial
                    label:
                      type: string
                      description: Optional display label.
                - type: object
                  title: External (raw address)
                  required:
                    - type
                    - address
                  properties:
                    type:
                      const: external
                    address:
                      type: string
                      pattern: ^0x[a-fA-F0-9]{40}$
                      description: The address to watch. Stored EIP-55 checksummed.
                    label:
                      type: string
                - type: object
                  title: External (.nota address card)
                  required:
                    - type
                    - nota
                  properties:
                    type:
                      const: external
                    nota:
                      type: string
                      description: Contents of a Notareum address-card `.nota` file.
                    label:
                      type: string
            examples:
              custodial:
                summary: Custodial wallet
                value:
                  type: custodial
                  label: Payouts
              external:
                summary: External (watch-only) wallet
                value:
                  type: external
                  address: '0x8Ba1f109551bD432803012645Ac136ddd64DBA72'
                  label: Ops multisig
      responses:
        '201':
          description: Wallet created or registered.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                properties:
                  ok:
                    const: true
                  data:
                    type: object
                    required:
                      - wallet
                    properties:
                      wallet:
                        $ref: '#/components/schemas/Wallet'
        '400':
          description: Validation failure, wrong-chain nota, or wallet limit reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                ok: false
                error:
                  code: wallet_limit_reached
                  message: You already have 10 wallets.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountDisabled'
        '409':
          description: Address already registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                ok: false
                error:
                  code: wallet_exists
                  message: This address is already registered in the sandbox.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    Wallet:
      type: object
      description: A custodial or external (watch-only) wallet.
      required:
        - id
        - address
        - type
        - label
        - isPrimary
        - createdAt
      properties:
        id:
          type: string
          examples:
            - ckwlt0001abcd
        address:
          type: string
          description: EIP-55 checksummed address.
          examples:
            - '0x8Ba1f109551bD432803012645Ac136ddd64DBA72'
        type:
          type: string
          enum:
            - CUSTODIAL
            - EXTERNAL
          description: >-
            Custodial wallets can spend through the sandbox; external wallets
            are watch-only.
        label:
          type:
            - string
            - 'null'
        isPrimary:
          type: boolean
          description: The account's first wallet becomes primary.
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      description: The shared failure envelope.
      required:
        - ok
        - error
      properties:
        ok:
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code; match on this, not `message`.
            message:
              type: string
            details:
              description: Structured context, e.g. per-field validation issues.
  responses:
    Unauthorized:
      description: Missing or invalid credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error:
              code: invalid_api_key
              message: Invalid API key.
    AccountDisabled:
      description: The account has been deactivated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error:
              code: account_disabled
              message: This account is disabled.
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error:
              code: rate_limited
              message: Too many requests. Try again shortly.
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            ok: false
            error:
              code: internal_error
              message: An unexpected error occurred.
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: aro_sk_…
      description: |
        AroPay API key, sent as `Authorization: Bearer aro_sk_…`. Created in
        the dashboard under Settings → API keys. Takes precedence over a
        session cookie when both are present.
      x-default: aro_sk_your_key_here
    sessionCookie:
      type: apiKey
      in: cookie
      name: aropay_session
      description: |
        Browser session cookie minted by `POST /auth/login` (or passkey
        login). httpOnly, `SameSite=Lax`, 24 h TTL. Endpoints marked
        **Session-only** accept only this credential and return
        `403 session_required` for API keys.

````