For the exhaustive schema-derived catalog, see all examples.
What it is
Handle WhatsApp payment status updates.Before you begin
- Create a public HTTPS endpoint in your application.
- Configure a YCloud webhook endpoint for the event types you need.
- Store the endpoint signing secret securely.
- Make event processing idempotent.
How it works
YCloud sends an HTTPPOST request when the event occurs. Verify the signature, durably record the event, return a 2xx response, and process slow work asynchronously.
Request
The scenarios below show requests delivered to your webhook URL. Treat the eventid as the delivery identifier and use type to route the payload.
Response
Return a2xx status after accepting the event.
For endpoint setup, signature validation, and retry behavior, see Configure webhooks.
Payment transaction updated
You receive updates via webhooks when the status of the user-initiated transaction changes. It occurs when payment status changes tocaptured (when the payment is successfully completed), or pending (when the user attempted but yet to receive success transactions signal).
Request
Response
Acknowledge the delivery after durably accepting the event.Explanation
- To send order details messages to receive payments, see Order Details template message and Interactive Order Details message.
- Once the customer attempted the payment, you will receive payment updates. To notify the customer with the order status, see Order Status template message and Interactive Order Status message.