> ## 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. # Create funding address > Registers a user-added cryptocurrency funding address for the selected account. Set `scope` to exactly one `method_id` or `network_id` returned by the withdrawal-methods endpoint. Supply the crypto destination fields required by that method. The address is validated when it is created. This operation is not idempotent. If a request times out or otherwise has an unknown outcome, list the account's funding addresses before creating another one. ## OpenAPI ````yaml /api-reference/openapi_v3_pws.json post /v1/accounts/{account_id}/funds/addresses 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/addresses: post: tags: - Funds summary: Create funding address description: > Registers a user-added cryptocurrency funding address for the selected account. Set `scope` to exactly one `method_id` or `network_id` returned by the withdrawal-methods endpoint. Supply the crypto destination fields required by that method. The address is validated when it is created. This operation is not idempotent. If a request times out or otherwise has an unknown outcome, list the account's funding addresses before creating another one. operationId: createFundingAddress parameters: - name: account_id in: path required: true description: Public identifier of the account that will own the funding address. example: WVSD33HRMGSZUBM7 schema: type: string minLength: 1 maxLength: 64 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFundingAddressBody' examples: bitcoin: summary: Register a Bitcoin funding address value: scope: method_id: 2fa11f79-eeba-4d4e-afda-029abff6e29e name: My cold wallet address_details: crypto: address: bc1qexampleaddress responses: '200': description: Funding address created successfully. 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/CreateFundingAddressResult' examples: bitcoin: summary: Bitcoin funding address registered value: data: address_id: AB12345-6789A-BCDEFG '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 '409': description: >- The funding method has reached its withdrawal-address limit, an address with the same name (or, for some rails, the same address details) already exists, or the account has an active Global Settings Lock. The `code` field identifies which. 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: oneOf: - $ref: '#/components/schemas/WithdrawalAddressLimitReachedError' title: Withdrawal address limit reached - $ref: '#/components/schemas/WithdrawalAddressAlreadyExistsError' title: Withdrawal address already exists - $ref: >- #/components/schemas/WithdrawalAddressAccountSettingsLockedError title: Account settings locked examples: address-limit-reached: summary: Withdrawal-address limit reached value: error: code: withdrawal_address_limit_reached status: 409 type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b address-already-exists: summary: Withdrawal address already exists value: error: code: withdrawal_address_already_exists status: 409 type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b account-settings-locked: summary: Account settings locked value: error: code: withdrawal_address_account_settings_locked status: 409 type: funding_error instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b '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: [] components: schemas: CreateFundingAddressBody: description: Cryptocurrency funding address to register for the selected account. type: object required: - scope - name - address_details properties: scope: $ref: '#/components/schemas/CreateFundingAddressScope' description: One withdrawal method or network for the saved address. name: description: >- Partner-provided label for the funding address. Must be unique per account. Limited to 64 characters. type: string minLength: 1 maxLength: 64 address_details: $ref: '#/components/schemas/FundingAddressDetails' description: >- Address details, as exactly one fiat bank account or crypto address branch. CreateFundingAddressResult: description: Funding address created for the selected account. type: object required: - data properties: data: $ref: '#/components/schemas/FundingAddress' 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' WithdrawalAddressLimitReachedError: description: >- Withdrawal address cannot be created because the funding method has reached its address limit. type: object required: - error properties: error: $ref: '#/components/schemas/WithdrawalAddressLimitReachedErrorDetail' WithdrawalAddressAlreadyExistsError: description: >- Withdrawal address cannot be created because an address with the same name (or, for some rails, the same address details) already exists for the method's scope. type: object required: - error properties: error: $ref: '#/components/schemas/WithdrawalAddressAlreadyExistsErrorDetail' WithdrawalAddressAccountSettingsLockedError: description: >- Withdrawal address cannot be created because the account has an active Global Settings Lock, which temporarily blocks security-sensitive changes. type: object required: - error properties: error: $ref: >- #/components/schemas/WithdrawalAddressAccountSettingsLockedErrorDetail 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 CreateFundingAddressScope: description: Scope for the new funding address. Supply exactly one identifier. type: object properties: method_id: description: >- Withdrawal method identifier returned by the withdrawal-methods endpoint. type: string format: uuid network_id: description: Network identifier returned by the withdrawal-methods endpoint. type: string format: uuid FundingAddressDetails: description: Crypto details for a user-added funding address. type: object properties: crypto: $ref: '#/components/schemas/FundingCryptoAddress' required: - crypto FundingAddress: description: Stable identifier for a user-added cryptocurrency funding address. type: object required: - address_id properties: address_id: description: Stable identifier for the registered funding address. type: string minLength: 1 maxLength: 64 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 WithdrawalAddressLimitReachedErrorDetail: description: Withdrawal address limit reached error details. type: object required: - type - status - instance - code properties: type: description: Machine-readable error class for the Funding API. type: string enum: - funding_error status: description: HTTP status code returned for this error. type: integer format: int32 enum: - 409 instance: description: Request identifier for this error occurrence. type: string code: enum: - withdrawal_address_limit_reached description: Stable machine-readable error code. type: string doc_url: description: Link to documentation for this error, when available. type: string format: uri WithdrawalAddressAlreadyExistsErrorDetail: description: Withdrawal address already exists error details. type: object required: - type - status - instance - code properties: type: description: Machine-readable error class for the Funding API. type: string enum: - funding_error status: description: HTTP status code returned for this error. type: integer format: int32 enum: - 409 instance: description: Request identifier for this error occurrence. type: string code: enum: - withdrawal_address_already_exists description: Stable machine-readable error code. type: string doc_url: description: Link to documentation for this error, when available. type: string format: uri WithdrawalAddressAccountSettingsLockedErrorDetail: description: Withdrawal address account settings locked error details. type: object required: - type - status - instance - code properties: type: description: Machine-readable error class for the Funding API. type: string enum: - funding_error status: description: HTTP status code returned for this error. type: integer format: int32 enum: - 409 instance: description: Request identifier for this error occurrence. type: string code: enum: - withdrawal_address_account_settings_locked description: Stable machine-readable error code. type: string doc_url: description: Link to documentation for this error, when available. type: string format: uri FundingCryptoAddress: description: Cryptocurrency destination details. type: object required: - address properties: address: description: Cryptocurrency address for the selected scope. type: string minLength: 1 maxLength: 256 tag: description: Destination tag, when required by the selected scope. type: string minLength: 1 maxLength: 64 memo: description: Destination memo, when required by the selected scope. type: string minLength: 1 maxLength: 256 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. ````