Sandbox docs

Beneficiaries

A beneficiary is a payout destination you control. Public identifiers use the vdst_ prefix. Create one before requesting a quote.

Create

POST /v1/beneficiaries requires beneficiaries:write. Sandbox supports bank_account (IBAN / local account details) and crypto_wallet payout destinations. Most Quick Start examples use a bank account.

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

Retrieve and list

GET /v1/beneficiaries and GET /v1/beneficiaries/:id return masked account numbers and IBANs. Sensitive values are not replayed in full after create.

Use the public name beneficiary in your product. Vestonix does not publish processor beneficiary identifiers.