Add Webhooks
apiLegacyLast updated: October 12th 2021, @ 6:58:00 pm
Add webhooks to your integration, to listen for the following events:
- Buyer approval
- Authorize an order
- Void an authorization
- Capture an authorization or an order
- Refund a capture
First set up a webhooks integration. Then listen for Orders API events using the following event names:
| Checkout flow | Event name | Related API endpoints |
|---|---|---|
| Buyer approval | CHECKOUT.ORDER.APPROVED | n/a |
| Authorize an order | PAYMENT.AUTHORIZATION.CREATED | /v2/checkout/orders/order_id/authorize |
| Void an authorization | PAYMENT.AUTHORIZATION.VOIDED | /v2/payments/authorizations/authorization_id/void |
| Capture an order or authorization | PAYMENT.CAPTURE.COMPLETED | /v2/checkout/orders/order_id/capture /v2/payments/authorizations/authorization_id/capture |
PAYMENT.CAPTURE.DENIED | /v2/checkout/orders/order_id/capture /v2/payments/authorizations/authorization_id/capture | |
PAYMENT.CAPTURE.PENDING | /v2/checkout/orders/order_id/capture /v2/payments/authorizations/authorization_id/capture | |
| Refund a capture | PAYMENT.CAPTURE.REFUNDED | /v2/payments/captures/capture_id/refund |