> ## 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 withdrawal limits > Returns the selected account's withdrawal limits by funding method for an asset. Use only entries whose `method_id` appears in the withdrawal-methods response for the same account and asset. Limits are point-in-time values and can change before submission. ## OpenAPI ````yaml /api-reference/openapi_v3_pws.json get /v1/accounts/{account_id}/funds/withdrawals/limits/{asset_symbol} 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: 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: '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}/funds/withdrawals/limits/{asset_symbol}: get: tags: - Funds summary: List withdrawal limits description: > Returns the selected account's withdrawal limits by funding method for an asset. Use only entries whose `method_id` appears in the withdrawal-methods response for the same account and asset. Limits are point-in-time values and can change before submission. operationId: listWithdrawalLimits parameters: - name: account_id in: path required: true description: >- Public identifier of the account whose withdrawal limits are returned. example: WVSD33HRMGSZUBM7 schema: type: string minLength: 1 maxLength: 64 - name: asset_symbol in: path required: true description: >- Asset symbol to retrieve withdrawal limits for. Use a symbol returned by the PWS Assets API. example: BTC schema: type: string minLength: 1 maxLength: 16 - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageToken' responses: '200': description: Withdrawal limits for the selected account and asset. 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/WithdrawalLimitsResult' examples: bitcoin: summary: Bitcoin withdrawal limits value: data: - method_id: 2fa11f79-eeba-4d4e-afda-029abff6e29e maximum_amount: symbol: BTC name: Bitcoin type: crypto amount: '0.75' maximum_reason: limits period_limits: - type: amount period: daily period_seconds: 86400 asset: symbol: USD type: fiat remaining: '50000' maximum: '100000' '400': 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: summary: Invalid request value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 400 code: bad_request causes: - field: asset_symbol message: must contain between 1 and 16 characters '401': description: Authentication required 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: summary: Authentication failed value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 401 code: unauthenticated '403': description: Forbidden 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: summary: Caller is not allowed value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 403 code: forbidden '429': 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: summary: Rate limit exceeded value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 429 code: resource_exhausted '500': 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: summary: Internal server error value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 500 code: internal '503': 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: summary: Service unavailable value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 503 code: unavailable '504': description: Request 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: summary: Request deadline exceeded value: error: type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b status: 504 code: deadline_exceeded security: - ApiKey: [] ApiSign: [] ApiNonce: [] x-codeSamples: - lang: bash label: curl source: >- curl -X GET "https://api.services.payward.com/v1/funds/withdrawals/methods/USDC" \ -H "API-Key: $PWS_API_KEY" \ -H "API-Nonce: $PWS_API_NONCE" \ -H "API-Sign: $PWS_API_SIGN" components: parameters: PageSize: name: page_size in: query description: Maximum number of results to return. Defaults to 20 when omitted. required: false schema: type: integer format: int32 minimum: 1 maximum: 25 default: 20 style: form example: 20 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 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 schemas: WithdrawalLimitsResult: description: Account-specific withdrawal limits for the requested asset. type: object required: - data properties: data: description: >- Withdrawal limits by funding method. Empty when no per-method limits are published for the asset. type: array items: $ref: '#/components/schemas/WithdrawalMethodLimits' next_page_token: description: >- Opaque token for retrieving the next page. Absent when there are no more results. type: string minLength: 1 maxLength: 256 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' 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 WithdrawalMethodLimits: description: Account-specific withdrawal limits for one funding method. type: object required: - method_id - maximum_amount - maximum_reason - period_limits properties: method_id: description: Identifier of the funding method these limits apply to. type: string format: uuid maximum_amount: $ref: '#/components/schemas/FundingAmount' description: >- Maximum amount currently allowed after applying available balance, amount-based limits, and the asset's supported decimal precision. A negative maximum is returned as zero. Count-based limits may still prevent another withdrawal. maximum_reason: $ref: '#/components/schemas/WithdrawalMaximumReason' description: Constraint that determined `maximum_amount`. period_limits: description: >- Rolling limits exposed by this API for withdrawals through the method. This list is informational and may not include every policy that applies. Empty when there are no supported limits to report. type: array items: $ref: '#/components/schemas/WithdrawalLimit' 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 FundingAmount: description: Decimal amount denominated in an asset. type: object required: - symbol - type - amount properties: symbol: description: Asset symbol the amount is denominated in. type: string minLength: 1 maxLength: 16 name: description: Human-readable English asset name. type: string minLength: 1 maxLength: 64 type: $ref: '#/components/schemas/AssetType' description: Public asset classification. amount: description: Decimal amount represented as a string to preserve precision. type: string minLength: 1 maxLength: 64 pattern: ^[0-9]+(\.[0-9]+)?$ WithdrawalMaximumReason: description: >- Constraint that determined a method's maximum withdrawal amount. `balance` is the account's available balance, `limits` an amount-based funding limit, and `precision` the largest amount the asset's decimal precision can represent. type: string enum: - balance - limits - precision WithdrawalLimit: description: >- One account-specific limit for withdrawals through a method and rolling time window. type: object required: - type - period - period_seconds - remaining - maximum properties: type: $ref: '#/components/schemas/WithdrawalLimitType' description: Unit controlled by the limit. period: $ref: '#/components/schemas/WithdrawalLimitPeriod' description: Human-readable label for the rolling time window. period_seconds: description: Exact rolling-window duration in seconds. type: integer format: int64 minimum: 1 maximum: 4294967295 asset: $ref: '#/components/schemas/FundingAssetReference' description: >- Asset in which an `amount` limit is denominated. Present for amount limits and omitted for count-based limits. remaining: description: >- Remaining amount or withdrawal count in this rolling window. A negative value means the limit is already exceeded. type: string minLength: 1 maxLength: 64 pattern: ^-?[0-9]+(\.[0-9]+)?$ maximum: description: Maximum amount or withdrawal count allowed in this rolling window. type: string minLength: 1 maxLength: 64 pattern: ^[0-9]+(\.[0-9]+)?$ 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 AssetType: description: Asset classification for portfolio resources. type: string enum: - fiat - crypto - xstock - stablecoin - equity WithdrawalLimitType: description: >- Type of withdrawal limit exposed by this API. Additional withdrawal controls may apply. type: string enum: - amount - withdrawal_attempts - successful_withdrawals WithdrawalLimitPeriod: description: >- Human-readable rolling-window label. `daily`, `weekly`, and `monthly` mean rolling 24-hour, 7-day, and 30-day windows; `custom` uses `period_seconds`. type: string enum: - daily - weekly - monthly - custom FundingAssetReference: description: Reference to an asset by ticker symbol and classification. type: object required: - symbol - type properties: symbol: description: Asset ticker symbol, such as BTC, USD, or TSLAx. type: string minLength: 1 maxLength: 16 type: $ref: '#/components/schemas/AssetType' description: Classification of the asset. 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. ````