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

# List Bonded Earn allocation states

> Returns the current allocation transitions for the specified account, ordered by when each allocation leaves its current state (soonest first).

A transition is a move to the next state: bonding to earning, exit queue to unbonding, or unbonding to available. Each entry also estimates when the funds become available, which is absent while bonding. For an exit queue entry, the estimate includes the unbonding period. Use it to follow funds after a deallocation.

Use `state` more than once to return several states. Results are paginated.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/allocation-states
openapi: 3.1.0
info:
  title: PWS Public API
  version: '1'
  description: >-
    Integrate with Payward Services to onboard users, manage accounts and funds,
    trade assets, and receive event notifications.
  contact:
    name: Payward Services
servers:
  - url: https://api.sandbox.services.payward.com
security: []
tags:
  - name: Assets
    description: List the assets PWS is willing to swap.
    x-displayName: Assets
  - name: Conversions
    description: >-
      Rule-driven and on-demand fiat ↔ crypto value movement, including
      conversion rules and deposits.
    x-displayName: Conversions
  - name: Auto Earn
    description: >-
      Manage Auto Earn preferences and retrieve allocation and reward
      information.
    x-displayName: Auto Earn
  - name: Bonded Earn
    description: >-
      Allocate funds to and deallocate funds from bonded earn strategies, review
      allocations, and track request status.
    x-displayName: Bonded Earn
  - name: Funding
    description: >-
      Discover deposit and withdrawal options, manage deposit addresses, and
      move funds between accounts.
    x-displayName: Funding
  - name: Derivative transfers
    description: >-
      Move funds between an account's spot balance and the same owner's futures
      balance.
    x-displayName: Derivative transfers
  - name: Portfolio
    description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.'
    x-displayName: Portfolio
  - name: Ramp
    description: >-
      Support Ramp flows with discovery, quotes, limits, and hosted checkout
      experiences.
    x-displayName: Ramp
  - name: Reports
    description: Settlement and reconciliation reports for the partner.
    x-displayName: Reports
  - name: Swaps
    description: Account-funded quotes that lock a price until they expire or are executed.
    x-displayName: Swaps
  - name: Onchain quotes
    description: Wallet-funded quotes that return the data needed to settle onchain.
    x-displayName: Onchain quotes
  - name: Price trigger swaps
    description: Swaps that wait for a target price before submitting a trade.
    x-displayName: Price trigger swaps
  - name: Travel Rule verifications
    description: Travel Rule address ownership verification flows.
    x-displayName: Travel Rule verifications
  - name: Users
    description: >-
      User onboarding and status flows that the partner manages.


      - **Create User** provisions an account-owned user from an external
      reference and optional email.

      - **Get User** retrieves the user's profile, verification status, and
      required actions.


      Use the returned user `id` for calls that require the user's identifier.
    x-displayName: Users
  - name: Verifications
    description: Identity verification (KYC) submission and status for end users.
    x-displayName: Verifications
  - name: Webhooks
    description: >-
      Register HTTPS destinations to receive event deliveries, rotate signing
      secrets, and inspect, update, or delete existing subscriptions. Each
      subscription is owned by the authenticated partner; deliveries are signed
      with HMAC-SHA256 and retried on transient failures.
    x-displayName: Webhooks
