The pages in this section are generated from the Payve API’s controllers and request models. Each one lists the method, path, parameters and request body for an endpoint. For worked examples, response fields and failure cases, read the guide for each area. The reference tells you what an endpoint accepts. The guides tell you how to use it.

Base URL

Every path starts with /v1. The sandbox is at https://sandbox.api.payvehq.com. See Environments.

Authentication

Send your secret key in the x-api-key header. See Authentication.
Two endpoints need no key: GET /v1/currencies and GET /v1/rates.

Conventions

Endpoints by area

Reading needs no particular scope. Any valid key can call the GET endpoints for its own account.
These pages show endpoints without a “send request” console, so that nobody moves live money from a documentation page by accident. Use cURL or your own code.

Not in this reference

Endpoints the dashboard uses, such as creating API keys and managing webhook endpoints, need a dashboard session and are not part of the public API.