> ## 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 quote limits > Returns the effective amount limits for a swap on the selected account. Limits reflect current liquidity and trading constraints. They are a point-in-time estimate and can change before a quote is created. When available, `limit_reasons` explains which constraints contributed to `maximum`. Set `amount_side` to the side whose amount the partner will fix when creating a quote. The returned asset and amounts are denominated in that side's asset. Clamp create-quote amounts to `[minimum_swap, maximum]`. Amount-too-large/small errors apply to create quote, not to this discovery call. Dust-only floors are intentionally not exposed here and may be added later for dust-sweep flows. ## OpenAPI ````yaml /api-reference/openapi_v3_pws.json get /v1/accounts/{account_id}/quotes/limits 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: One-off conversions from an account balance to a wallet destination. - name: Earn description: >- Manage auto-earn preferences and retrieve allocation and reward information. - name: Funds description: >- Deposits, withdrawals, addresses, methods, and the consolidated funding-transactions ledger. - 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: End-user portfolio summary, history, and transaction views. - 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}/quotes/limits: get: tags: - Swaps summary: Get quote limits description: >- Returns the effective amount limits for a swap on the selected account. Limits reflect current liquidity and trading constraints. They are a point-in-time estimate and can change before a quote is created. When available, `limit_reasons` explains which constraints contributed to `maximum`. Set `amount_side` to the side whose amount the partner will fix when creating a quote. The returned asset and amounts are denominated in that side's asset. Clamp create-quote amounts to `[minimum_swap, maximum]`. Amount-too-large/small errors apply to create quote, not to this discovery call. Dust-only floors are intentionally not exposed here and may be added later for dust-sweep flows. operationId: getQuoteLimits parameters: - $ref: '#/components/parameters/AccountIdPath' - in: query name: from_symbol required: true description: Source asset ticker symbol. schema: type: string minLength: 1 maxLength: 16 example: USD style: form - in: query name: from_type required: true description: Classification of the source asset. schema: type: string enum: - fiat - crypto - stablecoin - xstock example: fiat style: form - in: query name: to_symbol required: true description: Destination asset ticker symbol. schema: type: string minLength: 1 maxLength: 16 example: ETH style: form - in: query name: to_type required: true description: Classification of the destination asset. schema: type: string enum: - fiat - crypto - stablecoin - xstock example: crypto style: form - in: query name: amount_side required: true description: >- Side whose amount will be fixed when creating the quote and whose asset denominates the returned limits. schema: type: string enum: - from - to example: from style: form responses: '200': description: Successful response content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/QuoteLimits' required: - data examples: fixed-source-limits: summary: Limits for a fixed source amount value: data: asset: symbol: USD type: fiat minimum_swap: '1' maximum: '150000' precision: 2 limit_reasons: - liquidity headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/UnauthenticatedErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' Retry-After: $ref: '#/components/headers/RetryAfter' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '503': description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' '504': description: Deadline exceeded content: application/json: schema: $ref: '#/components/schemas/DeadlineExceededErrorResponse' headers: Request-Id: $ref: '#/components/headers/RequestId' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Strict-Transport-Security: $ref: '#/components/headers/StrictTransportSecurity' X-Content-Type-Options: $ref: '#/components/headers/XContentTypeOptions' Content-Security-Policy: $ref: '#/components/headers/ContentSecurityPolicy' Cache-Control: $ref: '#/components/headers/CacheControl' security: - ApiKey: [] ApiSign: [] ApiNonce: [] x-codeSamples: - lang: bash label: curl source: >- curl -X GET "https://api.services.payward.com/v1/accounts/W4BE9868GY65TB6523/quotes/limits?from_symbol=USD&from_type=fiat&to_symbol=ETH&to_type=crypto&amount_side=from" \ -H "API-Key: $PWS_API_KEY" \ -H "API-Nonce: $PWS_API_NONCE" \ -H "API-Sign: $PWS_API_SIGN" components: parameters: AccountIdPath: in: path name: account_id required: true description: >- ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. schema: $ref: '#/components/schemas/AccountId' example: W4BE9868GY65TB6523 schemas: QuoteLimits: description: >- Effective point-in-time create-quote limits for the selected amount side. Dust-only minimums are not exposed; a dust-sweep-specific floor may be added later. type: object properties: asset: description: Asset that denominates the returned amounts. allOf: - $ref: '#/components/schemas/AssetRef' minimum_swap: description: >- Smallest amount that can be submitted on create quote for a normal swap. Partners should clamp create-quote amounts to `[minimum_swap, maximum]`. type: string maxLength: 64 pattern: ^[0-9]+(\.[0-9]+)?$ maximum: description: >- Largest amount currently available after applying liquidity and other trading constraints. type: string maxLength: 64 pattern: ^[0-9]+(\.[0-9]+)?$ precision: description: >- Maximum number of decimal places supported for ordinary tradable amounts. type: integer format: int32 minimum: 0 limit_reasons: description: >- Constraints that contributed to `maximum`, ordered by binding priority. Omitted when the upstream calculator does not report reasons. type: array uniqueItems: true items: $ref: '#/components/schemas/QuoteLimitReason' required: - asset - minimum_swap - maximum - precision ValidationErrorResponse: description: The request was rejected because the client supplied invalid input. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 400 instance: type: string code: type: string enum: - bad_request doc_url: type: string format: uri causes: type: array items: $ref: '#/components/schemas/ValidationCause' required: - type - status - instance - code required: - error UnauthenticatedErrorResponse: description: Authentication credentials were missing or invalid. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 401 instance: type: string code: type: string enum: - unauthenticated doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error ForbiddenErrorResponse: description: The caller is not allowed to perform this operation. oneOf: - title: Forbidden type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 403 instance: type: string code: type: string enum: - forbidden doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error - $ref: '#/components/schemas/GatewayError' RateLimitErrorResponse: description: The request rate limit was exceeded. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 429 instance: type: string code: type: string enum: - resource_exhausted doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error InternalErrorResponse: description: An internal server error occurred. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 500 instance: type: string code: type: string enum: - internal doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error ServiceUnavailableErrorResponse: description: The service is temporarily unavailable. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 503 instance: type: string code: type: string enum: - unavailable doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error DeadlineExceededErrorResponse: description: The upstream request deadline was exceeded. type: object properties: error: description: Error details. type: object properties: type: type: string status: type: integer format: int32 enum: - 504 instance: type: string code: type: string enum: - deadline_exceeded doc_url: type: string format: uri causes: type: array items: type: object additionalProperties: true required: - type - status - instance - code required: - error AccountId: type: string description: Canonical identifier for an account in the Payward public API. minLength: 14 maxLength: 42 AssetRef: description: Reference to an asset by its ticker symbol and classification. type: object properties: symbol: description: Asset ticker symbol (e.g. "BTC", "USD", "TSLAx"). type: string type: description: Classification of the asset. type: string enum: - fiat - crypto - stablecoin - equity - xstock required: - symbol - type QuoteLimitReason: description: >- Constraint that contributed to the returned `maximum`. Reasons are ordered by binding priority; the first value is the primary constraint when multiple apply. `other` covers internal or uncommon constraints not otherwise listed (for example funding-rail or equity-transfer caps). type: string enum: - user_balance - liquidity - other ValidationCause: description: One failed field-level validation rule. type: object 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 required: - field - message 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 headers: RequestId: description: >- Unique identifier for tracing this request across services. Include in support tickets. schema: type: string format: uuid example: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b RateLimitLimit: description: Total requests allowed in the current window. schema: type: integer example: 1000 RateLimitRemaining: description: Requests remaining in the current window. schema: type: integer example: 955 RateLimitReset: description: Unix timestamp (seconds) when the rate-limit window resets. schema: type: integer format: int64 example: 1713182400 StrictTransportSecurity: description: >- Enforces HTTPS for the configured period. Always `max-age=63072000; includeSubDomains; preload`. schema: type: string example: max-age=63072000; includeSubDomains; preload XContentTypeOptions: description: Disables MIME sniffing. Always `nosniff`. schema: type: string enum: - nosniff example: nosniff ContentSecurityPolicy: description: >- Prevents embedding and resource loading. Always `default-src 'none'; frame-ancestors 'none'`. schema: type: string example: default-src 'none'; frame-ancestors 'none' CacheControl: description: Prevents caching of sensitive financial data. Always `no-store`. schema: type: string enum: - no-store example: no-store RetryAfter: description: Seconds the client should wait before retrying. schema: type: integer example: 30 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. ````