Webhooks
Paytree provides webhook support to keep you informed of payment status updates. When important events occur— such as changes in payment status, failed attempts, or successful transactions—we will send relevant data to the callback URL you specify.
It is essential to implement webhook handling on your server to receive these updates in real time. This will allow you to keep your system in sync with payment events and take appropriate actions based on the information received.
Ensure that your callback URL is publicly accessible and capable of securely processing the incoming webhook data. Proper handling of webhooks is critical to maintaining a smooth payment process and ensuring your system stays up-to-date.
Callback Flow
Paytree webhooks allow you to receive real-time payment updates by sending data to the callback URL you specify. The flow is as follows:
GET Request to Callback URL: Paytree sends a GET request to the callback URL you provide, containing key parameters like Payment Intent ID and Transaction ID.
Extract Parameters: You need to extract the Payment Intent ID and Transaction ID from the request to identify the relevant payment.
Lookup Payment Details: Use the Payment Intent ID to make an API request to Paytree, retrieving the latest payment information and status.
You must respond with a HTTP status code of 200. Any other status code will result in a total 10 consecutive retry attempts, spaced 30 seconds apart.
Adhering to this flow ensures your system is up-to-date with the latest payment data and status changes.
Callback URL Tags
When setting up your callback URL for Paytree webhooks, you can use special tags to dynamically represent key values such as the Payment Intent ID and Transaction ID. These tags are replaced by Paytree with the actual data when sending the webhook request.
{payment_intent_id}: This tag represents the Payment Intent ID that Paytree generates when you create a payment intent. You will need to use this ID to perform the lookup for the latest payment details.
{transaction_id}: This tag represents the transaction_ref that you provide when creating a payment. This will be included in the webhook data to help you match the payment with your system.
You can place these tags in your callback URL, and Paytree will automatically replace them with the corresponding values in the webhook request. For example, your callback URL might look like this:
When the webhook is triggered, Paytree will replace the tags with actual values, so the resulting URL might look like this:
Last updated