Example Trigger Request
POST https://yourdomain.com/path/to/webhook/handler
Example Trigger Payload
{
"object": "webhook_trigger",
"trigger": "payment",
"triggered_on": {
"id": "txn_3bW9JN4BVk3wU0ZZQs2Ay",
"object": "transaction",
"value": "processed"
}
}
When a trigger occurs, a POST
request will be made to the webhook URL with details
of the object that triggered the webhook.
The HTTP response code from the request is stored in the Webhook Logs logs for simple auditing of the triggered requests.
The available triggers are shown below.
Name | Description |
---|---|
payment |
Any payment that gets initiated |
processed |
Any payment that gets set to processed |
authorized |
Any payment that gets set to authorized |
credit |
Any credit that gets initiated |
refund |
Any refund that gets initiated |
reversal |
Any reversal that gets initiated |
void |
Any payment or credit that gets voided |
automatic_payment |
Any payment that is initiated by automatic billing |
decline |
Any payment or credit that gets declined |
deposit |
Any deposit that gets initiated |
reject |
Any transaction that gets rejected. See chargebacks and rejects |
payment_activation:status |
Any change to the status of a payment activation |
payment_link:status |
Any change to the status of a payment link |
processing_status |
Any change to the activation status of a processing account |