Sandbox docs

Payments

Payments are Vestonix resources with vpay_ identifiers. Create them with payments:write. Always send an Idempotency-Key on create.

Create

POST /v1/payments accepts amount (decimal string), currency, optional reference, description, customer_email, and capture_method (automatic or manual). Quote and beneficiary references are used on the payout path — collect payments do not require them on this endpoint.

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"
  }'

Retrieve and list

GET one
curl "https://sandbox-api.vestonix.io/v1/payments/vpay_YOUR_PAYMENT" \
  -H "Authorization: Bearer vsk_test_YOUR_KEY"
GET list
curl "https://sandbox-api.vestonix.io/v1/payments" \
  -H "Authorization: Bearer vsk_test_YOUR_KEY"

Statuses

StatusMeaning
createdAccepted by Vestonix.
requires_actionPayer must complete checkout.
processingIn flight. Do not fulfil yet.
requires_captureAuthorized; capture separately when using manual capture.
succeededFunds captured. Safe to fulfil.
failedDeclined or errored. No funds moved.
cancelledVoided before capture.

There is no completed status. Terminal success is succeeded.

Sandbox mock amounts: typical → succeeded after a short delay; 13.13 → failed; 12.12 → processing. Sandbox guide.