refund.status specific events:
These are the events created and triggered when the status of the refund object changes.| Event | Description | Default (on/off) |
|---|---|---|
| refund.succeeded | When a refund has succeeded | On |
| refund.failed | When a refund fails | On |
| refund.pending | When a refund is pending to be processed | On |
refund.pending
JSON
{
"type": "refund.pending",
"created_at": "2023-07-23T23:59:56.000000Z",
"data": {
"id": "rfd_ahfafooi7ibakbfahoan",
"object": "refund",
"payin": "chk_cirsp2sl4ar024j0akj0",
"amount": 90000,
"currency": "USD",
"customer_receives": {
"currency": "SGD",
"amount": 133200
},
"payment_attempt": "pat_ahbfiuahfiuaiofnioain",
"reason": "Damaged Goods",
"status": "pending",
"status_reason": "",
"holding_currency": "USD",
"balance_transaction": "",
"reference_id": "order_12345",
"webhook_url": "https://mystore.webhook.tazapay.refund/",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"created_at": "2023-07-23T23:59:56.000000Z"
},
"id": "evt_auigfianfoangohuehg",
"object": "event"
}
refund.succeeded
JSON
{
"type": "refund.succeeded",
"created_at": "2023-07-24T00:05:12.000000Z",
"data": {
"id": "rfd_ahfafooi7ibakbfahoan",
"object": "refund",
"payin": "chk_cirsp2sl4ar024j0akj0",
"amount": 90000,
"currency": "USD",
"customer_receives": {
"currency": "SGD",
"amount": 133200
},
"payment_attempt": "pat_ahbfiuahfiuaiofnioain",
"reason": "Damaged Goods",
"status": "succeeded",
"status_reason": "",
"holding_currency": "USD",
"balance_transaction": "btr_d679f6dqd9ne66lsngb0",
"reference_id": "order_12345",
"webhook_url": "https://mystore.webhook.tazapay.refund/",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"created_at": "2023-07-23T23:59:56.000000Z"
},
"id": "evt_auigfianfoangohuehg",
"object": "event"
}
refund.failed
JSON
{
"type": "refund.failed",
"created_at": "2023-07-24T00:05:12.000000Z",
"data": {
"id": "rfd_ahfafooi7ibakbfahoan",
"object": "refund",
"payin": "chk_cirsp2sl4ar024j0akj0",
"amount": 90000,
"currency": "USD",
"customer_receives": {
"currency": "SGD",
"amount": 133200
},
"payment_attempt": "pat_ahbfiuahfiuaiofnioain",
"reason": "Damaged Goods",
"status": "failed",
"status_reason": "Refund could not be processed",
"holding_currency": "USD",
"balance_transaction": "",
"reference_id": "order_12345",
"webhook_url": "https://mystore.webhook.tazapay.refund/",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"created_at": "2023-07-23T23:59:56.000000Z"
},
"id": "evt_auigfianfoangohuehg",
"object": "event"
}
Other events:
| Event | Description | Default (on/off) |
|---|---|---|
| refund.created | When a refund object is created for the account | On |
refund.created
JSON
{
"type": "refund.created",
"created_at": "2023-07-23T23:59:56.000000Z",
"data": {
"id": "rfd_ahfafooi7ibakbfahoan",
"object": "refund",
"payin": "chk_cirsp2sl4ar024j0akj0",
"amount": 90000,
"currency": "USD",
"customer_receives": {
"currency": "SGD",
"amount": 133200
},
"payment_attempt": "pat_ahbfiuahfiuaiofnioain",
"reason": "Damaged Goods",
"status": "requested",
"status_reason": "",
"holding_currency": "USD",
"balance_transaction": "",
"reference_id": "order_12345",
"webhook_url": "https://mystore.webhook.tazapay.refund/",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"created_at": "2023-07-23T23:59:56.000000Z"
},
"id": "evt_auigfianfoangohuehg",
"object": "event"
}