# Payward Developer Documentation

## Docs

- [Payward Services](https://docs.services.payward.com/index.md): Built on 15 years of Kraken operations, Payward Services provides one integration replacing fragmented multi-vendor stacks with a single point for trading, payments, tokenized assets, staking, lending, compliance, and settlement.
- [Use cases](https://docs.services.payward.com/tabs/developer-documentation/get-started/use-cases.md)
- [Authentication](https://docs.services.payward.com/tabs/developer-documentation/get-started/authentication.md)
- [Asset, funding rail, and geo coverage](https://docs.services.payward.com/tabs/developer-documentation/get-started/asset-funding-rail-and-geo-coverage.md)
- [Assets](https://docs.services.payward.com/tabs/developer-documentation/market-data/assets.md): Use the Assets API to discover supported assets, check payment availability, and show market context before users deposit, withdraw, or trade.
- [Portfolio](https://docs.services.payward.com/tabs/developer-documentation/accounts/portfolio.md): Use the Portfolio API to show account value, asset positions, transaction history, and historical portfolio performance.
- [Hosted KYC](https://docs.services.payward.com/tabs/developer-documentation/verifications/hosted-kyc.md): Use the hosted KYC flow to verify users through a Payward-managed hosted UI.
- [Backend verification API](https://docs.services.payward.com/tabs/developer-documentation/verifications/backend-verification-api.md): Submit end-user verification evidence from your backend and track status with the Payward Verifications API.
- [Swaps](https://docs.services.payward.com/tabs/developer-documentation/trade/swap.md): The Swaps API offers institutional FX-style trading. Lock a price for ~2 minutes, execute against the locked quote, then poll until the trade reaches a terminal state.
- [On-chain swaps](https://docs.services.payward.com/tabs/developer-documentation/trade/onchain-quotes.md): The on-chain swaps API lets you create a wallet-funded xStocks quote, submit the returned payload on-chain, and poll until the quote reaches a terminal state.
- [Price trigger swaps](https://docs.services.payward.com/tabs/developer-documentation/trade/price-trigger-swaps.md): Price trigger swaps are price-triggered trades that execute automatically when an asset reaches a target price. Use them to implement strategies like "Buy the Dip" (buy when price drops to a target), "Join the Rally" (buy when price rises to ride momentum), "Take the Profit" (sell when price rises t…
- [Earn](https://docs.services.payward.com/tabs/developer-documentation/earn/earn.md): The Earn API exposes Auto-Earn: enable or disable yield generation across eligible assets, read the user's allocations and historical rewards, and discover which assets are auto-earn eligible by user or by country.
- [Conversion rules](https://docs.services.payward.com/tabs/developer-documentation/payments/conversion-rules.md): The conversion rules API automates fiat ↔ crypto on/off-ramps using regulated banking rails: persistent rules that fire on every matching deposit.
- [Testing conversions](https://docs.services.payward.com/tabs/developer-documentation/payments/testing-conversions.md): Exercise a conversion rule end to end in the sandbox by simulating an inbound deposit — no real bank transfer or on-chain send required.
- [Deposits and withdrawals](https://docs.services.payward.com/tabs/developer-documentation/payments/deposits-and-withdrawals.md): This guide walks you through enabling crypto deposits and withdrawals for your users via the Payward Services API.
- [Transfers](https://docs.services.payward.com/tabs/developer-documentation/payments/transfers.md): Move assets between accounts in your Payward Services program and reconcile the result through Portfolio.
- [Ramp](https://docs.services.payward.com/tabs/developer-documentation/payments/ramp.md): The Payward Ramp API lets you embed a fiat-to-crypto on-ramp into your application via a hosted checkout flow.
- [Get User](https://docs.services.payward.com/api-reference/users/get-user.md): Retrieve a previously created user by their user ID.
- [Update User](https://docs.services.payward.com/api-reference/users/update-user.md): Update profile fields on an existing user.
- [Create User](https://docs.services.payward.com/api-reference/users/create-user.md): Create a new user in the Payward system.
- [Create Headless User](https://docs.services.payward.com/api-reference/users/create-headless-user.md): Create a new headless user in the Payward system.
- [List Assets](https://docs.services.payward.com/api-reference/assets/list-assets.md): List assets available on the platform.
- [List User Assets](https://docs.services.payward.com/api-reference/assets/list-user-assets.md): List assets available on the platform.
- [Get Asset](https://docs.services.payward.com/api-reference/assets/get-asset.md): Get information about a specific asset.
- [Get User Asset](https://docs.services.payward.com/api-reference/assets/get-user-asset.md): Get information about a specific asset.
- [List Asset Rates](https://docs.services.payward.com/api-reference/assets/list-asset-rates.md): Returns historical rates for a given asset.
- [List User Asset Rates](https://docs.services.payward.com/api-reference/assets/list-user-asset-rates.md): Returns historical rates for a given asset.
- [List conversion rules](https://docs.services.payward.com/api-reference/conversion-rules/list-conversion-rules.md): Lists conversion rules for the caller, ordered by `created_at` descending.
- [Create conversion rule](https://docs.services.payward.com/api-reference/conversion-rules/create-conversion-rule.md): Creates a new conversion rule. Provisions the inbound deposit endpoint (IBAN for fiat-source, crypto address for crypto-source) the caller will fund. Once funded, transactions are produced against this conversion rule and become observable via the transactions surface.
- [Get conversion rule](https://docs.services.payward.com/api-reference/conversion-rules/get-conversion-rule.md): Retrieves the current state of a previously created conversion rule.
- [Update conversion rule](https://docs.services.payward.com/api-reference/conversion-rules/update-conversion-rule.md): Updates an existing conversion rule. Replaces the destination, name, and status in a single full-state PUT (matching the autoramp rule update contract). The source side is immutable — re-create the conversion rule if you need to change input asset, rail, or wallet.
- [Delete conversion rule](https://docs.services.payward.com/api-reference/conversion-rules/delete-conversion-rule.md): Deletes a conversion rule (soft-delete). Inbound funds already received continue to settle; future deposits are rejected. Re-deleting an already-deleted conversion rule returns `404 NotFound` — partners cannot distinguish "deleted" from "never existed".
- [List conversion rule transactions](https://docs.services.payward.com/api-reference/conversion-rules/list-conversion-rule-transactions.md): Lists transactions produced by a single conversion rule, ordered by `created_at` descending.
- [Get auto earn preferences](https://docs.services.payward.com/api-reference/earn/get-auto-earn-preferences.md): Returns the current auto-earn preferences for the specified account.
- [Set auto earn preferences](https://docs.services.payward.com/api-reference/earn/set-auto-earn-preferences.md): Sets auto-earn preferences for the specified account.
- [Get auto earn allocations](https://docs.services.payward.com/api-reference/earn/get-auto-earn-allocations.md): Returns current allocation info for the specified account.
- [Get account auto earn assets](https://docs.services.payward.com/api-reference/earn/get-account-auto-earn-assets.md): Returns auto-earn asset info for assets available to the specified account.
- [Get auto earn rewards](https://docs.services.payward.com/api-reference/earn/get-auto-earn-rewards.md): Returns historical reward info for the specified account.
- [Get auto earn assets](https://docs.services.payward.com/api-reference/earn/get-auto-earn-assets.md): Returns auto-earn asset info for a given country.
- [Validate Withdrawal Address](https://docs.services.payward.com/api-reference/funds/validate-withdrawal-address.md): Validate a crypto withdrawal address for the provided asset and method.
- [List Withdrawal Addresses](https://docs.services.payward.com/api-reference/funds/list-withdrawal-addresses.md): List saved withdrawal addresses for the effective account.
- [Save Withdrawal Address](https://docs.services.payward.com/api-reference/funds/save-withdrawal-address.md): Validate and save a withdrawal address for future withdrawals.
- [Delete Withdrawal Address](https://docs.services.payward.com/api-reference/funds/delete-withdrawal-address.md): Delete a saved withdrawal address by key.
- [Update Withdrawal Address](https://docs.services.payward.com/api-reference/funds/update-withdrawal-address.md): Update a saved withdrawal address key.
- [Withdraw Funds](https://docs.services.payward.com/api-reference/funds/withdraw-funds.md): Withdraw funds from the account identified by `account_id`.
- [List deposit addresses](https://docs.services.payward.com/api-reference/funds/list-deposit-addresses.md): Lists crypto deposit addresses available for use with a funding method on the selected account.
- [Claim deposit address](https://docs.services.payward.com/api-reference/funds/claim-deposit-address.md): Claims a crypto deposit address for a funding method available to the selected account.
- [Create Lightning invoice](https://docs.services.payward.com/api-reference/funds/create-lightning-invoice.md): Creates a single-use BOLT11 payment request for depositing an exact amount to the selected account over the Bitcoin Lightning Network.
- [List deposit methods](https://docs.services.payward.com/api-reference/funds/list-deposit-methods.md): Returns the deposit methods available to the selected account for an asset.
- [List Withdrawal Methods](https://docs.services.payward.com/api-reference/funds/list-withdrawal-methods.md): List available withdrawal methods for a given asset.
- [Create transfer](https://docs.services.payward.com/api-reference/funds/create-transfer.md): Creates a transfer between accounts in the authenticated caller's program.
- [Get Portfolio Summary](https://docs.services.payward.com/api-reference/portfolio/get-portfolio-summary.md): Get the portfolio summary for a user.
- [List Portfolio History](https://docs.services.payward.com/api-reference/portfolio/list-portfolio-history.md): Lists historical balances and valuations for a user's portfolio.
- [List Portfolio Details](https://docs.services.payward.com/api-reference/portfolio/list-portfolio-details.md): Lists owned assets in a user's portfolio.
- [List Portfolio Transactions](https://docs.services.payward.com/api-reference/portfolio/list-portfolio-transactions.md): Lists account portfolio transactions with optional filters for type, asset, status, transaction ID, originating reference, time range, and sort direction. Results are cursor-paginated. Results are ordered newest first by default; set `sort_direction=asc` for oldest first. Page tokens are valid for u…
- [List price trigger swaps](https://docs.services.payward.com/api-reference/price-trigger-swaps/list-price-trigger-swaps.md): Returns a cursor-paginated list of price trigger swaps for the user, optionally filtered by status.
- [Create price trigger swap](https://docs.services.payward.com/api-reference/price-trigger-swaps/create-price-trigger-swap.md): Submits a new price trigger swap. The swap remains in `active` status until its `when` condition is met or it is cancelled.
- [Get price trigger swap](https://docs.services.payward.com/api-reference/price-trigger-swaps/get-price-trigger-swap.md): Returns the current state of a single price trigger swap by ID.
- [Cancel price trigger swap](https://docs.services.payward.com/api-reference/price-trigger-swaps/cancel-price-trigger-swap.md): Cancels a price trigger swap that is still in `active` status.
- [List on-chain quotes](https://docs.services.payward.com/api-reference/on-chain-swaps/list-on-chain-quotes.md): Lists onchain quotes for the authenticated user.
- [Create on-chain quote](https://docs.services.payward.com/api-reference/on-chain-swaps/create-on-chain-quote.md): Creates a new wallet-funded onchain quote.
- [Get on-chain quote](https://docs.services.payward.com/api-reference/on-chain-swaps/get-on-chain-quote.md): Retrieves the current state of a previously created onchain quote.
- [List Ramp Buy Cryptocurrency Assets](https://docs.services.payward.com/api-reference/ramp/list-ramp-buy-cryptocurrency-assets.md): List cryptocurrency assets supported for Ramp buy transactions, including networks and withdrawal methods.
- [List Ramp Fiat Currencies](https://docs.services.payward.com/api-reference/ramp/list-ramp-fiat-currencies.md): List fiat currencies supported for funding Ramp transactions.
- [List Ramp Payment Methods](https://docs.services.payward.com/api-reference/ramp/list-ramp-payment-methods.md): List fiat funding methods supported for Ramp deposits.
- [List Ramp Countries](https://docs.services.payward.com/api-reference/ramp/list-ramp-countries.md): List countries and subdivision groups supported for Ramp deposits.
- [Get Ramp Limits](https://docs.services.payward.com/api-reference/ramp/get-ramp-limits.md): Retrieve combined min/max limits for a Ramp transaction configuration.
- [Get Ramp Prospective Quote](https://docs.services.payward.com/api-reference/ramp/get-ramp-prospective-quote.md): Retrieve a prospective quote for a Ramp transaction without reserving liquidity. Use this to preview spend/receive amounts before creating a checkout URL.
- [Get Ramp Checkout URL](https://docs.services.payward.com/api-reference/ramp/get-ramp-checkout-url.md): Generate a hosted Ramp checkout URL for the provided transaction configuration. The response echoes the request parameters so the Ramp partner can confirm what was submitted.
- [Create Ramp checkout session](https://docs.services.payward.com/api-reference/ramp/create-ramp-checkout-session.md): Creates a Ramp checkout for a selected user and returns the widget redirect URL with the checkout UUID in the fragment. No access token is minted here; the widget mints it via the bootstrap call (`BootstrapRampCheckout`). The URL must still be treated as sensitive — the UUID is a capability handle.
- [List Settlement Reports](https://docs.services.payward.com/api-reference/reports/list-settlement-reports.md): Retrieves a paginated list of settlement reports available to the authenticated Master User, with optional filters for date range and report type.
- [Get Settlement Report](https://docs.services.payward.com/api-reference/reports/get-settlement-report.md): Retrieves a settlement report and provides a secure download URL for the authenticated Master User.
- [Execute quote](https://docs.services.payward.com/api-reference/swaps/execute-quote.md): Triggers execution of a pending account-funded swap quote.
- [Create quote](https://docs.services.payward.com/api-reference/swaps/create-quote.md): Creates an account-funded swap quote that locks a price for ~2 minutes.
- [Get quote](https://docs.services.payward.com/api-reference/swaps/get-quote.md): Retrieves the current state of a previously created quote.
- [Create verification](https://docs.services.payward.com/api-reference/travel-rule-verifications/create-verification.md): Creates a Travel Rule verification case for a known wallet address.
- [Get verification](https://docs.services.payward.com/api-reference/travel-rule-verifications/get-verification.md): Gets a previously returned proactive Travel Rule verification case.
- [Submit Verification from URL](https://docs.services.payward.com/api-reference/verifications/submit-verification-from-url.md): Submit a verification for a user with documents provided via presigned URLs.
- [Start Verification from URL](https://docs.services.payward.com/api-reference/verifications/start-verification-from-url.md): Start a Payward-performed verification for a user with evidence provided via presigned URLs.
- [Start verification from hosted flow](https://docs.services.payward.com/api-reference/verifications/start-verification-from-hosted-flow.md): Start a hosted verification UI flow for a user.
- [Resume hosted verification](https://docs.services.payward.com/api-reference/verifications/resume-hosted-verification.md): Resume an existing hosted verification flow and mint or reuse a session token. If the hosted session has expired, the service refreshes it so the hosted UI can load again.
- [Create one-time link for hosted verification](https://docs.services.payward.com/api-reference/verifications/create-one-time-link-for-hosted-verification.md): Mint a fresh one-time link for an existing hosted verification flow. Hand the returned URL to the user when you need a shareable hosted UI link instead of an embedded session token.
- [Get verification](https://docs.services.payward.com/api-reference/verifications/get-verification.md): Get a verification summary for the given user and verification ID.
- [List verifications](https://docs.services.payward.com/api-reference/verifications/list-verifications.md): List verification summaries for the given user.
- [List Webhooks](https://docs.services.payward.com/api-reference/webhooks/list-webhooks.md): Retrieve all webhooks registered for your domain.
- [Register Webhook](https://docs.services.payward.com/api-reference/webhooks/register-webhook.md): Register a new webhook endpoint to receive event notifications from Payward.
- [Get Webhook](https://docs.services.payward.com/api-reference/webhooks/get-webhook.md): Retrieves a webhook by id.
- [Delete Webhook](https://docs.services.payward.com/api-reference/webhooks/delete-webhook.md): Delete a webhook configuration.
- [Update Webhook](https://docs.services.payward.com/api-reference/webhooks/update-webhook.md): Update a webhook configuration.
- [List Webhook Attempts](https://docs.services.payward.com/api-reference/webhooks/list-webhook-attempts.md): Lists delivery attempts made to this webhook, most recent first.
- [Rotate Webhook Secret](https://docs.services.payward.com/api-reference/webhooks/rotate-webhook-secret.md): Rotates the webhook's signing secret and returns the new value.
- [Test Webhook](https://docs.services.payward.com/api-reference/webhooks/test-webhook.md): Send a test event to verify your webhook configuration.
- [Quote executed](https://docs.services.payward.com/api-reference/webhooks/quote-executed.md): Quote successfully executed against the partner account.
- [Quote cancelled](https://docs.services.payward.com/api-reference/webhooks/quote-cancelled.md): Quote cancelled before execution.
- [Quote execution failed](https://docs.services.payward.com/api-reference/webhooks/quote-execution-failed.md): Quote execution attempted but failed.
- [User verified](https://docs.services.payward.com/api-reference/webhooks/user-verified.md): The user completed verification.
- [User verification needed](https://docs.services.payward.com/api-reference/webhooks/user-verification-needed.md): The user needs to complete verification.
- [User verification failed](https://docs.services.payward.com/api-reference/webhooks/user-verification-failed.md): The user's verification submission was rejected.
- [User disabled](https://docs.services.payward.com/api-reference/webhooks/user-disabled.md): The user's account became disabled.
- [User closed](https://docs.services.payward.com/api-reference/webhooks/user-closed.md): The user's account was closed.
- [Conversion deposit completed](https://docs.services.payward.com/api-reference/webhooks/conversion-deposit-completed.md): Inbound funds were credited for a conversion transaction.
- [Conversion deposit held](https://docs.services.payward.com/api-reference/webhooks/conversion-deposit-held.md): The inbound funding leg is held pending review for a conversion transaction.
- [Conversion deposit failed](https://docs.services.payward.com/api-reference/webhooks/conversion-deposit-failed.md): The inbound funding leg failed for a conversion transaction.
- [Conversion withdrawal completed](https://docs.services.payward.com/api-reference/webhooks/conversion-withdrawal-completed.md): Outbound settlement completed for a conversion transaction.
- [Conversion withdrawal failed](https://docs.services.payward.com/api-reference/webhooks/conversion-withdrawal-failed.md): The outbound settlement leg failed for a conversion transaction.
- [Conversion quote execution failed](https://docs.services.payward.com/api-reference/webhooks/conversion-quote-execution-failed.md): Quote creation or execution failed for a pre-quote conversion transaction.
- [Conversion travel rule blocked](https://docs.services.payward.com/api-reference/webhooks/conversion-travel-rule-blocked.md): A pre-trade Travel Rule check blocked the conversion before any quote execution was attempted. Either the destination wallet requires an ownership verification that has not been satisfied, or the check could not be evaluated because mandatory information is missing; the specific cause is in `error_c…
- [Portfolio transaction swap](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-swap.md): A Portfolio swap transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Portfolio transaction price trigger swap](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-price-trigger-swap.md): A Portfolio price trigger swap transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Portfolio transaction earn reward](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-earn-reward.md): A Portfolio earn reward transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Portfolio transaction deposit](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-deposit.md): A Portfolio deposit transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Portfolio transaction withdrawal](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-withdrawal.md): A Portfolio withdrawal transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Portfolio transaction transfer](https://docs.services.payward.com/api-reference/webhooks/portfolio-transaction-transfer.md): A Portfolio transfer transaction was created or updated. Use the Portfolio Transactions endpoint to retrieve the complete ledger entry.
- [Funds deposit received](https://docs.services.payward.com/api-reference/webhooks/funds-deposit-received.md): A deposit was received and is awaiting confirmations or checks.
- [Funds deposit held](https://docs.services.payward.com/api-reference/webhooks/funds-deposit-held.md): A deposit is held pending review or additional checks.
- [Funds deposit credited](https://docs.services.payward.com/api-reference/webhooks/funds-deposit-credited.md): A deposit was credited and can now be used.
- [Funds deposit returned](https://docs.services.payward.com/api-reference/webhooks/funds-deposit-returned.md): A deposit was returned to its source.
- [Funds deposit failed](https://docs.services.payward.com/api-reference/webhooks/funds-deposit-failed.md): A deposit failed and will not be credited.

## OpenAPI Specs

- [openapi_v3_pws](https://docs.services.payward.com/api-reference/openapi_v3_pws.json)
- [openapi_v3_ramp](https://docs.services.payward.com/api-reference/openapi_v3_ramp.yaml)
- [openapi_v3_embed](https://docs.services.payward.com/api-reference/openapi_v3_embed.yaml)
- [openapi](https://docs.services.payward.com/api-reference/openapi.json)