Webhook event names

APICurrentLast updated: April 27th 2022, @ 10:33:48 am


PayPal supports these webhook events.

Authorized and captured payments

The webhooks for authorizing and capturing payments correspond to both supported versions of the Payments API:

Note: PayPal supports only PayPal authorizations.

V2

EventTriggerRelated method
PAYMENT.AUTHORIZATION.CREATEDA payment authorization is created, approved, executed, or a future payment authorization is created.Capture authorized payment
PAYMENT.AUTHORIZATION.VOIDEDA payment authorization is voided.Show details for authorized payment with response status of voided.
PAYMENT.CAPTURE.COMPLETEDA payment capture completes.Capture authorized payment with response status of completed.
PAYMENT.CAPTURE.DENIEDA payment capture is denied.Show details for authorized payment with response status of denied.
PAYMENT.CAPTURE.PENDINGThe state of a payment capture changes to pending.Show details for authorized payment with response status of pending.
PAYMENT.CAPTURE.REFUNDEDA merchant refunds a payment capture.Capture authorized payment with response status of refunded.
PAYMENT.CAPTURE.REVERSEDPayPal reverses a payment capture.Refund captured payment

V1

EventTriggerRelated method
PAYMENT.AUTHORIZATION.CREATEDA payment authorization is created, approved, executed, or a future payment authorization is created.Create payment with intent set to authorize
PAYMENT.AUTHORIZATION.VOIDEDA payment authorization is voided.Void authorization
PAYMENT.CAPTURE.COMPLETEDA payment capture completes.Show captured payment details
PAYMENT.CAPTURE.DENIEDA payment capture is denied.Show captured payment details
PAYMENT.CAPTURE.PENDINGThe state of a payment capture changes to pending.Show captured payment details
PAYMENT.CAPTURE.REFUNDEDA merchant refunds a payment capture.Refund captured payment
PAYMENT.CAPTURE.REVERSEDPayPal reverses a payment capture.Refund captured payment

Batch payouts

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

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

EventTriggerRelated method
PAYMENT.PAYOUTSBATCH.DENIEDA batch payout payment is denied.Show payout details
PAYMENT.PAYOUTSBATCH.PROCESSINGThe state of a batch payout payment changes to processing.Show payout details
PAYMENT.PAYOUTSBATCH.SUCCESSA batch payout payment completes successfully.Show payout details
PAYMENT.PAYOUTS-ITEM.BLOCKEDA payouts item is blocked.Show payout item details
PAYMENT.PAYOUTS-ITEM.CANCELEDA payouts item is canceled.Cancel unclaimed payout item
PAYMENT.PAYOUTS-ITEM.DENIEDA payouts item is denied.Show payout item details
PAYMENT.PAYOUTS-ITEM.FAILEDA payouts item fails.Show payout item details
PAYMENT.PAYOUTS-ITEM.HELDA payouts item is held.Show payout item details
PAYMENT.PAYOUTS-ITEM.REFUNDEDA payouts item is refunded.Show payout item details
PAYMENT.PAYOUTS-ITEM.RETURNEDA payouts item is returned.Show payout item details
PAYMENT.PAYOUTS-ITEM.SUCCEEDEDA payouts item succeeds.Show payout item details
PAYMENT.PAYOUTS-ITEM.UNCLAIMEDA payouts item is unclaimed.Show payout item details

Billing plans and agreements

Deprecation notice: The billing plans and agreements webhooks are deprecated along with the Billing Agreements REST API.

EventTriggerRelated method
BILLING.PLAN.CREATEDA billing plan is created.Create billing plan
BILLING.PLAN.UPDATEDA billing plan is updated.Update billing plan
BILLING.SUBSCRIPTION.CANCELLEDA billing agreement is canceled.Cancel agreement
BILLING.SUBSCRIPTION.CREATEDA billing agreement is created.Create agreement
BILLING.SUBSCRIPTION.RE-ACTIVATEDA billing agreement is re-activated.Re-activate agreement
BILLING.SUBSCRIPTION.SUSPENDEDA billing agreement is suspended.Suspend agreement
BILLING.SUBSCRIPTION.UPDATEDA billing agreement is updated.Update agreement

Log in with PayPal

EventTriggerRelated method
IDENTITY.AUTHORIZATION-CONSENT.REVOKEDA user's consent token is revoked.Not applicable

