Quickstart
Quote a rate, send a payout and receive the webhook.
Get your API keys
Create a key in the dashboard. The secret is shown once.
Webhooks
Know the moment a payment lands.
API reference
Every endpoint, generated from the API code.
What you can do
How the API works
- Base path. Every endpoint starts with
/v1. The live API is athttps://api.payvehq.com. - Authentication. Send your secret key in the
x-api-keyheader. See Authentication. - Money. Every amount is a whole number in minor units:
150000is ₦1,500.00. See Requests and responses. - Safe retries. Money calls take an
Idempotency-Keyheader, so a retry never pays twice. See Idempotency. - Four statuses. A transaction is
pending,processing,successfulorfailed. See Statuses. - Webhooks. Payve posts a signed event to your server when a transaction finishes. See Webhooks.
Amounts, rates, fees and names in the examples are made up. Your own responses carry your own
values.
Currencies
The API acceptsNGN, GHS and KES. Coverage lists what works in each country.
