Skip to main content
Every Vanryx Merchant API request must include an active API key in the Merchant-API-Key header.

Create an API key

API keys are created in the authenticated Vanryx Dashboard. There is no public API endpoint for creating keys.
1

Open Merchant Service

Sign in to the Vanryx Dashboard and open Merchant Service.
2

Generate the key

In Generate API Key:
  1. Enter a Key Name.
  2. Select at least one item under Accepted Crypto Currencies.
  3. Select Generate API Key.
3

Copy and save the key

The Dashboard shows Created API Key and asks you to Copy and save your API key. Copy it into your server-side secret storage.
The key must be active to authenticate API calls. A deactivated or deleted key no longer authenticates.

Authenticate requests

Send the key in this header, exactly as shown:
Minimal authenticated request:

Authentication errors

Keep your key secret

Anyone who holds your API key can make Merchant API requests on your behalf.
  • Keep keys in server-side secret storage.
  • Never put keys in browser or client-side code, URLs, source control, or logs.
  • If a key is compromised, deactivate or delete it in the Dashboard where that option is available, then generate a replacement key.

Rate limits

Create Invoice is limited to 10 requests per minute. Other API routes may also return HTTP 429. Their effective limits and any rate-limit response headers are not documented. Handle 429 responses by backing off before you retry.