Checkout buyer approval

EventTriggered whenRelated method
PAYMENTS.PAYMENT.CREATEDCheckout payment is created and approved by buyer.Payment details
CHECKOUT.ORDER.APPROVEDSee Orders.
CHECKOUT.CHECKOUT.BUYER-APPROVEDExpress checkout payment is created and approved by buyer.Express Checkout

Disputes

EventTriggerRelated method
CUSTOMER.DISPUTE.CREATEDA dispute is created.N/A
CUSTOMER.DISPUTE.RESOLVEDA dispute is resolved.Settle dispute
CUSTOMER.DISPUTE.UPDATEDA dispute is updated.Partially update dispute
RISK.DISPUTE.CREATEDA risk dispute is created.The CUSTOMER.DISPUTE.CREATED event type supersedes and deprecates this event type.

Invoicing

EventTriggerRelated method
INVOICING.INVOICE.CANCELLEDA merchant or customer cancels an invoice.Cancel invoice
INVOICING.INVOICE.CREATEDAn invoice is created.Create draft invoice
INVOICING.INVOICE.PAIDAn invoice is paid, partially paid, or payment is made and is pending.Mark invoice as paid
INVOICING.INVOICE.REFUNDEDAn invoice is refunded or partially refunded.Mark invoice as refunded
INVOICING.INVOICE.SCHEDULEDAn invoice is scheduled.Schedule invoice
INVOICING.INVOICE.UPDATEDAn invoice is updated.Update invoice

Marketplaces and Platforms

EventTriggered WhenRelated method
CHECKOUT.ORDER.COMPLETEDSee CHECKOUT.ORDER.COMPLETED.
CHECKOUT.ORDER.APPROVEDSee CHECKOUT.ORDER.APPROVED.
CHECKOUT.ORDER.PROCESSEDSee CHECKOUT.ORDER.PROCESSED.
CUSTOMER.ACCOUNT-LIMITATION.ADDEDA limitation is added for a partner's managed account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.ESCALATEDA limitation is escalated for a partner's managed account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.LIFTEDA limitation is lifted for a partner's managed account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.UPDATEDA limitation is updated for a partner's managed account.Update managed account
CUSTOMER.MERCHANT-INTEGRATION.CAPABILITY-UPDATEDPayPal must enable the merchant's account as PPCP for this webhook to work.Create partner referral
CUSTOMER.MERCHANT-INTEGRATION.PRODUCT-SUBSCRIPTION-UPDATEDThe products available to the merchant have changed.Create partner referral
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ALREADY-INTEGRATEDMerchant onboards again to a partner.Create partner referral
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ONBOARDING-INITIATEDPayPal creates a merchant account from the partner's onboarding link.Create partner referral
CUSTOMER.MERCHANT-INTEGRATION.SELLER-CONSENT-GRANTEDMerchant grants consents to a partner.Create partner referral
CUSTOMER.MERCHANT-INTEGRATION.SELLER-EMAIL-CONFIRMEDMerchant confirms the email and consents are granted.Create partner referral
MERCHANT.ONBOARDING.COMPLETEDMerchant completes setup.See MERCHANT.ONBOARDING.COMPLETED in Merchant onboarding
MERCHANT.PARTNER-CONSENT.REVOKEDThe consents for a merchant account setup are revoked or an account is closed.See MERCHANT.PARTNER-CONSENT.REVOKED in Merchant onboarding
PAYMENT.CAPTURE.COMPLETEDA payment capture completes.See PAYMENT.CAPTURE.COMPLETED in Authorized and captured payments
PAYMENT.CAPTURE.DENIEDA payment capture is denied.See PAYMENT.CAPTURE.DENIED in Authorized and captured payments
PAYMENT.CAPTURE.REFUNDEDA merchant refunds a payment capture.See PAYMENT.CAPTURE.REFUNDED in Authorized and captured payments
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETEDFunds are disbursed to the seller and partner.See PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETE in Authorized and captured payments
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILEDAttempt to disburse funds fails.See PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED in Authorized and captured payments

Merchant onboarding

