API reference

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: create an API key and sign your requests.
• Environments: get sandbox access before you call production.
• Concepts: learn how users, accounts, assets, and transactions relate.
• Integration guides: 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. 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.

​

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

​

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 or Sandbox.

​

Postman collection

Use the Postman collection to send signed requests without writing code.