> ## 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. # Get bonded earn request status > Returns the status of one allocate or deallocate request of the specified account. A request that failed is still returned successfully: its outcome is carried in the `status` and `error` fields of the response, not as an error response. A failed request keeps its `Idempotency-Key`, so retry with a new key. A completed request is kept for at least 24 hours. After that its identifier is not found, and its `Idempotency-Key` can be used again. ## OpenAPI ````yaml /api-reference/openapi_v3_pws.json get /v1/accounts/{account_id}/earn/bonded/requests/{request_id} openapi: 3.1.0 info: title: Payward Services API description: >- The Payward Services (PWS) public API. PWS exposes Swaps (institutional FX-style trading), Conversion rules (rule-driven fiat ↔ crypto value movement), retail-style Quotes and Price Trigger Swaps, end-user Users / Verifications, Travel Rule address ownership verification, Funds (deposits, withdrawals, addresses, transactions), Portfolio, Earn, Reports, Webhooks, and Ramp (hosted fiat-to-crypto on-ramp checkout). All requests must be authenticated. All monetary values are decimal strings; all timestamps are ISO 8601 UTC. List endpoints are cursor-paginated. Errors follow a uniform shape (see `*ErrorResponse` schemas). version: v1 contact: name: Payward Services API Support url: https://docs.payward.com email: api-support@payward.com servers: - url: https://api.services.payward.com description: Production security: - ApiKey: [] ApiSign: [] ApiNonce: [] tags: - name: Users description: >- User onboarding and status flows that the partner manages. - **Create User** provisions a user with an email and external reference. - **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. - name: Assets description: >- Catalog of assets available on the platform with retail-display metadata (logos, market data, descriptions). - name: Conversion rules x-group: Users description: >- Rule-driven fiat ↔ crypto value movement, including conversion rules and deposits. - name: On-demand conversions x-group: Users description: >- On-demand conversions between bank accounts and account balances, or from account balances to wallets. - name: Earn description: >- Manage Auto Earn preferences and retrieve allocation and reward information. - name: Bonded earn description: >- Allocate funds to and deallocate funds from bonded earn strategies, review allocations, and track request status. - name: Funds description: >- Deposits, withdrawals, addresses, methods, and the consolidated funding-transactions ledger. - name: Derivative transfers description: Move funds between an account's spot and futures balances. - name: Bank links description: >- Link US bank accounts to an account through a Kraken-hosted widget, then reference them for money movement. Two resources model a connection: - A **Bank Link** is the connection between one account and one banking institution. Create it to get a hosted-widget URL, and send the user there to choose their institution and approve access. One account can hold many Bank Links. - An **Account Link** is one bank account (a checking account, for example) that the user shared through that connection. One Bank Link owns one or more Account Links. Use `account_link_id` to reference the bank account when you move money. Both ids are opaque handles. Provider identifiers, access tokens, owner names, and raw bank numbers are never exposed. Eligibility is evaluated on every read, and ownership must match: the bank account's holder must match the account's verified holder. An account that fails ownership validation reports `ineligible` with the reason `name_mismatch`. Unlinking is permanent. Linking the same bank account again creates a new Bank Link and a new `account_link_id`; old ids stay valid only for reading history. - name: Portfolio description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.' - name: Price trigger swaps description: Limit-style orders that execute when a configured price trigger is met. - name: On-chain swaps description: >- Wallet-funded onchain quote trading for xStock and USDC pairs. On-chain quotes settle on-chain through the Payward on-chain proxy contract. - name: Ramp description: >- Hosted fiat-to-crypto on-ramp checkout: country / fiat / payment-method / cryptocurrency-asset discovery, transaction limits and prospective quotes, and the hosted checkout URL. - name: Reports description: Settlement and reconciliation reports for the partner. - name: Swaps description: >- Direct partner-to-Payward swap quotes and executions (institutional FX-style trading). - name: Travel Rule verifications description: Travel Rule address ownership verification flows. - name: Verifications description: Identity verification (KYC) submission and status for end users. - name: Webhooks description: Manage webhook subscriptions for asynchronous event delivery. paths: /v1/accounts/{account_id}/earn/bonded/requests/{request_id}: get: tags: - Bonded earn summary: Get bonded earn request status description: >- Returns the status of one allocate or deallocate request of the specified account. A request that failed is still returned successfully: its outcome is carried in the `status` and `error` fields of the response, not as an error response. A failed request keeps its `Idempotency-Key`, so retry with a new key. A completed request is kept for at least 24 hours. After that its identifier is not found, and its `Idempotency-Key` can be used again. operationId: getBondedEarnRequestStatus parameters: - in: path name: account_id required: true schema: description: Globally unique public identifier for an account. type: string minLength: 14 maxLength: 42 x-selected-account: true style: simple example: WVSD33HRMGSZUBM7 - in: path name: request_id required: true schema: description: >- Identifier of an allocate or deallocate request, as returned when the request was submitted or listed. type: string minLength: 1 maxLength: 64 style: simple example: EBARERNY-PXH3CV-XQJL2O responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/BondedRequestStatus' required: - data examples: succeeded: summary: Allocation succeeded value: data: id: EBARERNY-PXH3CV-XQJL2O idempotency_key: 11111111-1111-4111-8111-111111111111 request_type: allocate strategy_id: ESQEFMZ-JPPIY-3KXFJ2 symbol: ETH type: crypto name: Ethereum strategy_type: bonded amount: '2.0' status: succeeded created_at: '2026-06-01T12:00:00Z' completed_at: '2026-06-01T12:00:05Z' failed: summary: Allocation failed value: data: id: EBARERNY-PXH3CV-XQJL2O idempotency_key: 11111111-1111-4111-8111-111111111111 request_type: allocate strategy_id: ESQEFMZ-JPPIY-3KXFJ2 symbol: ETH type: crypto name: Ethereum strategy_type: bonded amount: '2.0' status: failed created_at: '2026-06-01T12:00:00Z' completed_at: '2026-06-01T12:00:05Z' error: reason: insufficient_balance message: >- The account balance is insufficient for this allocation. '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestError' examples: invalid-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 headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedError' examples: authentication-failed: summary: Authentication failed value: error: type: earn_error instance: req_01H00000000000000000000000 status: 401 code: unauthenticated headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' examples: caller-is-not-allowed: summary: Caller is not allowed value: error: type: earn_error instance: req_01H00000000000000000000000 status: 403 code: forbidden headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/EarnNotFoundErrorResponse' examples: not-found: summary: Strategy or request not found value: error: type: earn_error instance: req_01H00000000000000000000000 status: 404 code: not_found headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ResourceExhaustedError' examples: rate-limit-exceeded: summary: Rate limit exceeded value: error: type: earn_error instance: req_01H00000000000000000000000 status: 429 code: resource_exhausted headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalError' examples: internal-error: summary: Internal error value: error: type: earn_error instance: req_01H00000000000000000000000 status: 500 code: internal headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/UnavailableError' examples: service-unavailable: summary: Service unavailable value: error: type: earn_error instance: req_01H00000000000000000000000 status: 503 code: unavailable headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' '504': description: Deadline exceeded content: application/json: schema: $ref: '#/components/schemas/DeadlineExceededError' examples: request-deadline-exceeded: summary: Request deadline exceeded value: error: type: earn_error instance: req_01H00000000000000000000000 status: 504 code: deadline_exceeded headers: X-Trace-Id: $ref: '#/components/headers/TraceId' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' Cache-Control: $ref: '#/components/headers/CacheControl' security: - ApiKey: [] ApiSign: [] ApiNonce: [] components: schemas: BondedRequestStatus: description: State of one allocate or deallocate request. type: object additionalProperties: false required: - id - idempotency_key - request_type - strategy_id - symbol - type - name - strategy_type - amount - status - created_at properties: id: description: Identifier of the request. type: string idempotency_key: description: >- The `Idempotency-Key` sent when the request was submitted, echoed back so clients can reconcile their own request log. type: string request_type: description: >- Whether the request allocates funds into the strategy or deallocates funds from it. type: string enum: - allocate - deallocate strategy_id: $ref: '#/components/schemas/BondedStrategyId' symbol: description: Ticker symbol of the strategy's asset (e.g., "ETH"). type: string type: 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 strategy_type: $ref: '#/components/schemas/BondedStrategyType' amount: description: >- Amount the request asked for, in the strategy's asset, exactly as submitted. The settled amount can differ once it is rounded to the asset's own precision. type: string status: description: >- Current status of the request. `pending` requests have not been processed yet; `succeeded` and `failed` are final. type: string enum: - pending - succeeded - failed created_at: $ref: '#/components/schemas/DateTime' completed_at: $ref: '#/components/schemas/DateTime' error: $ref: '#/components/schemas/BondedRequestFailure' BadRequestError: description: Request validation failed or the request could not be processed. 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 enum: - 400 code: type: string enum: - bad_request UnauthenticatedError: description: Authentication credentials are missing, invalid, or not accepted. 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 enum: - 401 code: type: string enum: - unauthenticated ForbiddenError: 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 enum: - 403 code: type: string enum: - forbidden - $ref: '#/components/schemas/GatewayError' EarnNotFoundErrorResponse: 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 enum: - 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 enum: - 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 enum: - 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 enum: - 503 code: type: string enum: - unavailable DeadlineExceededError: description: The upstream service did not complete the request before the deadline. 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 enum: - 504 code: type: string enum: - deadline_exceeded 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 BondedStrategyType: description: >- Whether the strategy has bonding and unbonding periods (`bonded`) or none (`instant`). type: string enum: - bonded - instant DateTime: type: string format: date-time description: An RFC 3339 datetime example: '2023-03-13T12:34:56Z' BondedRequestFailure: description: Details of why a request failed. type: object additionalProperties: false required: - reason - message properties: reason: description: >- Machine-readable failure reason. A deallocation can also return `insufficient_balance` when the request is submitted, with the same string. An allocation reports it only here. Other known values are `above_user_cap`, `not_eligible`, `canceled`, and `internal`. New values may be added, so treat an unknown value as a generic failure. type: string message: description: >- Human-readable explanation of the failure, for display and support. Branch on `reason` rather than on this text. type: string 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 GatewayError: title: Gateway type: object required: - error properties: error: type: object required: - type - status - code properties: type: type: string const: service_error status: type: integer format: int32 const: 403 code: type: string const: gateway 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 configured period. Always `max-age=63072000; includeSubDomains; preload`. schema: type: string example: max-age=63072000; includeSubDomains; preload CacheControl: description: Prevents caching of sensitive financial data. Always `no-store`. schema: type: string enum: - no-store example: no-store securitySchemes: ApiKey: type: apiKey name: API-Key in: header description: Your public API key. Identifies the partner making the request. ApiSign: type: apiKey name: API-Sign in: header description: HMAC signature over the request, computed with your private key. ApiNonce: type: apiKey name: API-Nonce in: header description: Monotonically increasing nonce included in the request signature. ````