EventTriggerRelated method
MERCHANT.ONBOARDING.COMPLETEDA merchant completes setup.Seller Onboarding
MERCHANT.PARTNER-CONSENT.REVOKEDThe consents for a merchant account setup are revoked or an account is closed.Seller Onboarding
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-CREATEDManaged account has been created.Managed Path Onboarding
CUSTOMER.MANAGED-ACCOUNT.CREATION-FAILEDManaged account creation failed.Managed Path Onboarding
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATEDManaged account has been updated.Managed Path Onboarding
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGEDCapabilities and/or process status has been changed on a managed account.Managed Path Onboarding
CUSTOMER.MANAGED-ACCOUNT.RISK-ASSESSEDManaged account has been risk assessed or the risk assessment has been changed.Managed Path Onboarding
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-NOTIFIEDNegative balance debit has been notified on a managed account.Update managed account
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-DEBIT-INITIATEDNegative balance debit has been initiated on a managed account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.ADDEDA limitation was added for given merchant account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.LIFTEDA limitation was lifted for given merchant account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.UPDATEDA limitation was updated for given merchant account.Update managed account
CUSTOMER.ACCOUNT-LIMITATION.ESCALATEDA limitation was escalated for given merchant account.Update managed account

Orders

The webhooks for orders correspond to both supported versions of the Orders API:

Note: The Orders webhooks are for use by Partners only.

V2

EventTriggerRelated method
CHECKOUT.ORDER.COMPLETEDA checkout order is processed.Orders API
CHECKOUT.ORDER.APPROVEDA checkout order is approved by buyerOrders API

V1

EventTriggerRelated method
CHECKOUT.ORDER.PROCESSEDA checkout order is processed.Orders API

Payment orders

EventTriggerRelated method
PAYMENT.ORDER.CANCELLEDA payment order is canceled.Void order
PAYMENT.ORDER.CREATEDA payment order is created.Create payment

Referenced payouts

EventTriggerRelated method
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETEDFunds are disbursed to the seller and partner.Create referenced payout item
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILEDAttempt to disburse funds fails.Create referenced payout item

Sales

EventTriggerRelated method
PAYMENT.SALE.COMPLETEDA sale completes.Show sale details
PAYMENT.SALE.DENIEDThe state of a sale changes from pending to denied.Show sale details
PAYMENT.SALE.PENDINGThe state of a sale changes to pending.Show sale details
PAYMENT.SALE.REFUNDEDA merchant refunds a sale.Refund sale
PAYMENT.SALE.REVERSEDPayPal reverses a sale.Refund sale

Subscriptions

WebhookTriggerRelated method
CATALOG.PRODUCT.CREATEDA product is created.Create product
CATALOG.PRODUCT.UPDATEDA product is updated.Update product
PAYMENT.SALE.COMPLETEDA payment is made on a subscription.
PAYMENT.SALE.REFUNDEDA merchant refunds a sale.
PAYMENT.SALE.REVERSEDA payment is reversed on a subscription.
BILLING.PLAN.CREATEDA billing plan is created.Create plan
BILLING.PLAN.UPDATEDA billing plan is updated.Update plan
BILLING.PLAN.ACTIVATEDA billing plan is activated.Activate plan
BILLING.PLAN.PRICING-CHANGE.ACTIVATEDA price change for the plan is activated.Update pricing
BILLING.PLAN.DEACTIVATEDA billing plan is deactivated.Deactivate plan
BILLING.SUBSCRIPTION.CREATEDA subscription is created.Create subscription
BILLING.SUBSCRIPTION.ACTIVATEDA subscription is activated.Activate subscription
BILLING.SUBSCRIPTION.UPDATEDA subscription is updated.Update subscription
BILLING.SUBSCRIPTION.EXPIREDA subscription expires.Show subscription details
BILLING.SUBSCRIPTION.CANCELLEDA subscription is cancelled.Cancel subscription
BILLING.SUBSCRIPTION.SUSPENDEDA subscription is suspended.Suspend subscription
BILLING.SUBSCRIPTION.PAYMENT.FAILEDPayment failed on subscription.Subscription failed payment details

Vault

EventTriggerRelated method
VAULT.CREDIT-CARD.CREATEDA credit card is created.Store credit card
VAULT.CREDIT-CARD.DELETEDA credit card is deleted.Delete vaulted credit card
VAULT.CREDIT-CARD.UPDATEDA credit card is updated.Update vaulted credit card

Additional information