curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-accounts/va_123/simulate-deposit' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"amount": 250,
"outcome": "success",
"sender": {
"name": "Jane Doe",
"bank": "Sandbox Bank",
"account_number": "1234567890"
}
}'
{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Sandbox
Simulate a virtual account deposit (sandbox only)
Credit or fail a deposit into a virtual account. Sandbox only.
POST
/
sandbox
/
virtual-accounts
/
{accountId}
/
simulate-deposit
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-accounts/va_123/simulate-deposit' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"amount": 250,
"outcome": "success",
"sender": {
"name": "Jane Doe",
"bank": "Sandbox Bank",
"account_number": "1234567890"
}
}'
{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Creates a deposit on a virtual account you own. A successful outcome credits the wallet and sends
See every sandbox simulation endpoint in Sandbox.
virtual_account.deposit. Sandbox simulations do not charge virtual-account fees.
POST /sandbox/virtual-accounts/{accountId}/simulate-deposit
Sandbox only. Call
https://smtp.yativo.com/api/v1. Production returns 404 with Not found.{accountId} is the virtual account’s account_id or account_number.
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-accounts/va_123/simulate-deposit' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"amount": 250,
"outcome": "success",
"sender": {
"name": "Jane Doe",
"bank": "Sandbox Bank",
"account_number": "1234567890"
}
}'
Authorizations
Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.
Your API secret (yativo_sk_...), shown once when the key is created.
Path Parameters
The virtual account's account_id or account_number.
Body
application/json
Major units in the account's currency.
Required range:
0.01 <= x <= 1000000Example:
250
success credits the wallet and sends virtual_account.deposit. fail creates a failed deposit.
Available options:
success, fail Show child attributes
Show child attributes