REST API - Which webhook event for payment recieved

[Corbo152]

Hi,

I have paypal business account set up for donations, i am wanting our in house software to receive a notification when a donation is recieved,

i have created a HTTP listener ready for this, however i am confused as to which event i need to subscribe to as the names are confusing

Can anyone tell me which event i need to hook to in order to receive a HTTP POST to the listener when a donation is recieved

Thanks

[Nimja]

I would like to know this as well. Specifically, which webhook would I need for *successful* donations?

For example, eChecks would get a pending notification first....

[donald-duck]

I would like to join this question also. I prepared sandbox setup and registered webhook notifications this way (note that notification url is changed to dummy value).

curl -X POST \
https://api.sandbox.paypal.com/v1/notifications/webhooks \
-H 'Authorization: Bearer [secret]' \
-H 'Content-Type: application/json' \
-d '{"url":"https://secretrequestbin.x.pipedream.net","event_types":[{"name":"BILLING.PLAN.ACTIVATED","descripti... billing plan is activated.","status":"ENABLED"},{"name":"BILLING.PLAN.CREATED","description":"A billing plan is created.","status":"ENABLED"},{"name":"BILLING.PLAN.DEACTIVATED","description":"A billing plan is deactivated.","status":"ENABLED"},{"name":"BILLING.PLAN.PRICING-CHANGE.ACTIVATED","description":"A billing plan pricing change is activated.","status":"ENABLED"},{"name":"BILLING.PLAN.PRICING-CHANGE.INPROGRESS","description":"A billing plan pricing change is being processed.","status":"ENABLED"},{"name":"BILLING.PLAN.UPDATED","description":"A billing plan is updated.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.ACTIVATED","description":"A billing agreement is activated.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.CANCELLED","description":"A billing agreement is canceled.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.CREATED","description":"A billing agreement is created.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.EXPIRED","description":"A billing agreement is expired.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.PAYMENT.FAILED","description":"Subscription payment failure will trigger this webhook event.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.RE-ACTIVATED","description":"A billing agreement is re-activated.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.RENEWED","description":"A billing agreement is renewed.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.SUSPENDED","description":"A billing agreement is suspended.","status":"ENABLED"},{"name":"BILLING.SUBSCRIPTION.UPDATED","description":"A billing agreement is updated.","status":"ENABLED"},{"name":"CATALOG.PRODUCT.CREATED","description":"Product created","status":"ENABLED"},{"name":"CATALOG.PRODUCT.UPDATED","description":"Product updated","status":"ENABLED"},{"name":"CHECKOUT.CHECKOUT.BUYER-APPROVED","description":"Express checkout payment is created and approved by buyer.","status":"ENABLED"},{"name":"CHECKOUT.ORDER.APPROVED","description":"An order has been approved by buyer.","status":"ENABLED"},{"name":"CHECKOUT.ORDER.COMPLETED","description":"Webhook event emitted after all the purchase_units have been processed","status":"ENABLED"},{"name":"CHECKOUT.ORDER.SAVED","description":"This event is triggered as AS2 Order is saved.","status":"ENABLED"},{"name":"CHECKOUT.ORDER.VOIDED","description":"This event is triggered as AS2 Order is voided.","status":"ENABLED"},{"name":"CUSTOMER.DISPUTE.CREATED","description":"A customer dispute is created.","status":"ENABLED"},{"name":"CUSTOMER.DISPUTE.RESOLVED","description":"A customer dispute is resolved.","status":"ENABLED"},{"name":"CUSTOMER.DISPUTE.UPDATED","description":"A customer dispute is updated.","status":"ENABLED"},{"name":"CUSTOMER.MANAGED-ACCOUNT.CREATED","description":"Webhook event emitted after the non-loginable account have been created.","status":"ENABLED"},{"name":"CUSTOMER.MANAGED-ACCOUNT.RISK-ASSESSED","description":"Webhook event emitted after the account has been risk assessed or the risk assessment of the account has been changed.","status":"ENABLED"},{"name":"CUSTOMER.MANAGED-ACCOUNT.UPDATED","description":"Webhook event emitted after the non-loginable account have been updated.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.CAPABILITY-UPDATED","description":"This event is triggered as a notification for capability change.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.PRODUCT-SUBSCRIPTION-UPDATED","description":"This event is triggered as a notification for production subscription status change.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.SELLER-ALREADY-INTEGRATED","description":"This event is triggered as a notification for when seller goes through ISU flow but is already fully integrated with partner.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.SELLER-CONSENT-GRANTED","description":"This event is triggered as a notification for when seller grants the requested consents to partner.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.SELLER-EMAIL-CONFIRMED","description":"This event is triggered as a notification for when seller confirms email.","status":"ENABLED"},{"name":"CUSTOMER.MERCHANT-INTEGRATION.SELLER-ONBOARDING-INITIATED","description":"This event is triggered as a notification for when seller starts to create an account through partner flow.","status":"ENABLED"},{"name":"CUSTOMER.PAYOUT.COMPLETED","description":"The webhook event payload for the `CUSTOMER.PAYOUT.COMPLETED` event.","status":"ENABLED"},{"name":"CUSTOMER.PAYOUT.FAILED","description":"The webhook event payload for the `CUSTOMER.PAYOUTS.FAILED` event.","status":"ENABLED"},{"name":"IDENTITY.AUTHORIZATION-CONSENT.REVOKED","description":"User consents for merchant were revoked.","status":"ENABLED"},{"name":"INVOICING.INVOICE.CANCELLED","description":"A merchant or customer cancels an invoice.","status":"ENABLED"},{"name":"INVOICING.INVOICE.CREATED","description":"An invoice is created.","status":"ENABLED"},{"name":"INVOICING.INVOICE.PAID","description":"An invoice is paid, partially paid, or payment is made and is pending.","status":"ENABLED"},{"name":"INVOICING.INVOICE.REFUNDED","description":"An invoice is refunded or partially refunded.","status":"ENABLED"},{"name":"INVOICING.INVOICE.SCHEDULED","description":"An invoice is scheduled.","status":"ENABLED"},{"name":"INVOICING.INVOICE.UPDATED","description":"An invoice is updated.","status":"ENABLED"},{"name":"MERCHANT.ONBOARDING.COMPLETED","description":"A merchant completes setup.","status":"ENABLED"},{"name":"MERCHANT.PARTNER-CONSENT.REVOKED","description":"The consents for a merchant account setup are revoked or an account is closed.","status":"ENABLED"},{"name":"PAYMENT-NETWORKS.ALTERNATIVE-PAYMENT.COMPLETED","description":"Webhook event payload to send for Alternative Payment Completion.","status":"ENABLED"},{"name":"PAYMENT.AUTHORIZATION.CREATED","description":"A payment authorization is created, approved, executed, or a future payment authorization is created.","status":"ENABLED"},{"name":"PAYMENT.AUTHORIZATION.VOIDED","description":"A payment authorization is voided.","status":"ENABLED"},{"name":"PAYMENT.CAPTURE.COMPLETED","description":"A payment capture completes.","status":"ENABLED"},{"name":"PAYMENT.CAPTURE.DENIED","description":"A payment capture is denied.","status":"ENABLED"},{"name":"PAYMENT.CAPTURE.PENDING","description":"The state of a payment capture changes to pending.","status":"ENABLED"},{"name":"PAYMENT.CAPTURE.REFUNDED","description":"A merchant refunds a payment capture.","status":"ENABLED"},{"name":"PAYMENT.CAPTURE.REVERSED","description":"PayPal reverses a payment capture.","status":"ENABLED"},{"name":"PAYMENT.ORDER.CANCELLED","description":"A payment order is canceled.","status":"ENABLED"},{"name":"PAYMENT.ORDER.CREATED","description":"A payment order is created.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.BLOCKED","description":"A payouts item was blocked.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.CANCELED","description":"A payouts item is canceled.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.DENIED","description":"A payouts item is denied.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.FAILED","description":"A payouts item fails.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.HELD","description":"A payouts item is held.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.REFUNDED","description":"A payouts item is refunded.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.RETURNED","description":"A payouts item is returned.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.SUCCEEDED","description":"A payouts item succeeds.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTS-ITEM.UNCLAIMED","description":"A payouts item is unclaimed.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTSBATCH.DENIED","description":"A batch payout payment is denied.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTSBATCH.PROCESSING","description":"The state of a batch payout payment changes to processing.","status":"ENABLED"},{"name":"PAYMENT.PAYOUTSBATCH.SUCCESS","description":"A batch payout payment completes successfully.","status":"ENABLED"},{"name":"PAYMENT.REFUND.COMPLETED","description":"This event is triggered when merchant does non referenced credit.","status":"ENABLED"},{"name":"PAYMENT.SALE.COMPLETED","description":"A sale completes.","status":"ENABLED"},{"name":"PAYMENT.SALE.DENIED","description":"The state of a sale changes from pending to denied.","status":"ENABLED"},{"name":"PAYMENT.SALE.PENDING","description":"The state of a sale changes to pending.","status":"ENABLED"},{"name":"PAYMENT.SALE.REFUNDED","description":"A merchant refunds a sale.","status":"ENABLED"},{"name":"PAYMENT.SALE.REVERSED","description":"PayPal reverses a sale.","status":"ENABLED"},{"name":"PAYMENTS.PAYMENT.CREATED","description":"Checkout payment is created and approved by buyer.","status":"ENABLED"},{"name":"PAYMENT_NETWORKS.INSTRUMENT.LINKED-ACCOUNT-UPDATED","description":"Webhook event emitted after an instrument was successfully added from the banking partner..","status":"ENABLED"},{"name":"VAULT.CREDIT-CARD.CREATED","description":"A credit card is created.","status":"ENABLED"},{"name":"VAULT.CREDIT-CARD.DELETED","description":"A credit card is deleted.","status":"ENABLED"},{"name":"VAULT.CREDIT-CARD.UPDATED","description":"A credit card is updated.","status":"ENABLED"},{"name":"VAULT.PAYMENT-TOKEN.CREATED","description":"This webhook is triggered after a Payment Token has been created.","status":"ENABLED"},{"name":"VAULT.PAYMENT-TOKEN.DELETED","description":"This webhook is triggered on successful deletion of a payment token.","status":"ENABLED"},{"name":"VAULT.PAYMENT-TOKEN.DELETION-INITIATED","description":"This webhook is triggered when the deletion of payment method token is initiated. This is currently triggered for PayPal use cases.","status":"ENABLED"}]}'

These are all possible notifications. I checked a list of registered on the account webhooks , my webhook subscription seems to be active:

{

"webhooks": [

{

"id": "7PA69543N6744814E",

"url": "https://secretrequestbin.x.pipedream.net",

"event_types": [

{

"name": "BILLING.PLAN.ACTIVATED",

"description": "A billing plan is activated.",

"status": "ENABLED"

},

....

I made test donation transaction and I can see it with confirmed status on my sandbox account transactions list. My requestbin is empty, also developer console shows empty webhook notifications under sandbox tab.

I used such scope setup when fetching OAuth access token (used later to register webhook): "https://api.paypal.com/v1/payments/.* https://uri.paypal.com/services/invoicing https://uri.paypal.com/services/reporting/search/read https://uri.paypal.com/services/disputes/update-seller openid https://uri.paypal.com/services/disputes/read-seller https://uri.paypal.com/payments/payouts https://uri.paypal.com/services/applications/webhooks".

Is there something I missed or just donations are not supported by any notification?