Sandbox docs

Authentication

Public API calls use HTTP Bearer tokens. Vestonix issues vsk_test_ secrets for Sandbox and vsk_live_ secrets for live merchants. There is no client-side environment switch — the credential itself selects the deployment it can reach.

Bearer authentication

Request
curl "https://sandbox-api.vestonix.io/v1/balances" \
  -H "Authorization: Bearer vsk_test_YOUR_KEY"

Test vs live

PrefixUse
vsk_test_Sandbox only. No real money.
vsk_live_Live merchants after Vestonix approval. Never use on Sandbox examples.

Secret handling

  • The raw secret is returned once on create and on rotate.
  • Vestonix stores a hash. It cannot retrieve the secret later.
  • Rotate issues a new secret. Revoke-previous stops the old one.
  • Revoke invalidates the client immediately.

Scopes

Keys are issued with explicit scopes. Grant only what the integration needs. Public scopes currently include:

  • payments:read
  • payments:write
  • quotes:read
  • quotes:write
  • beneficiaries:read
  • beneficiaries:write
  • balances:read
  • webhooks:read
  • webhooks:write
  • customers:read
  • customers:write
  • payment_requests:read
  • payment_requests:write
  • payment_links:read
  • payment_links:write
  • refunds:read
  • refunds:write
  • transactions:read

quotes:* and beneficiaries:* are the names to use in new integrations. Older aliases for the same capabilities still work on the server.

Dashboard sessions and staff Control Center login are not public API authentication. Do not send merchant cookies to these endpoints from an integration.