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

# API reference

> Find Payward Services API endpoints, choose an environment, and download the OpenAPI specification.

Use the Payward Services (PWS) API to onboard users, manage accounts and funds, trade assets, and receive event
notifications. Each endpoint page documents its parameters, authentication requirements, and responses, and lets you
send a test request.

## Before you start

* [Authentication](https://docs.services.payward.com/tabs/developer-documentation/get-started/authentication.md): create an API key and sign your requests.
* [Environments](https://docs.services.payward.com/tabs/developer-documentation/testing/overview.md): get sandbox access before you call production.
* [Concepts](https://docs.services.payward.com/tabs/concepts/overview.md): learn how users, accounts, assets, and transactions relate.
* [Integration guides](https://docs.services.payward.com/tabs/guides/overview.md): follow end-to-end flows that combine several endpoints.

## Production and sandbox

The API reference has a **Production** version and a **Sandbox** version. Switch between them with the dropdown at the
top of the sidebar.

| Version | API base URL |
| - | - |
| Production | `https://api.services.payward.com` |
| Sandbox | `https://api.sandbox.services.payward.com` |

Each version is generated from the API deployed to that environment, so its request samples use that environment's
base URL. The Sandbox version can include endpoints that haven't reached production yet.

To get sandbox access and move your integration from testing to production, see
[Environments](https://docs.services.payward.com/tabs/developer-documentation/testing/overview.md).

## Request bodies

Each endpoint page lists the fields that its request body accepts. The API ignores any other field and doesn't return an
error for it. So a misspelled field is dropped without warning. For example, if you send `phon` instead of `phone`, the
request succeeds and the phone number stays unchanged.

Before you go live, check your field names against the endpoint reference. A client generated from the
[OpenAPI specification](#openapi-specification) catches misspelled fields at build time.

## Endpoint groups

Each API area links to its first endpoint in the Production reference. Browse the sidebar for the rest.

| API area | What it covers | Guide |
| - | - | - |
| [Assets](https://docs.services.payward.com/api-reference/production-live/assets/list-assets.md) | Supported assets, their details, and their price rates | [Assets](https://docs.services.payward.com/tabs/developer-documentation/market-data/assets.md) |
| [Conversions](https://docs.services.payward.com/api-reference/production-live/conversions/list-on-demand-conversions.md) | Rule-driven and on-demand conversions between fiat and crypto | [Conversion rules](https://docs.services.payward.com/tabs/developer-documentation/payments/conversion-rules.md) |
| [Earn](https://docs.services.payward.com/api-reference/production-live/earn/get-auto-earn-preferences.md) | Auto Earn preferences, allocations, assets, and rewards | [Auto Earn](https://docs.services.payward.com/tabs/developer-documentation/earn/auto-earn.md) |
| [Funding](https://docs.services.payward.com/api-reference/production-live/funding/look-up-funding-method-metadata.md) | Deposits, withdrawals, funding addresses, limits, fees, and transfers between accounts | [Deposits and withdrawals](https://docs.services.payward.com/tabs/developer-documentation/payments/deposits-and-withdrawals.md), [Transfers](https://docs.services.payward.com/tabs/developer-documentation/payments/transfers.md) |
| [Derivative transfers](https://docs.services.payward.com/api-reference/production-live/derivative-transfers/create-derivatives-transfer.md) | Moving funds between an account's spot and futures balances | [Transfers](https://docs.services.payward.com/tabs/developer-documentation/payments/transfers.md) |
| [Portfolio](https://docs.services.payward.com/api-reference/production-live/portfolio/get-portfolio.md) | Balances, valuations, history, and transactions | [Portfolio](https://docs.services.payward.com/tabs/developer-documentation/accounts/portfolio.md) |
| [Ramp](https://docs.services.payward.com/api-reference/production-live/ramp/list-bank-links.md) | Bank links, Ramp quotes, limits, and hosted checkout | [Ramp](https://docs.services.payward.com/tabs/developer-documentation/payments/ramp.md), [Bank links](https://docs.services.payward.com/tabs/developer-documentation/payments/bank-links.md) |
| [Reports](https://docs.services.payward.com/api-reference/production-live/reports/list-settlement-reports.md) | Settlement and reconciliation reports | |
| [Swaps](https://docs.services.payward.com/api-reference/production-live/swaps/create-quote.md) | Account-funded quotes that lock a price until they expire or execute | [Swap](https://docs.services.payward.com/tabs/developer-documentation/trade/swap.md) |
| [Onchain quotes](https://docs.services.payward.com/api-reference/production-live/onchain-quotes/create-onchain-quote.md) | Wallet-funded quotes that settle onchain | [Onchain quotes](https://docs.services.payward.com/tabs/developer-documentation/trade/onchain-quotes.md) |
| [Price trigger swaps](https://docs.services.payward.com/api-reference/production-live/price-trigger-swaps/create-price-triggered-swap.md) | Swaps that wait for a target price before they trade | [Price trigger swaps](https://docs.services.payward.com/tabs/developer-documentation/trade/price-trigger-swaps.md) |
| [Travel Rule verifications](https://docs.services.payward.com/api-reference/production-live/travel-rule-verifications/create-travel-rule-verification.md) | Travel Rule verification cases for known wallet addresses | |
| [Users](https://docs.services.payward.com/api-reference/production-live/users/create-user.md) | Creating users and retrieving their profiles and accounts | [Users, accounts, and ownership](https://docs.services.payward.com/tabs/concepts/users-and-accounts.md) |
| [Verifications](https://docs.services.payward.com/api-reference/production-live/verifications/get-verification-requirements.md) | Identity verification (KYC) requirements and hosted verification sessions | [Hosted KYC](https://docs.services.payward.com/tabs/developer-documentation/verifications/hosted-kyc.md) |
| [Webhooks](https://docs.services.payward.com/api-reference/production-live/webhooks/list-webhooks.md) | Event subscriptions, signing secrets, delivery attempts, and test events | |

## OpenAPI specification

Download the machine-readable OpenAPI specification to generate clients or import the API into your tools. Each file
matches its version of this reference: [Production](https://dsct1ci24fgcu.cloudfront.net/prod/merged/openapi.json) or [Sandbox](https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json).

## Postman collection

Use the [Postman collection](https://docs.services.payward.com/tabs/developer-documentation/get-started/postman.md) to send signed requests without writing
code.
