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

# List Account Movements

> Paginated ledger history for one settlement account and its sub-accounts, newest first. The path accepts either the account id or the reference you gave it. Amounts are exact decimal strings.



## OpenAPI

````yaml /openapi.yaml get /accounts/{accountId}/movement
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: ZBX Merchants API
  version: '1.0'
servers:
  - url: https://mapi.zbx.boomfi.xyz/v1
    description: Production
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: Bank Address Book
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner virtual account automations and run history
    name: Partner Automations
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - description: Tradeable currencies, instruments, and swap targets
    name: Instruments
  - description: RFQ quotes
    name: Quotes
  - description: RFQ orders and one-click trades
    name: Orders
  - description: Executed trades
    name: Trades
paths:
  /accounts/{accountId}/movement:
    get:
      tags:
        - Accounts
      summary: List Account Movements
      description: >-
        Paginated ledger history for one settlement account and its
        sub-accounts, newest first. The path accepts either the account id or
        the reference you gave it. Amounts are exact decimal strings.
      parameters:
        - description: Settlement account id or merchant reference
          in: path
          name: accountId
          required: true
          schema:
            type: string
        - description: Page size. Defaults to 100. Minimum 1, maximum 100.
          example: 20
          in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - description: Page number (1-based). Defaults to 1.
          example: 1
          in: query
          name: page
          schema:
            type: integer
            minimum: 1
        - description: >-
            Inclusive lower bound on created_at (RFC3339). When set, results are
            sorted by created_at.
          example: '2024-01-01T00:00:00.000Z'
          in: query
          name: since
          schema:
            type: string
            format: date-time
        - description: >-
            Sort direction for the primary list key (created_at when since/until
            are set, otherwise id). Defaults to desc.
          example: desc
          in: query
          name: sort
          schema:
            type: string
            enum:
              - asc
              - desc
        - description: >-
            Inclusive upper bound on created_at (RFC3339). When set, results are
            sorted by created_at.
          example: '2024-12-31T23:59:59.000Z'
          in: query
          name: until
          schema:
            type: string
            format: date-time
        - description: >-
            Target sub-merchant organisation ID. Required for partner-delegated
            requests, which must be signed with the partner secret.
          in: header
          name: X-ORG-ID
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal.PaginatedResponse-accounts_MovementResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    internal.PaginatedResponse-accounts_MovementResponse:
      properties:
        data:
          allOf:
            - $ref: >-
                #/components/schemas/internal.PaginatedItems-accounts_MovementResponse
          description: Paginated payload.
        error:
          description: True when the request failed.
          type: boolean
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    internal.PaginatedItems-accounts_MovementResponse:
      properties:
        items:
          description: Items in the current page.
          items:
            $ref: '#/components/schemas/accounts.MovementResponse'
          type: array
        last_update:
          description: >-
            Timestamp of the most recently updated item in the result set, when
            available.
          example: '2021-01-01T00:00:00.000Z'
          type: string
        next:
          description: Next page number to request, when more results exist.
          example: 10
          type: integer
        total:
          description: Total number of matching items across all pages.
          example: 10
          type: integer
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    accounts.MovementResponse:
      properties:
        account_id:
          description: >-
            Settlement account this movement was booked against. Equal to the
            requested

            account, or one of its sub-accounts.
          type: integer
        account_reference:
          description: Merchant-defined reference of that account, when it has one.
          type: string
        amount:
          description: Amount moved, in Currency.
          type: string
        chain:
          allOf:
            - $ref: '#/components/schemas/accounts.ChainResponse'
          description: Blockchain chain details, for an on-chain movement.
        confirmed_at:
          description: >-
            When the movement was confirmed externally (RFC3339), once it has
            been.
          type: string
        created_at:
          description: When the movement was recorded (RFC3339).
          type: string
        currency:
          description: Currency code of Amount.
          type: string
        direction:
          description: 'Direction relative to the account: IN or OUT.'
          type: string
        entity_id:
          description: >-
            Identifier of the object that caused this movement, such as a
            payment

            (pay_...). Absent when the cause is an internal operation.
          type: string
        fee:
          description: Fee charged on top of Amount, when any.
          type: string
        fee_currency:
          description: >-
            Currency code of Fee, which may differ from Currency (gas is paid in
            the

            chain's native asset).
          type: string
        from_address:
          description: >-
            Counterparty address funds came from, for an inbound on-chain
            movement.
          type: string
        id:
          description: Unique resource identifier.
          type: integer
        status:
          description: |-
            Lifecycle state: Pending, Processing, Confirmed, Failed, Refunded or
            PartialRefunded.
          type: string
        to_address:
          description: >-
            Counterparty address funds went to, for an outbound on-chain
            movement.
          type: string
        transaction_hash:
          description: On-chain transaction hash, once broadcast.
          type: string
        type:
          description: >-
            What the movement represents: Deposit, Withdraw, Transfer, Swap,
            NetworkFee,

            ServiceFee or Adjustment.
          type: string
      type: object
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
    accounts.ChainResponse:
      properties:
        id:
          description: Unique resource identifier.
          type: integer
        name:
          description: Display name.
          type: string
        native_currency_symbol:
          description: Native gas token symbol for the chain.
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey

````