curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/transactions/payout_123/fail' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{ "reason": "insufficient_funds" }'
{
"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
}
}{
"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
Mark transaction failed (sandbox only)
Settle a pending payin or payout as failed. Sandbox only.
POST
/
sandbox
/
transactions
/
{id}
/
fail
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/transactions/payout_123/fail' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{ "reason": "insufficient_funds" }'
{
"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
}
}{
"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
}
}Fails a pending deposit or payout you own.
A pending deposit is marked
See every sandbox simulation endpoint in Sandbox.
POST /sandbox/transactions/{id}/fail
Sandbox only. Call
https://smtp.yativo.com/api/v1. Production returns 404 with Not found.failed (no credit). A pending payout is marked failed and the debit is refunded. A deposit that has already been credited, or a payout that has already completed, cannot be moved backwards (409).
curl -X POST 'https://smtp.yativo.com/api/v1/sandbox/transactions/payout_123/fail' \
-H 'X-Api-Key: YOUR_SANDBOX_API_KEY' \
-H 'X-Api-Secret: YOUR_SANDBOX_API_SECRET' \
-H 'Content-Type: application/json' \
-d '{ "reason": "insufficient_funds" }'
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
Deposit id, payout id, or transaction_id.
Body
application/json
Optional failure reason stored on the record.
Example:
"insufficient_funds"