Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

The Yativo sandbox lets you develop and test your integration without moving real funds. Payments are simulated, KYC approves automatically, and virtual accounts work end-to-end.

​
Sandbox Base URL

https://smtp.yativo.com/api/v1
All other endpoints remain the same — just swap the base URL.

​
Getting Started

You use the same Yativo account for both sandbox and production. Switch between environments by changing the base URL in your requests.
  1. Sign up at app.yativo.com (if you haven’t already)
  2. Get your credentials — Dashboard → Developer → API Key
  3. Authenticate using the sandbox base URL:
curl -X POST 'https://smtp.yativo.com/api/v1/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_id": "YOUR_ACCOUNT_ID",
    "app_secret": "YOUR_APP_SECRET"
  }'

​
Sandbox Behavior

FeatureSandboxProduction
PaymentsSimulated — no real fundsReal money moves
KYCAuto-approves instantlyTakes minutes to hours
Virtual accountsWork end-to-endLive bank accounts
Exchange ratesLive rates returnedLive rates
WebhooksFired normallyFired normally
API logsRecordedRecorded

​
How to Test

1

Use the sandbox base URL

Set https://smtp.yativo.com/api/v1 as your base URL in all requests.
2

Authenticate

Use the same Account ID and App Secret. Call POST /auth/login against the sandbox URL to get a token.
3

Create test customers

Use POST /customer to create customers. KYC auto-approves in sandbox — no documents needed.
4

Create virtual accounts

Once a customer is created (KYC auto-approved), call POST /business/virtual-account/create.
5

Simulate deposits

Use the sandbox dashboard or API to trigger test deposits to your virtual accounts.
6

Test payouts

Call POST /sendmoney or POST /wallet/payout — payments are simulated and will transition through statuses.

​
Example: Full Sandbox Test Flow

Node.js
const BASE = 'https://smtp.yativo.com/api/v1';

// 1. Authenticate
const { data: auth } = await fetch(`${BASE}/auth/login`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    account_id: process.env.YATIVO_ACCOUNT_ID,
    app_secret: process.env.YATIVO_APP_SECRET,
  }),
}).then(r => r.json());

const token = auth.data.access_token;
const headers = {
  Authorization: `Bearer ${token}`,
  'Content-Type': 'application/json',
  'Idempotency-Key': crypto.randomUUID(),
};

// 2. Create customer (KYC auto-approves in sandbox)
const { data: customer } = await fetch(`${BASE}/customer`, {
  method: 'POST', headers,
  body: JSON.stringify({
    first_name: 'Test', last_name: 'User',
    email: 'test@example.com', country: 'BRA',
  }),
}).then(r => r.json());

// 3. Create virtual account
const { data: account } = await fetch(`${BASE}/business/virtual-account/create`, {
  method: 'POST',
  headers: { ...headers, 'Idempotency-Key': crypto.randomUUID() },
  body: JSON.stringify({
    customer_id: customer.data.customer_id,
    currency: 'BRL',
  }),
}).then(r => r.json());

console.log('Test account number:', account.data.account_number);

​
Differences from Production

  • KYC is instant — submit a customer and is_kyc_submitted / is_va_approved are set immediately
  • No real funds — wallet balances may be pre-funded in sandbox; payouts simulate the full transaction lifecycle
  • Some payment methods may be limited — not all live corridors are available in sandbox; contact your integration team if you need a specific one
  • Webhooks fire normally — you’ll receive all webhook events in sandbox; make sure your test endpoint is reachable

​
Switching to Production

When you’re ready to go live:
  1. Change your base URL from https://smtp.yativo.com/api/v1 to https://api.yativo.com/api/v1
  2. Ensure your business KYC is approved in the dashboard
  3. Real customers will need to complete KYC (not auto-approved)
  4. Update your webhook URL to point to your production endpoint
Your Account ID and App Secret are the same for both environments. Only the base URL changes.