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 | | |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status: OK
{"events":[{"id":"WH-6MU909868L179220L-65239480AR672041G","create_time":"2023-04-06T20:28:58.184Z","resource_type":"capture","event_type":"PAYMENT.CAPTURE.COMPLETED","summary":"Payment completed for $ 200.0 USD","resource":{"disbursement_mode":"INSTANT","amount":{"value":"200.00","currency_code":"USD"},"seller_protection":{"dispute_categories":["ITEM_NOT_RECEIVED","UNAUTHORIZED_TRANSACTION"],"status":"ELIGIBLE"},"supplementary_data":{"related_ids":{"order_id":"64E64612G5802414N"}},"update_time":"2023-04-06T20:33:57Z","create_time":"2023-04-06T20:28:51Z","final_capture":true,"seller_receivable_breakdown":{"paypal_fee":{"value":"7.47","currency_code":"USD"},"gross_amount":{"value":"200.00","currency_code":"USD"},"net_amount":{"value":"192.53","currency_code":"USD"}},"links":[{"method":"GET","rel":"self","href":"https://api.sandbox.paypal.com/v2/payments/captures/52909142TS941641N"},{"method":"POST","rel":"refund","href":"https://api.sandbox.paypal.com/v2/payments/captures/52909142TS941641N/refund"},{"method":"GET","rel":"up","href":"https://api.sandbox.paypal.com/v2/checkout/orders/64E64612G5802414N"}],"id":"52909142TS941641N","status":"REFUNDED"},"links":[{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-6MU909868L179220L-65239480AR672041G","rel":"self","method":"GET","encType":"application/json"},{"href":"https://api.sandbox.paypal.com/v1/notifications/webhooks-events/WH-6MU909868L179220L-65239480AR672041G/resend","rel":"resend","method":"POST","encType":"application/json"}],"event_version":"1.0","resource_version":"2.0"}],"count":1}