Skip to main content
POST
Sends a sample event to the webhook URL on your sandbox account, signed like a real delivery.
Sandbox only. Call https://smtp.yativo.com/api/v1. Production returns 404 with Not found.
type is one of payin, payout, virtual_account, virtual_account_created, virtual_account_updated, customer, customer_updated, endorsement, metadata_created, metadata_updated, webhook_updated, user, tracking, payin_method_enabled, payin_method_disabled, payout_method_enabled, payout_method_disabled, crypto_wallet, crypto_deposit, wallet_deleted, card_checkout or rfi. For Card Checkout you can also send a full event name such as card_checkout.order.paid. For example, payin sends deposit.created and then deposit.updated. Their customer may be null. This sends a sample only — it does not create a record. To settle a real sandbox payin, virtual account, or card, use the other endpoints in Sandbox. See Test in sandbox for the full list.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Path Parameters

type
enum<string>
required

The sample to send. card_checkout defaults to card_checkout.order.paid. You can also send a full event name. See Test in sandbox.

Available options:
payin,
payout,
virtual_account,
virtual_account_created,
virtual_account_updated,
customer,
customer_updated,
endorsement,
metadata_created,
metadata_updated,
webhook_updated,
user,
tracking,
payin_method_enabled,
payin_method_disabled,
payout_method_enabled,
payout_method_disabled,
crypto_wallet,
crypto_deposit,
wallet_deleted,
card_checkout,
rfi

Response

Sample dispatched

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
data
object