Webhook event names

PayPal supports these webhook events.

Note: The following tables are sorted by webhook event name in ascending order.

Billing plans and agreements

Event Triggered when Related method
BILLING.PLAN.CREATED A billing plan is created. Create billing plan
BILLING.PLAN.UPDATED A billing plan is updated. Update billing plan
BILLING.SUBSCRIPTION.CANCELLED A billing agreement is canceled. Cancel agreement
BILLING.SUBSCRIPTION.CREATED A billing agreement is created. Create agreement
BILLING.SUBSCRIPTION.RE-ACTIVATED A billing agreement is re-activated. Re-activate agreement
BILLING.SUBSCRIPTION.SUSPENDED A billing agreement is suspended. Suspend agreement
BILLING.SUBSCRIPTION.UPDATED A billing agreement is updated. Update agreement

Orders

Event Triggered when Related method
CHECKOUT.ORDER.PROCESSED A checkout order was processed. Orders API

Marketplaces

Event Triggered when Related method
CHECKOUT.ORDER.PROCESSED See CHECKOUT.ORDER.PROCESSED.
CUSTOMER.ACCOUNT-LIMITATION.ADDED A limitation is added for a partner's merchant account. Update merchant account
CUSTOMER.ACCOUNT-LIMITATION.ESCALATED A limitation is escalated for a partner's merchant account. Update merchant account
CUSTOMER.ACCOUNT-LIMITATION.LIFTED A limitation is lifted for a partner's merchant account. Update merchant account
CUSTOMER.ACCOUNT-LIMITATION.UPDATED A limitation is updated for a partner's merchant account. Update merchant account
MERCHANT.ONBOARDING.COMPLETED See MERCHANT.ONBOARDING.COMPLETED.
MERCHANT.PARTNER-CONSENT.REVOKED See MERCHANT.PARTNER-CONSENT.REVOKED.
PAYMENT.CAPTURE.COMPLETED See PAYMENT.CAPTURE.COMPLETED.
PAYMENT.CAPTURE.DENIED See PAYMENT.CAPTURE.DENIED.
PAYMENT.CAPTURE.REFUNDED See PAYMENT.CAPTURE.REFUNDED.
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED See PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED.
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED See PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED.

Customer disputes

Event Triggered when Related method
CUSTOMER.DISPUTE.CREATED A customer dispute is created. Customer Disputes
CUSTOMER.DISPUTE.RESOLVED A customer dispute is resolved. Customer Disputes
CUSTOMER.DISPUTE.UPDATED A customer dispute is updated. Customer Disputes
RISK.DISPUTE.CREATED A risk dispute is created. Deprecated. No payload.

Note: The CUSTOMER.DISPUTE.CREATED event type supersedes and deprecates the RISK.DISPUTE.CREATED event type.

Log In with PayPal

Event Triggered when Related method
IDENTITY.AUTHORIZATION-CONSENT.REVOKED A user's consent token is revoked. Not applicable

Invoicing

Event Triggered when Related method
INVOICING.INVOICE.CANCELLED A merchant or customer cancels an invoice. Cancel invoice
INVOICING.INVOICE.CREATED An invoice is created. Create draft invoice
INVOICING.INVOICE.PAID An invoice is paid, partially paid, or payment is made and is pending. Mark invoice as paid
INVOICING.INVOICE.REFUNDED An invoice is refunded or partially refunded. Mark invoice as refunded
INVOICING.INVOICE.SCHEDULED An invoice is scheduled. Schedule invoice
INVOICING.INVOICE.UPDATED An invoice is updated. Update invoice

Merchant onboarding

Event Triggered when Related method
MERCHANT.ONBOARDING.COMPLETED A merchant completes setup. Marketplaces Connected Path Onboarding
The consents for a merchant account setup are revoked or an account is closed. Marketplaces Connected Path Onboarding

Authorized payments

Event Triggered when Related method
PAYMENT.AUTHORIZATION.CREATED A payment authorization is created, approved, executed, or a future payment authorization is created. Create payment with intent set to authorize
PAYMENT.AUTHORIZATION.VOIDED A payment authorization is voided. Void authorization

Note: PayPal supports only PayPal authorizations.

Capture authorized payments

Event Triggered when Related method
PAYMENT.CAPTURE.COMPLETED A payment capture completes. Show captured payment details
PAYMENT.CAPTURE.DENIED A payment capture is denied. Show captured payment details
PAYMENT.CAPTURE.PENDING The state of a payment capture changes to pending. Show captured payment details
PAYMENT.CAPTURE.REFUNDED A merchant refunds a payment capture. Refund captured payment
PAYMENT.CAPTURE.REVERSED PayPal reverses a payment capture. Refund captured payment

Payment orders

Event Triggered when Related method
PAYMENT.ORDER.CANCELLED A payment order is canceled. Void order
PAYMENT.ORDER.CREATED A payment order is created. Create payment

Batch payouts

Event Triggered when Related method
PAYMENT.PAYOUTSBATCH.DENIED A batch payout payment is denied. Show payout details
PAYMENT.PAYOUTSBATCH.PROCESSING The state of a batch payout payment changes to processing. Show payout details
PAYMENT.PAYOUTSBATCH.SUCCESS A batch payout payment completes successfully. Show payout details
PAYMENT.PAYOUTS-ITEM.BLOCKED A payouts item was blocked. Show payout item details
PAYMENT.PAYOUTS-ITEM.CANCELED A payouts item is canceled. Cancel unclaimed payout item
PAYMENT.PAYOUTS-ITEM.DENIED A payouts item is denied. Show payout item details
PAYMENT.PAYOUTS-ITEM.FAILED A payouts item fails. Show payout item details
PAYMENT.PAYOUTS-ITEM.HELD A payouts item is held. Show payout item details
PAYMENT.PAYOUTS-ITEM.REFUNDED A payouts item is refunded. Show payout item details
PAYMENT.PAYOUTS-ITEM.RETURNED A payouts item is returned. Show payout item details
PAYMENT.PAYOUTS-ITEM.SUCCEEDED A payouts item succeeds. Show payout item details
PAYMENT.PAYOUTS-ITEM.UNCLAIMED A payouts item is unclaimed. Show payout item details

Note: The PAYOUTSBATCH webhooks do not contain item-related information.

To get item-related information, use the HATEOAS links from the webhooks response.

Referenced payouts

Event Triggered when Related method
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED Funds were disbursed to the seller and partner. Create referenced payout item
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED Disbursment of funds were attempted, but failed to send. Create referenced payout item

Sales

Event Triggered when Related method
PAYMENT.SALE.COMPLETED A sale completes. Show sale details
PAYMENT.SALE.DENIED The state of a sale changes from pending to denied. Show sale details
PAYMENT.SALE.PENDING The state of a sale changes to pending. Show sale details
PAYMENT.SALE.REFUNDED A merchant refunds a sale. Refund sale
PAYMENT.SALE.REVERSED PayPal reverses a sale. Refund sale

Vault

Event Triggered when Related method
VAULT.CREDIT-CARD.CREATED A credit card is created. Store credit card
VAULT.CREDIT-CARD.DELETED A credit card is deleted. Delete vaulted credit card
VAULT.CREDIT-CARD.UPDATED A credit card is updated. Update vaulted credit card

Additional information

Feedback

Have feedback?

Let us know.