Sandbox
Quick Start
These examples call the Vestonix Sandbox API at https://sandbox-api.vestonix.io. Replace vsk_test_YOUR_KEY with the secret Vestonix showed once when your API client was created. No real funds move.
Sandbox access is available for technical evaluation. Production access requires separate commercial, compliance and technical approval. No real funds move.
- Request sandbox access, then reveal the one-time
vsk_test_credential. - Authenticate with a Bearer token.
- Create a beneficiary, then a quote (the quote needs the beneficiary id).
- Create a payment and retrieve its status.
- Register a webhook endpoint and inspect balances.
1. Authenticate
Header
Authorization: Bearer vsk_test_YOUR_KEY2. Create a beneficiary
curl
curl -X POST "https://sandbox-api.vestonix.io/v1/beneficiaries" \
-H "Authorization: Bearer vsk_test_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "bank_account",
"label": "EUR ops",
"account_holder_name": "Sandbox Merchant",
"country": "FR",
"currency": "EUR",
"iban": "FR7630006000011234567890189"
}'3. Create a quote
curl
curl -X POST "https://sandbox-api.vestonix.io/v1/quotes" \
-H "Authorization: Bearer vsk_test_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"source_amount": "25.00",
"source_currency": "EUR",
"beneficiary_id": "vdst_YOUR_BENEFICIARY"
}'4. Create a payment
curl
curl -X POST "https://sandbox-api.vestonix.io/v1/payments" \
-H "Authorization: Bearer vsk_test_YOUR_KEY" \
-H "Idempotency-Key: order-1042-payment" \
-H "Content-Type: application/json" \
-d '{
"amount": "20.00",
"currency": "USD",
"reference": "ORDER-1042"
}'Typical Sandbox amounts complete after a short mock checkout delay. 13.13 fails. 12.12 stays processing. See Sandbox.
5. Retrieve payment status
curl
curl "https://sandbox-api.vestonix.io/v1/payments/vpay_YOUR_PAYMENT" \
-H "Authorization: Bearer vsk_test_YOUR_KEY"6. Receive a webhook
curl
curl -X POST "https://sandbox-api.vestonix.io/v1/webhook-endpoints" \
-H "Authorization: Bearer vsk_test_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/vestonix-webhooks",
"enabled_events": [
"payment.created",
"payment.processing",
"payment.succeeded",
"payment.failed"
]
}'Signing secret is shown once. Verification is in the Webhooks guide.
7. Inspect balances
curl
curl "https://sandbox-api.vestonix.io/v1/balances" \
-H "Authorization: Bearer vsk_test_YOUR_KEY"Sandbox balances are test figures, not customer funds.
Download the OpenAPI document from /openapi.json or API Reference.