Information
- OpenAPI version:
3.1.0
Create Checkouts, read Payments, and receive signed Callbacks.
A Merchant’s server calls this API. VoltPay holds no key and moves no funds: money goes straight to the Merchant’s Receive Addresses, and VoltPay reports what arrived.
{"data": [...], "has_more": true, "next_cursor": "..."}.amount_base_units and decimals.POST accepts Idempotency-Key. A retry with the same key and body returns the first answer.code is stable and is what a client branches on. Its message may be reworded.The Mode is part of the API Key: gw_live_… or gw_test_…. It is never a request parameter,
and nothing crosses between Modes.
VoltPay POSTs signed events to the Callback Endpoint attached to the API Key. See webhooks.
The event a Merchant must handle is payment.confirmed. Delivery is at least once, so deduplicate
by event id, and for payments by Payment id. Any 2xx within 10 seconds is success.
Failed deliveries retry with backoff for 3 days. Every event carries the full current state,
so act on data.payment.status and not on the event name.
Verify Gateway-Signature against the raw request body before parsing it: compute
HMAC-SHA256 of <t>.<raw body> with the signing secret, compare in constant time with each
v1 value, and refuse a t more than 5 minutes off.
An API Key, created in the Merchant Panel. Keep it on your server. A browser never holds one.
Security scheme type: http
Bearer format: gw_live_… or gw_test_…