Checkout Webhooks

When a checkout is created on behalf of an entity (Checkout OBO), all webhook payloads include the on_behalf_of field (the entity ID) in the data object. This field is omitted when OBO is not used.

Payment_Status-specific events:

These are the events created and triggered when the payment_status of the checkout object changes.

Event	Description	Default (on/off)
checkout.paid	payment_status of the checkout object changes to paid.	On

checkout.paid

JSON

{
  "type":"checkout.paid",
  "created_at":958793503,
  "data":{
    "id":"chk_ahfafooi7ibakbfahoan",
    "object":"checkout",
    "payin":"pay_bfiuafuiafianifnao",
    "created_at":7942792,
    "expiry_at":7967893,
    "status":"expired",
    "payment_status":"paid",
    "invoice_currency":"usd",
    "amount":"6700",
    "customer_details":{
      "country":"US",
      "email":"[e-mail]",
      "name":"Adam Smith",
      "phone":{
        "country_code":"65",
        "number":"67894321"
      }
    },
    "transaction_description":"1 x Item",
    "reference_id":"55679-7657",
    "on_behalf_of":"ent_d3inm6ami8u10oqfm",
    "metadata":{},
    ......
    ...... //Entire checkout 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	Off
payment_attempt.succeeded	When the payment_attempt succeeds	On

payment_attempt.created

JSON

{
  "type":"payment_attempt.requires_action",
  "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

JSON

{
  "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

JSON

{
  "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

JSON

{
  "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 checkout object not related to a status change.

Event	Description	Default (on/off)
checkout.created	A checkout object is created	Off
checkout.expired	An active checkout object gets expired	On
checkout.tax_invoice_generated	Triggered when Tazapay generates a tax invoice	On

checkout.created

JSON

{
  "type":"checkout.created",
  "created_at":958793503,
  "data":{
    "id":"chk_ahfafooi7ibakbfahoan",
    "object":"checkout",
    "payin":"pay_aohfoahnofanofna",
    "on_behalf_of":"ent_d3inm6ami8u10oqfm",
    .....
    ..... //Entire Checkout object
    .....
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

checkout.expired

JSON

{
  "type":"checkout.expired",
  "created_at":958793503,
  "data":{
    "id":"chk_ahfafooi7ibakbfahoan",
    "object":"checkout",
    "payin" : "pay_aofnoianfoanfnafn",
    "on_behalf_of":"ent_d3inm6ami8u10oqfm",
    ....
    .... //Entire checkout object
    ....
  }
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

checkout.tax_invoice_generated

JSON

{
  "type":"checkout.tax_invoice_generated",
  "created_at":"2024-04-01T08:04:47.649905272Z",
  "data":{
    "id":"chk_ahfafooi7ibakbfahoan",
    "object":"checkout",
    "payin" : "pay_aofnoianfoanfnafn",
    "payment_status":"paid",
    "transaction_documents":[
 		 {
    	"type":"tax_invoice",
   	  "url": "https://transacion.tazapay.com/invoice/download/invoiceDownload?U2FsdGVkX1/TvmUkxGLBYS/vAmk7l7wuzs2poo/pLQjjbITj8mVX0siR7guU3zA7goWnX3hLmWc2gtNdCoQv0g=="
  	 }
		],
    ....
    .... //Entire checkout object
    ....
  }  
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}