> ## 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 account Bonded Earn strategies > Returns the bonded and instant strategies the specified account can allocate into or still holds. Each entry says whether the account can allocate or deallocate now. A strategy the account is no longer eligible for stays listed while it holds funds, so the user can still deallocate. Sorted by asset symbol (A-Z), then unbonding period (shortest first, variable last). Results are paginated. ## OpenAPI ````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/earn/bonded/strategies 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/strategies: get: tags: - Bonded Earn summary: List account Bonded Earn strategies description: >- Returns the bonded and instant strategies the specified account can allocate into or still holds. Each entry says whether the account can allocate or deallocate now. A strategy the account is no longer eligible for stays listed while it holds funds, so the user can still deallocate. Sorted by asset symbol (A-Z), then unbonding period (shortest first, variable last). Results are paginated. operationId: listAccountBondedEarnStrategies parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/BondedEarn_PageSize' - $ref: '#/components/parameters/BondedEarn_StrategyAssetTypeFilter' - $ref: '#/components/parameters/BondedEarn_StrategyYieldSourceFilter' - $ref: '#/components/parameters/BondedEarn_StrategySymbolFilter' 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: Strategies for the specified account and page. type: array items: title: BondedAccountStrategy description: >- Bonded or instant strategy, with the account's eligibility. type: object properties: id: description: >- Strategy identifier, used to allocate and deallocate. type: string strategy_type: $ref: '#/components/schemas/BondedEarn_BondedStrategyType' symbol: description: Asset ticker symbol (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 (e.g., "Ethereum"). type: string yield_source: title: YieldSource description: >- Yield source that backs this strategy (e.g., "staking"). type: string enum: - staking - base_rewards - opt_in_rewards apy: description: >- Annual percentage yield as a decimal string (e.g., "3.41"), combined across reward assets. Gross, before any reward fee. type: string other_assets: description: >- Reward assets other than the strategy's own, each with its share of `apy`. Usually empty. type: array items: title: BondedOtherAssetApy description: >- A reward asset other than the strategy's own, with its share of the APY. type: object properties: symbol: description: Asset ticker symbol (e.g., "EIGEN"). type: string type: title: AssetType description: Classification of the asset. type: string enum: - fiat - crypto - xstock - stablecoin - equity name: description: Display name (e.g., "Eigenlayer"). type: string apy: description: >- This asset's share of the strategy's `apy`, as a decimal string. type: string required: - symbol - type - name - apy bonding_period: $ref: '#/components/schemas/BondedEarn_BondedStrategyPeriod' description: >- Wait after an allocate before the funds start earning. unbonding_period: $ref: '#/components/schemas/BondedEarn_BondedStrategyPeriod' description: >- Wait after the exit queue before a deallocate reaches the account. exit_queue_period: $ref: '#/components/schemas/BondedEarn_BondedStrategyPeriod' description: >- Wait after a deallocate before unbonding starts. Always fixed and accruing. reward_frequency_seconds: description: Seconds between reward payouts. type: integer format: int32 minimum: 0 auto_compound: title: AutoCompound description: Whether rewards are added back to the allocation. type: string enum: - disabled - enabled user_min_allocation: description: >- Smallest amount one allocate may move, in the strategy's asset, as a decimal string. type: string user_cap: description: >- Most the account may allocate, in the strategy's asset, as a decimal string. Absent when unlimited. type: string can_allocate: description: >- Whether the account can allocate into this strategy now. type: boolean can_deallocate: description: >- Whether the account can deallocate from this strategy now. type: boolean fee_schedule: $ref: '#/components/schemas/BondedEarn_BondedFeeSchedule' description: >- Fee taken from this strategy's rewards for this account, by allocated volume. Absent when it cannot be shown as one schedule. required: - id - strategy_type - symbol - type - name - yield_source - apy - other_assets - bonding_period - unbonding_period - exit_queue_period - reward_frequency_seconds - auto_compound - user_min_allocation - can_allocate - can_deallocate next_page_token: description: >- Opaque token for retrieving the next page. Absent when there are no more results. type: string minLength: 1 maxLength: 256 required: - data examples: account-strategies: summary: Bonded and instant strategies for an account value: data: - id: ESDQCOL-WTZEU-NU55QF strategy_type: bonded symbol: ETH type: crypto name: Ethereum yield_source: staking apy: '3.10' other_assets: [] bonding_period: type: fixed seconds: 0 rewards: not_accruing unbonding_period: type: variable seconds: 1209600 rewards: not_accruing exit_queue_period: type: fixed seconds: 0 rewards: accruing reward_frequency_seconds: 604800 auto_compound: enabled user_min_allocation: '0.01' user_cap: '100' can_allocate: true can_deallocate: true fee_schedule: volume_basis: shared_usd tiers: - min_volume: '0' fee_percentage: '25' - min_volume: '1000000' fee_percentage: '20' '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 BondedEarn_StrategyAssetTypeFilter: name: type in: query description: Returns only strategies for assets of the selected types. required: false schema: type: array items: title: AssetType description: Classification of the asset. type: string enum: - fiat - crypto - xstock - stablecoin - equity style: form example: - crypto BondedEarn_StrategyYieldSourceFilter: name: yield_source in: query description: Returns only strategies backed by the selected yield sources. required: false schema: type: array items: title: YieldSource description: Yield source that backs this strategy (e.g., "staking"). type: string enum: - staking - base_rewards - opt_in_rewards style: form example: - staking BondedEarn_StrategySymbolFilter: name: symbol in: query description: >- Returns only strategies for the selected asset ticker symbols. Matching ignores case. required: false schema: type: array items: type: string minLength: 1 style: form example: - ETH 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 schemas: BondedEarn_BondedStrategyType: description: >- Whether the strategy has bonding and unbonding periods (`bonded`) or none (`instant`). type: string enum: - bonded - instant BondedEarn_BondedStrategyPeriod: description: Length of one lock-up phase of a bonded strategy. type: object properties: type: title: PeriodType description: Whether `seconds` is a guarantee or an estimate. type: string enum: - fixed - variable seconds: description: Length of the phase; zero for an instant strategy. type: integer format: int32 minimum: 0 rewards: title: PeriodRewards description: Whether the funds earn rewards during the phase. type: string enum: - accruing - not_accruing required: - type - seconds - rewards BondedEarn_BondedFeeSchedule: description: >- The fee taken from a strategy's rewards, by the account's allocated volume. Each tier is the total fee charged. type: object properties: volume_basis: title: FeeVolumeBasis description: >- What the volume in each tier counts. `strategy` is the account's allocation in this strategy, in the strategy's asset. `shared_usd` is the account's allocation in USD across every strategy on the same fee schedule, not counting funds in the exit queue or unbonding. type: string enum: - strategy - shared_usd tiers: description: Tiers by ascending `min_volume`. The first starts at `"0"`. type: array items: title: BondedFeeTier description: One tier of a fee schedule. type: object properties: min_volume: description: >- Allocation this tier applies from, in the unit `volume_basis` names, as a decimal string. type: string fee_percentage: description: >- Share of each reward taken as a fee, in percentage points as a decimal string (e.g., "15" means 15 percent). type: string required: - min_volume - fee_percentage required: - volume_basis - tiers AccountId: description: Globally unique public identifier for an account. type: string minLength: 14 maxLength: 42 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 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. ````