paths:
  /v1/accounts/{account_id}/earn/bonded/allocation-states:
    get:
      tags:
        - Bonded Earn
      summary: List Bonded Earn allocation states
      description: >-
        Returns the current allocation transitions for the specified account,
        ordered by when each allocation leaves its current state (soonest
        first).


        A transition is a move to the next state: bonding to earning, exit queue
        to unbonding, or unbonding to available. Each entry also estimates when
        the funds become available, which is absent while bonding. For an exit
        queue entry, the estimate includes the unbonding period. Use it to
        follow funds after a deallocation.


        Use `state` more than once to return several states. Results are
        paginated.
      operationId: listBondedEarnAllocationStates
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - in: query
          name: quote_symbol
          schema:
            description: >-
              Ticker symbol of the quote asset for converted amounts (e.g.,
              "USD", "EUR").
            type: string
            maxLength: 10
            default: USD
          style: form
          example: USD
        - in: query
          name: quote_type
          schema:
            description: Type of the quote asset. Only "fiat" is supported.
            type: string
            maxLength: 16
            default: fiat
          style: form
          example: fiat
        - in: query
          name: strategy_id
          description: Restrict results to one bonded earn strategy.
          required: false
          schema:
            $ref: '#/components/schemas/BondedEarn_BondedStrategyId'
          style: form
          example: ESQEFMZ-JPPIY-3KXFJ2
        - in: query
          name: state
          description: >-
            Restrict results to one or more current allocation states. Omit to
            return all states.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BondedEarn_BondedAllocationTransitionState'
          style: form
          explode: true
          example:
            - bonding
            - unbonding
        - $ref: '#/components/parameters/PageToken'
        - $ref: '#/components/parameters/BondedEarn_PageSize'
      responses:
        '200':
          description: Successful response
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: Allocation transitions for the requested page.
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/BondedEarn_BondedAllocationTransition
                  next_page_token:
                    description: >-
                      Opaque token for retrieving the next page. Absent when
                      there are no more results.
                    type: string
                    minLength: 1
                    maxLength: 256
                  quote_symbol:
                    description: >-
                      Symbol of the quote asset used for converted amounts
                      (e.g., "USD", "EUR").
                    type: string
                  quote_type:
                    description: Type of the quote asset (e.g., "fiat").
                    type: string
                required:
                  - data
                  - quote_symbol
                  - quote_type
              examples:
                allocation-transition:
                  summary: A bonding allocation
                  value:
                    quote_symbol: USD
                    quote_type: fiat
                    data:
                      - strategy_id: ESQEFMZ-JPPIY-3KXFJ2
                        symbol: ETH
                        type: crypto
                        name: Ethereum
                        amount: '2.0'
                        amount_in_quote: '4000.0'
                        state: bonding
                        next_state: earning
                        transitions_at: '2026-06-01T12:00:00Z'
        '400':
          $ref: '#/components/responses/EarnBadRequestResponse'
        '401':
          $ref: '#/components/responses/EarnUnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/EarnForbiddenResponse'
        '404':
          $ref: '#/components/responses/BondedEarnNotEnabledResponse'
        '429':
          $ref: '#/components/responses/EarnResourceExhaustedResponse'
        '500':
          $ref: '#/components/responses/EarnInternalResponse'
        '503':
          $ref: '#/components/responses/EarnUnavailableResponse'
        '504':
          $ref: '#/components/responses/EarnDeadlineExceededResponse'
      security:
        - ApiKey: []
          ApiSign: []
          ApiNonce: []
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      example: WVSD33HRMGSZUBM7
      schema:
        $ref: '#/components/schemas/AccountId'
    PageToken:
      name: page_token
      in: query
      description: >-
        Opaque token returned as `next_page_token` in the previous response.
        Omit to request the first page.
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 256
      style: form
      example: MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4
    BondedEarn_PageSize:
      name: page_size
      in: query
      description: >-
        Maximum number of results to return. Ignored when `page_token` is
        present.
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 25
        default: 20
      style: form
      example: 20
  schemas:
    BondedEarn_BondedStrategyId:
      description: Identifier of the bonded earn strategy.
      type: string
      minLength: 20
      maxLength: 20
      pattern: ^ES[A-Z2-7]{5}-[A-Z2-7]{5}-[A-Z2-7]{6}$
      example: ESQEFMZ-JPPIY-3KXFJ2
    BondedEarn_BondedAllocationTransitionState:
      description: >-
        Lifecycle state with a pending transition. This excludes `earning`,
        unlike `BondedAllocationState`.
      type: string
      enum:
        - bonding
        - exit_queue
        - unbonding
    BondedEarn_BondedAllocationTransition:
      description: One pending lifecycle transition for a bonded earn allocation.
      type: object
      additionalProperties: false
      required:
        - strategy_id
        - symbol
        - type
        - name
        - amount
        - amount_in_quote
        - state
        - transitions_at
      properties:
        strategy_id:
          $ref: '#/components/schemas/BondedEarn_BondedStrategyId'
        symbol:
          description: Ticker symbol of the strategy's asset (e.g., "ETH").
          type: string
        type:
          title: AssetType
          description: Classification of the asset.
          type: string
          enum:
            - fiat
            - crypto
            - xstock
            - stablecoin
            - equity
        name:
          description: Display name of the strategy's asset (e.g., "Ethereum").
          type: string
        amount:
          description: Amount in the strategy's native asset.
          type: string
        amount_in_quote:
          description: Amount converted to the requested quote asset.
          type: string
        state:
          $ref: '#/components/schemas/BondedEarn_BondedAllocationState'
        next_state:
          $ref: '#/components/schemas/BondedEarn_BondedAllocationState'
          description: >-
            State entered when the current state ends. Absent when the
            allocation is released after this transition.
        transitions_at:
          $ref: '#/components/schemas/DateTime'
          description: When the allocation leaves its current state.
        available_at:
          $ref: '#/components/schemas/DateTime'
          description: >-
            When funds become available. For `exit_queue`, this is an estimate
            that includes the following unbonding period. Absent while bonding.
    AccountId:
      description: Globally unique public identifier for an account.
      type: string
      minLength: 14
      maxLength: 42
    BondedEarn_BondedAllocationState:
      description: Lifecycle state of a bonded allocation.
      type: string
      enum:
        - bonding
        - earning
        - exit_queue
        - unbonding
    DateTime:
      description: RFC 3339 timestamp.
      type: string
      format: date-time
    BadRequestError:
      title: Bad Request
      description: Request validation failed or the request could not be processed.
      oneOf:
        - title: Bad Request
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          enum:
                            - bad_request
        - title: Gateway
          description: >-
            Gateway-level validation failure returned before the request reaches
            the service.
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          const: gateway
    UnauthenticatedError:
      title: Unauthenticated
      description: Authentication credentials are missing, invalid, or not accepted.
      oneOf:
        - title: Unauthenticated
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          enum:
                            - unauthenticated
        - title: Gateway
          description: Authentication failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          const: gateway
    ForbiddenError:
      title: Forbidden
      description: The caller is not allowed to perform this operation.
      oneOf:
        - title: Forbidden
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          enum:
                            - forbidden
        - title: Gateway
          description: Authorization failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          const: gateway
    NotFoundError:
      description: The requested resource was not found.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 404
                    code:
                      type: string
                      enum:
                        - not_found
    ResourceExhaustedError:
      description: The request was rate limited or a resource quota was exhausted.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 429
                    code:
                      type: string
                      enum:
                        - resource_exhausted
    InternalError:
      description: An unexpected server-side error occurred.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 500
                    code:
                      type: string
                      enum:
                        - internal
    UnavailableError:
      description: The service is temporarily unavailable.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - unavailable
    DeadlineExceededError:
      description: The request deadline was exceeded before a response could be produced.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 504
                    code:
                      type: string
                      enum:
                        - deadline_exceeded
    PwsValidationErrorEnvelope:
      description: Error envelope for request validation failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsValidationError'
          description: Validation error details.
    PwsValidationError:
      description: Standard PWS API error object for request validation failures.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
        causes:
          description: Validation failures that contributed to the error.
          type: array
          items:
            $ref: '#/components/schemas/PwsErrorCause'
    PwsGeneralErrorEnvelope:
      description: Error envelope for operational or domain failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsGeneralError'
          description: General error details.
    PwsGeneralError:
      description: Standard PWS API error object for non-validation failures.
      allOf:
        - $ref: '#/components/schemas/PwsErrorBase'
        - type: object
          properties:
            causes:
              description: Additional error details, when present.
              type: array
              items:
                type: object
                additionalProperties: true
    PwsErrorCause:
      description: A single request validation failure.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the offending request field.
          type: string
        message:
          description: Human-readable explanation of the failed validation rule.
          type: string
    PwsErrorBase:
      description: Common fields present on every PWS API error object.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
  headers:
    TraceId:
      description: Trace identifier for the request. Include it when contacting support.
      schema:
        type: string
        example: 4bf92f3577b34da6a3ce929d0e0e4736
    StrictTransportSecurity:
      description: Enforces HTTPS for the duration specified by `max-age`.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains; preload
    CacheControl:
      description: Prevents caching of sensitive financial data. Always `no-store`.
      schema:
        type: string
        enum:
          - no-store
        example: no-store
  responses:
    EarnBadRequestResponse:
      description: Validation error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            invalid-request:
              $ref: '#/components/examples/earn-bad-request'
    EarnUnauthenticatedResponse:
      description: Authentication failed
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthenticatedError'
          examples:
            authentication-failed:
              $ref: '#/components/examples/earn-unauthenticated'
    EarnForbiddenResponse:
      description: Permission denied
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
          examples:
            caller-is-not-allowed:
              $ref: '#/components/examples/earn-forbidden'
    BondedEarnNotEnabledResponse:
      description: Bonded earn is not enabled.
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
          examples:
            not-found:
              $ref: '#/components/examples/bonded-earn-not-enabled'
    EarnResourceExhaustedResponse:
      description: Rate limit exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceExhaustedError'
          examples:
            rate-limit-exceeded:
              $ref: '#/components/examples/earn-resource-exhausted'
    EarnInternalResponse:
      description: Internal server error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
          examples:
            internal-error:
              $ref: '#/components/examples/earn-internal'
    EarnUnavailableResponse:
      description: Service unavailable
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnavailableError'
          examples:
            service-unavailable:
              $ref: '#/components/examples/earn-service-unavailable'
    EarnDeadlineExceededResponse:
      description: Deadline exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeadlineExceededError'
          examples:
            request-deadline-exceeded:
              $ref: '#/components/examples/earn-deadline-exceeded'
  examples:
    earn-bad-request:
      summary: Invalid request
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 400
          code: bad_request
          causes:
            - field: account_id
              message: must be a valid account identifier
    earn-unauthenticated:
      summary: Authentication failed
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 401
          code: unauthenticated
    earn-forbidden:
      summary: Caller is not allowed
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 403
          code: forbidden
    bonded-earn-not-enabled:
      summary: Bonded Earn not enabled
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 404
          code: not_found
    earn-resource-exhausted:
      summary: Rate limit exceeded
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 429
          code: resource_exhausted
    earn-internal:
      summary: Internal error
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 500
          code: internal
    earn-service-unavailable:
      summary: Service unavailable
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 503
          code: unavailable
    earn-deadline-exceeded:
      summary: Request deadline exceeded
      value:
        error:
          type: earn_error
          instance: req_01H00000000000000000000000
          status: 504
          code: deadline_exceeded
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: Your public API key. Identifies the partner making the request.
    ApiSign:
      type: apiKey
      in: header
      name: API-Sign
      description: HMAC signature over the request, computed with your private key.
    ApiNonce:
      type: apiKey
      in: header
      name: API-Nonce
      description: Monotonically increasing nonce included in the request signature.

````