Escrow
These are the events for which webhooks will be triggered:
Payment_Status-specific events:
These are the events created and triggered when the status of the escrow object is impacted.
Event | Description | Default (on/off) |
---|---|---|
escrow.paid | payment_status of the escrow object changes to paid. | On |
escrow.paid
{
"type":"escrow.paid",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
"expiry_at":7967893,
"status":"expired",
"payment_status":"paid",
"invoice_currency":"usd",
"amount":"6700",
"customer_details":{
"country":"US",
"email":"[email protected]",
"name":"Adam Smith",
"phone":{
"country_code":"65",
"number":"67894321"
}
},
"transaction_description":"1 x Item",
"partner_reference":"55679-7657",
"metadata":{},
......
...... //Entire escrow object
........
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.unpaid
{
"type":"escrow.unpaid",
"created_at":95879350,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
"expiry_at":7967893,
"status":"expired",
"payment_status":"unpaid",
"invoice_currency":"usd",
"amount":"6700",
"customer_details":{
"country":"US",
"email":"[email protected]",
"name":"Adam Smith",
"phone":{
"country_code":"65",
"number":"67894321"
}
},
"transaction_description":"1 x Item",
"partner_reference":"55679-7657",
"metadata":{},
......
...... //Entire escrow object
........
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
Payment_Attempt Specific Events:
These events are created and triggered when something of interest happens for a payment attempt of a checkout.
Event | Description | Default (on/off) |
---|---|---|
payment_attempt.created | When a payment_attempt is created for the checkout | On |
payment_attempt.failed | When a payment_attempt fails for the checkout | On |
payment_attempt.processing | When the payment_attempt moves to the processing state | On |
payment_attempt.succeeded | When the payment_attempt succeeds | On |
payment_attempt.created
{
"type":"payment_attempt.created",
"created_at":958793503,
"data":{
"id":"pat_ahfafooi7ibakbfahoan",
"object":"payment_attempt",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
....
.... ///Entire payment_attempt object
....
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
payment_attempt.failed
{
"type":"payment_attempt.failed",
"created_at":958793503,
"data":{
"id":"pat_ahfafooi7ibakbfahoan",
"object":"payment_attempt",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
....
.... ///Entire payment_attempt object
....
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
payment_attempt.processing
{
"type":"payment_attempt.processing",
"created_at":958793503,
"data":{
"id":"pat_ahfafooi7ibakbfahoan",
"object":"payment_attempt",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
....
.... ///Entire payment_attempt object
....
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
payment_attempt.succeeded
{
"type":"payment_attempt.succeeded",
"created_at":958793503,
"data":{
"id":"pat_ahfafooi7ibakbfahoan",
"object":"payment_attempt",
"payin":"pay_bfiuafuiafianifnao",
"created_at":7942792,
....
.... ///Entire payment_attempt object
....
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
Other Events:
These events are created and triggered when something interesting happens with the escrow object not related to a status change.
Event | Description | Default (on/off) |
---|---|---|
escrow.created | A escrow object is created | Off |
escrow.expired | An active escrow object gets expired | On |
escrow.tax_invoice_generated | Triggered when Tazapay generates an invoice | On |
escrow.created
{
"type":"escrow.created",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin":"pay_aohfoahnofanofna",
.....
..... //Entire escrow object
.....
},
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.expired
{
"type":"escrow.expired",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "pay_aofnoianfoanfnafn",
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.tax_invoice_generated
{
"type":"escrow.tax_invoice_generated",
"created_at":"2024-04-01T08:04:47.649905272Z",
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "esc_ahfafooi7ibakbfahoan",
"payment_status":"paid",
"transaction_documents":[
{
"type":"tax_invoice",
"url": "https://transacion.tazapay.com/invoice/download/invoiceDownload?U2FsdGVkX1/TvmUkxGLBYS/vAmk7l7wuzs2poo/pLQjjbITj8mVX0siR7guU3zA7goWnX3hLmWc2gtNdCoQv0g=="
}
],
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
Document Verification Events:
These are the events created and triggered when documents for the escrow needs to be uploaded by the merchant. The merchant uploads the document(s) either through the document API or from the dashboard.
Event | Description (Triggered when) | Default (on/off) |
---|---|---|
escrow.verification.processing | The verification_status of the release document changes to processing | On |
escrow.verification.requires_action | The verification_status of the release document changes to requires_action. This also contains the details of the action required. | On |
escrow.verification.succeeded | The verification_status of the release document changes to verified | On |
escrow.verification.failed | The verification_status of the release document changes to failed | On |
escrow.verification.requires_action
{
"type":"escrow.verification.requires_action",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "pay_aofnoianfoanfnafn",
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.verification.processing
{
"type":"escrow.verification.processing",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "pay_aofnoianfoanfnafn",
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.verification.succeeded
{
"type":"escrow.verification.succeeded",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "pay_aofnoianfoanfnafn",
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
escrow.verification.failed
{
"type":"escrow.verification.failed",
"created_at":958793503,
"data":{
"id":"esc_ahfafooi7ibakbfahoan",
"object":"escrow",
"payin" : "pay_aofnoianfoanfnafn",
....
.... //Entire escrow object
....
}
"id":"evt_auigfianfoangohuehg",
"object":"event"
}
Updated 8 months ago