List event notifications
GET {{base_url}}/v1/notifications/webhooks-events
Lists webhooks event notifications. Use query parameters to filter the response.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page_size | number | The number of webhook event notifications to return in the response. | |
start_time | string | Filters the webhook event notifications in the response to those created on or after this date and time and on or before the end_time value. Both values are in Internet date and time format format. Example: start_time=2013-03-06T11:00:00Z . | |
end_time | string | Filters the webhook event notifications in the response to those created on or after the start_time and on or before this date and time. Both values are in Internet date and time format format. Example: end_time=2013-03-06T11:00:00Z . | |
transaction_id | string | Filters the response to a single transaction, by ID. | |
event_type | string | Filters the response to a single event. | |
move_to | string | ||
offset | number | ||
prev_offset | number | ||
index_id | number |
RESPONSES
status: OK
{"events":[{"id":"WH-2CL46544TB770421K-5VB92446WP7345818","create_time":"2022-02-02T00:23:12.336Z","resource_type":"capture","event_type":"PAYMENT.CAPTURE.COMPLETED","summary":"Payment completed for $ 100.0 USD","resource":{"disbursement_mode":"INSTANT","amount":{"value":"100.00","currency_code":"USD"},"seller_protection":{"status":"NOT_ELIGIBLE"},"supplementary_data":{"related_ids":{"order_id":"89T257400V0473133"}},"update_time":"2022-02-02T00:22:38Z","create_time":"2022-02-02T00:22:38Z","final_capture":true,"seller_receivable_breakdown":{"paypal_fee":{"value":"3.98","currency_code":"USD"},"gross_amount":{"value":"100.00","currency_code":"USD"},"net_amount":{"value":"96.02","currency_code":"USD"}},"processor_response":{"cvv_code":"M","response_code":"0000","avs_code":"A"},"links":[{"method":"GET","rel":"self","href":"https://api.sandbox.paypal.com/v2/payments/captures/29Y24445UY2083144"},{"method":"POST","rel":"refund","href":"https://api.sandbox.paypal.com/v2/payments/captures/29Y24445UY2083144/refund"},{"method":"GET","rel":"up","href":"https://api.sandbox.paypal.com/v2/checkout/orders/89T257400V0473133"}],"id":"29Y24445UY2083144","status":"COMPLETED"},"links":[{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-2CL46544TB770421K-5VB92446WP7345818","rel":"self","method":"GET","encType":"application/json"},{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-2CL46544TB770421K-5VB92446WP7345818/resend","rel":"resend","method":"POST","encType":"application/json"}],"event_version":"1.0","resource_version":"2.0"}],"count":1}