curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-cards/card_123/simulate' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"event": "virtualcard.transaction.settlement",
"amount": 12.5,
"outcome": "success"
}'
{
"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 card event (sandbox only)
Fire a virtualcard.* event on a card you own. Sandbox only.
POST
/
sandbox
/
virtual-cards
/
{cardId}
/
simulate
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-cards/card_123/simulate' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"event": "virtualcard.transaction.settlement",
"amount": 12.5,
"outcome": "success"
}'
{
"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
}
}Updates local card status where the event would in production and sends the matching
The card must belong to your business. Omit
See Virtual cards and every sandbox simulation endpoint in Sandbox.
virtualcard.* webhook. It never calls the card issuer.
POST /sandbox/virtual-cards/{cardId}/simulate
Sandbox only. Call
https://smtp.yativo.com/api/v1. Production returns 404 with Not found.event to default to virtualcard.transaction.settlement, or virtualcard.transaction.declined when outcome is fail.
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/virtual-cards/card_123/simulate' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"event": "virtualcard.transaction.settlement",
"amount": 12.5,
"outcome": "success"
}'
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
Body
application/json