# Payward Developer Documentation

## Docs

- [Get Asset](https://docs.services.payward.com/api-reference/assets/get-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 Assets](https://docs.services.payward.com/api-reference/assets/list-assets.md): List assets available on the platform.
- [Create conversion](https://docs.services.payward.com/api-reference/conversions/create-conversion.md): Creates a one-shot conversion.
- [Create conversion rule](https://docs.services.payward.com/api-reference/conversions/create-conversion-rule.md): Creates a standing conversion rule.
- [Create deposit](https://docs.services.payward.com/api-reference/conversions/create-deposit.md): Creates a one-shot deposit (top-up) so the account can later draw from balance via `POST /v1/conversions` with `from.source.type: balance`.
- [Get conversion](https://docs.services.payward.com/api-reference/conversions/get-conversion.md): Retrieves the current state of a previously created conversion.
- [List conversions](https://docs.services.payward.com/api-reference/conversions/list-conversions.md): Lists conversions for the caller, ordered by `created_at` descending.
- [Whitelist wallet](https://docs.services.payward.com/api-reference/conversions/whitelist-wallet.md): Whitelists an external wallet for use as a conversion destination.
- [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 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.
- [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.
- [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 user auto earn assets](https://docs.services.payward.com/api-reference/earn/get-user-auto-earn-assets.md): Returns auto-earn asset info for assets available to 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.
- [Create Deposit Address](https://docs.services.payward.com/api-reference/funds/create-deposit-address.md): Create a new deposit address for a given asset and method.
- [Delete Withdrawal Address](https://docs.services.payward.com/api-reference/funds/delete-withdrawal-address.md): Delete a saved withdrawal address by key.
- [List Deposit Addresses](https://docs.services.payward.com/api-reference/funds/list-deposit-addresses.md): List deposit addresses for a given asset and method. Returns paginated results with address details including fees and limits.
- [List Deposit Methods](https://docs.services.payward.com/api-reference/funds/list-deposit-methods.md): List available deposit methods for a given asset. Returns method details including fees, limits, and network information.
- [List Funding Transactions](https://docs.services.payward.com/api-reference/funds/list-funding-transactions.md): List Funding transactions
- [List Withdrawal Addresses](https://docs.services.payward.com/api-reference/funds/list-withdrawal-addresses.md): List saved withdrawal addresses for the effective account.
- [List Withdrawal Methods](https://docs.services.payward.com/api-reference/funds/list-withdrawal-methods.md): List available withdrawal methods for a given asset.
- [Save Withdrawal Address](https://docs.services.payward.com/api-reference/funds/save-withdrawal-address.md): Validate and save a withdrawal address for future withdrawals.
- [Update Withdrawal Address](https://docs.services.payward.com/api-reference/funds/update-withdrawal-address.md): Update a saved withdrawal address key.
- [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.
- [Withdraw Funds](https://docs.services.payward.com/api-reference/funds/withdraw-funds.md): Withdraw funds from the account identified by `account_id`.
- [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 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.
- [Get Portfolio Summary](https://docs.services.payward.com/api-reference/portfolio/get-portfolio-summary.md): Get the portfolio summary for a user.
- [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 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 Transactions](https://docs.services.payward.com/api-reference/portfolio/list-portfolio-transactions.md): Lists the user's portfolio transactions, including swap activity, price trigger swap activity, earn rewards, and deposits when requested.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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 Countries](https://docs.services.payward.com/api-reference/ramp/list-ramp-countries.md): List countries and subdivision groups supported for Ramp deposits.
- [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.
- [Transaction Update](https://docs.services.payward.com/api-reference/ramp/transaction-update.md): **This endpoint can be implemented by the partner** to receive real-time transaction status updates from Payward.
- [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.
- [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.
- [Create quote](https://docs.services.payward.com/api-reference/swaps/create-quote.md): Creates an account-funded swap quote that locks a price for ~30 seconds.
- [Execute quote](https://docs.services.payward.com/api-reference/swaps/execute-quote.md): Triggers execution of a pending account-funded swap quote.
- [Get quote](https://docs.services.payward.com/api-reference/swaps/get-quote.md): Retrieves the current state of a previously created quote.
- [Create Headless User](https://docs.services.payward.com/api-reference/users/create-headless-user.md): Create a new headless user in the Payward system.
- [Create User](https://docs.services.payward.com/api-reference/users/create-user.md): Create a new user in the Payward system.
- [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.
- [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.
- [Delete Webhook](https://docs.services.payward.com/api-reference/webhooks/delete-webhook.md): Delete a webhook configuration.
- [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.
- [Test Webhook](https://docs.services.payward.com/api-reference/webhooks/test-webhook.md): Send a test event to verify your webhook configuration.
- [Update Webhook](https://docs.services.payward.com/api-reference/webhooks/update-webhook.md): Update a webhook's enabled status and/or event subscriptions.
- [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.
- [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.
- [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.
- [Asset, funding rail, and geo coverage](https://docs.services.payward.com/tabs/developer-documentation/get-started/asset-funding-rail-and-geo-coverage.md)
- [Authentication](https://docs.services.payward.com/tabs/developer-documentation/get-started/authentication.md)
- [Use cases](https://docs.services.payward.com/tabs/developer-documentation/get-started/use-cases.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.
- [Conversions](https://docs.services.payward.com/tabs/developer-documentation/payments/conversions.md): The Conversions API enables automated fiat ↔ crypto flows using regulated banking rails, with persistent rule-driven on/off-ramps and one-shot per-transaction conversions.
- [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.
- [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.
- [Transfers](https://docs.services.payward.com/tabs/developer-documentation/payments/transfers.md)
- [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…
- [Swaps](https://docs.services.payward.com/tabs/developer-documentation/trade/swap.md): The Swaps API offers institutional FX-style trading. Lock a price for ~30 seconds, execute against the locked quote, then poll until the trade reaches a terminal state.

## 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)