PayPal webhook events
96 PayPal event types in 9 resources, plus Other PayPal events. 28 have sample payloads.
Every event here can also reach agents as an MCP event through Hookdeck: MCP events →
checkout
PAYMENTS.PAYMENT.CREATED
verified from a captured delivery
PAYMENTS.PAYMENT.CREATED Buyer creates and approves a checkout payment
Identified by event_type field in the body
Resource checkout
{
"id": "WH-6W4482673W002281V-61985753LP2332451",
"event_type": "PAYMENTS.PAYMENT.CREATED",
"resource_type": "payment",
"summary": "Checkout payment is created and approved by buyer",
"create_time": "2015-05-11T21:45:15Z",
"resource": { … },
"links": [ … ],
"event_version": "1.0"
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-6W4482673W002281V-61985753LP2332451 |
Full schema: 61 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
CHECKOUT.CHECKOUT.BUYER-APPROVED
verified from a captured delivery
CHECKOUT.CHECKOUT.BUYER-APPROVED Buyer approves an Express Checkout payment
Identified by event_type field in the body
Resource checkout
{
"id": "WH-6W4482673W002281V-61985753LP2332451",
"create_time": "2018-19-12T22:20:32.000Z",
"event_type": "CHECKOUT.CHECKOUT.BUYER-APPROVED",
"event_version": "1.0",
"resource_type": "payment",
"summary": "Checkout Payment is created and approved by buyer.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-6W4482673W002281V-61985753LP2332451 |
Full schema: 14 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
CHECKOUT.ORDER.APPROVED
verified from a captured delivery
CHECKOUT.ORDER.APPROVED Buyer approves an order, ready for you to capture
Identified by event_type field in the body
Resource checkout
{
"id": "WH-COC11055RA711503B-4YM959094A144403T",
"create_time": "2018-04-16T21:21:49.000Z",
"event_type": "CHECKOUT.ORDER.APPROVED",
"resource_type": "checkout-order",
"resource_version": "2.0",
"summary": "An order has been approved by buyer",
"resource": { … },
"links": [ … ],
"event_version": "1.0"
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-COC11055RA711503B-4YM959094A144403T |
Full schema: 46 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
CHECKOUT.ORDER.COMPLETED
verified from a captured delivery
CHECKOUT.ORDER.COMPLETED Order finishes processing, for marketplaces and platforms only
Identified by event_type field in the body
Resource checkout
{
"id": "WH-COC11055RA711503B-4YM959094A144403T",
"create_time": "2018-04-16T21:21:49.000Z",
"event_type": "CHECKOUT.ORDER.COMPLETED",
"resource_type": "checkout-order",
"resource_version": "2.0",
"summary": "Checkout Order Completed",
"resource": { … },
"links": [ … ],
"zts": 1494957670
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-COC11055RA711503B-4YM959094A144403T |
Full schema: 62 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
CHECKOUT.ORDER.PROCESSED
documented No payload yet
CHECKOUT.ORDER.PROCESSED Identified by event_type field in the body
Resource checkout
No payload yet.
CHECKOUT.ORDER.CREATED
documented No payload yet
CHECKOUT.ORDER.CREATED New checkout order is created
Identified by event_type field in the body
Resource checkout
No payload yet.
CHECKOUT.ORDER.DECLINED
documented from PayPal docs (example)
CHECKOUT.ORDER.DECLINED Payment processing declines an order
Identified by event_type field in the body
Resource checkout
{
"id": "WH-1SW574877T049922Y-2X2706431J788111J",
"event_version": "1.0",
"create_time": "2022-04-05T10:37:05Z",
"resource_type": "checkout-order",
"resource_version": "2.0",
"event_type": "CHECKOUT.ORDER.DECLINED",
"summary": "An order has been declined",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-1SW574877T049922Y-2X2706431J788111J |
Full schema: 36 fields.
From PayPal docs
-
Content type
application/json
CHECKOUT.PAYMENT-APPROVAL.REVERSED
documented from PayPal docs (example)
CHECKOUT.PAYMENT-APPROVAL.REVERSED Approved payment falls through before you capture it
Identified by event_type field in the body
Resource checkout
{
"id": "WH-COC11055RA711503B-4YM959094A144403T",
"create_time": "2021-03-19T08:17:29.782Z",
"event_type": "CHECKOUT.PAYMENT-APPROVAL.REVERSED",
"summary": "A payment has been reversed after approval.",
"resource": { … },
"event_version": "1.0"
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-COC11055RA711503B-4YM959094A144403T |
Full schema: 26 fields.
From PayPal docs
-
Content type
application/json
dispute
CUSTOMER.DISPUTE.CREATED
verified from a captured delivery
CUSTOMER.DISPUTE.CREATED New dispute is opened
Identified by event_type field in the body
Resource dispute
{
"id": "WH-4M0448861G563140B-9EX36365822141321",
"event_version": "1.0",
"create_time": "2018-06-21T13:36:33.000Z",
"resource_type": "dispute",
"event_type": "CUSTOMER.DISPUTE.CREATED",
"summary": "A new dispute opened with Case # PP-000-042-663-135",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-4M0448861G563140B-9EX36365822141321 |
Full schema: 40 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
CUSTOMER.DISPUTE.RESOLVED
documented No payload yet
CUSTOMER.DISPUTE.RESOLVED Dispute reaches a resolution
Identified by event_type field in the body
Resource dispute
No payload yet.
CUSTOMER.DISPUTE.UPDATED
documented No payload yet
CUSTOMER.DISPUTE.UPDATED Dispute details change
Identified by event_type field in the body
Resource dispute
No payload yet.
RISK.DISPUTE.CREATED
documented No payload yet
RISK.DISPUTE.CREATED Older dispute event, superseded by CUSTOMER.DISPUTE.CREATED
Identified by event_type field in the body
Resource dispute
No payload yet.
invoice
INVOICING.INVOICE.CANCELLED
documented No payload yet
INVOICING.INVOICE.CANCELLED Invoice is cancelled by either party
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.CREATED
documented No payload yet
INVOICING.INVOICE.CREATED New draft invoice is created
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.PAID
documented No payload yet
INVOICING.INVOICE.PAID Invoice is paid in full or in part, or payment is pending
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.REFUNDED
documented No payload yet
INVOICING.INVOICE.REFUNDED Invoice is fully or partly refunded
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.SCHEDULED
documented No payload yet
INVOICING.INVOICE.SCHEDULED Invoice is set to send later
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.SENT
documented No payload yet
INVOICING.INVOICE.SENT Invoice goes out to its recipient
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.UPDATED
documented No payload yet
INVOICING.INVOICE.UPDATED Invoice details change
Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.INVOICE.UNPAID
documented No payload yet
INVOICING.INVOICE.UNPAID Identified by event_type field in the body
Resource invoice
No payload yet.
INVOICING.RECURRING-INVOICES.EXPIRED
documented No payload yet
INVOICING.RECURRING-INVOICES.EXPIRED Identified by event_type field in the body
Resource invoice
No payload yet.
merchant_account
CUSTOMER.ACCOUNT-LIMITATION.ADDED
documented No payload yet
CUSTOMER.ACCOUNT-LIMITATION.ADDED Managed account gets a new limitation
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.ACCOUNT-LIMITATION.ESCALATED
documented No payload yet
CUSTOMER.ACCOUNT-LIMITATION.ESCALATED Managed account's limitation is escalated
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.ACCOUNT-LIMITATION.LIFTED
documented No payload yet
CUSTOMER.ACCOUNT-LIMITATION.LIFTED Limitation comes off a managed account
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.ACCOUNT-LIMITATION.UPDATED
documented No payload yet
CUSTOMER.ACCOUNT-LIMITATION.UPDATED Managed account's limitation changes
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-CREATED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-CREATED Partner's managed account is created
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.CREATION-FAILED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.CREATION-FAILED Managed account can't be created
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-UPDATED Managed account details change
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.ACCOUNT-STATUS-CHANGED Managed account's capabilities or process status change
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.RISK-ASSESSED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.RISK-ASSESSED Managed account gets a new or changed risk assessment
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-NOTIFIED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-NOTIFIED Managed account is told of a negative balance debit
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-DEBIT-INITIATED
documented No payload yet
CUSTOMER.MANAGED-ACCOUNT.NEGATIVE-BALANCE-DEBIT-INITIATED Negative balance debit starts on a managed account
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.CAPABILITY-UPDATED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.CAPABILITY-UPDATED Merchant capability changes, on a PPCP-enabled account
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.PRODUCT-SUBSCRIPTION-UPDATED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.PRODUCT-SUBSCRIPTION-UPDATED Merchant's available products change
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ALREADY-INTEGRATED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ALREADY-INTEGRATED Merchant goes through partner onboarding again
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.SELLER-CONSENT-GRANTED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.SELLER-CONSENT-GRANTED Merchant gives a partner consent
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.SELLER-EMAIL-CONFIRMED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.SELLER-EMAIL-CONFIRMED Merchant confirms email after granting consents
Identified by event_type field in the body
Resource merchant_account
No payload yet.
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ONBOARDING-INITIATED
documented No payload yet
CUSTOMER.MERCHANT-INTEGRATION.SELLER-ONBOARDING-INITIATED Partner's onboarding link creates a merchant account
Identified by event_type field in the body
Resource merchant_account
No payload yet.
MERCHANT.ONBOARDING.COMPLETED
verified from a captured delivery
MERCHANT.ONBOARDING.COMPLETED Merchant finishes onboarding setup
Identified by event_type field in the body
Resource merchant_account
{
"id": "WH-2WR32451HC0233532-67976317FL4543714",
"create_time": "2016-08-01T21:41:28Z",
"resource_type": "merchant-onboarding",
"event_type": "MERCHANT.ONBOARDING.COMPLETED",
"resource": { … }
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-2WR32451HC0233532-67976317FL4543714 |
Full schema: 13 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
MERCHANT.PARTNER-CONSENT.REVOKED
documented No payload yet
MERCHANT.PARTNER-CONSENT.REVOKED Merchant consent is withdrawn or the account closes
Identified by event_type field in the body
Resource merchant_account
No payload yet.
payment
PAYMENT.AUTHORIZATION.CREATED
documented from PayPal docs (example)
PAYMENT.AUTHORIZATION.CREATED Payment gets authorized, including future payment authorizations
Identified by event_type field in the body
Resource payment
{
"id": "8PT597110X687430LKGECATA",
"create_time": "2013-06-25T21:41:28Z",
"resource_type": "authorization",
"event_version": "1.0",
"event_type": "PAYMENT.AUTHORIZATION.CREATED",
"summary": "A payment authorization was created",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | 8PT597110X687430LKGECATA |
Full schema: 28 fields.
From PayPal docs
-
Content type
application/json
PAYMENT.AUTHORIZATION.VOIDED
documented No payload yet
PAYMENT.AUTHORIZATION.VOIDED Authorization is voided manually or expires after 30 days
Identified by event_type field in the body
Resource payment
No payload yet.
PAYMENT.CAPTURE.COMPLETED
documented from PayPal docs (example)
PAYMENT.CAPTURE.COMPLETED Capture finishes and the order can be fulfilled
Identified by event_type field in the body
Resource payment
{
"id": "WH-3F562076HD293871E-75F399086E414290U",
"event_version": "1.0",
"create_time": "2024-05-16T05:19:19.355Z",
"resource_type": "capture",
"resource_version": "2.0",
"event_type": "PAYMENT.CAPTURE.COMPLETED",
"summary": "Payment completed for $ 500.0 USD",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-3F562076HD293871E-75F399086E414290U |
Full schema: 46 fields.
From PayPal docs
-
Content type
application/json
PAYMENT.CAPTURE.DECLINED
documented No payload yet
PAYMENT.CAPTURE.DECLINED Capture attempt gets declined
Identified by event_type field in the body
Resource payment
No payload yet.
PAYMENT.CAPTURE.DENIED
documented from PayPal docs (example)
PAYMENT.CAPTURE.DENIED Capture gets denied, so stop fulfilment
Identified by event_type field in the body
Resource payment
{
"id": "WH-2B342482FC0449155-12X09416XP387753C",
"event_version": "1.0",
"create_time": "2022-04-05T10:37:05Z",
"resource_type": "capture",
"resource_version": "2.0",
"event_type": "PAYMENT.CAPTURE.DENIED",
"summary": "Payment denied for EUR 1.00 EUR",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-2B342482FC0449155-12X09416XP387753C |
Full schema: 39 fields.
From PayPal docs
-
Content type
application/json
PAYMENT.CAPTURE.PENDING
documented from PayPal docs (example)
PAYMENT.CAPTURE.PENDING Capture moves to pending, so don't fulfil yet
Identified by event_type field in the body
Resource payment
{
"id": "WH-3XD97656HT346122M-81M194208A0322526",
"event_version": "1.0",
"create_time": "2021-06-16T22:52:21.351Z",
"resource_type": "capture",
"resource_version": "2.0",
"event_type": "PAYMENT.CAPTURE.PENDING",
"summary": "Payment pending for EUR 100.0 EUR",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-3XD97656HT346122M-81M194208A0322526 |
Full schema: 35 fields.
From PayPal docs
-
Content type
application/json
PAYMENT.CAPTURE.REFUNDED
documented No payload yet
PAYMENT.CAPTURE.REFUNDED Merchant refunds captured funds
Identified by event_type field in the body
Resource payment
No payload yet.
PAYMENT.CAPTURE.REVERSED
documented No payload yet
PAYMENT.CAPTURE.REVERSED PayPal pulls back a completed capture
Identified by event_type field in the body
Resource payment
No payload yet.
PAYMENT.REFUND.PENDING
documented No payload yet
PAYMENT.REFUND.PENDING Refund is waiting to process, as with an eCheck
Identified by event_type field in the body
Resource payment
No payload yet.
PAYMENT.REFUND.FAILED
documented No payload yet
PAYMENT.REFUND.FAILED Refund can't complete, such as a bank settlement failure
Identified by event_type field in the body
Resource payment
No payload yet.
payment_token
VAULT.PAYMENT-TOKEN.CREATED
documented from PayPal docs (example)
VAULT.PAYMENT-TOKEN.CREATED Payment method is saved as a vault token
Identified by event_type field in the body
Resource payment_token
{
"id": "WH-1KN88282901968003-82E75604WM969463F",
"event_version": "1.0",
"create_time": "2022-08-15T14:13:48.978Z",
"resource_type": "payment_token",
"resource_version": "3.0",
"event_type": "VAULT.PAYMENT-TOKEN.CREATED",
"summary": "A payment token has been created.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-1KN88282901968003-82E75604WM969463F |
Full schema: 35 fields.
From PayPal docs
-
Content type
application/json
VAULT.PAYMENT-TOKEN.DELETED
documented No payload yet
VAULT.PAYMENT-TOKEN.DELETED Saved payment token is removed from the vault
Identified by event_type field in the body
Resource payment_token
No payload yet.
VAULT.PAYMENT-TOKEN.DELETION-INITIATED
documented No payload yet
VAULT.PAYMENT-TOKEN.DELETION-INITIATED Request to delete a payment token is submitted
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.ENROLLMENT.CREATED
documented No payload yet
PAYMENT-TOKENIZATION.ENROLLMENT.CREATED Tokenization enrollment is created
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.METADATA.CHANGED
documented No payload yet
PAYMENT-TOKENIZATION.METADATA.CHANGED Tokenization metadata changes
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.PAYMENT-CREDENTIAL.CREATED
documented No payload yet
PAYMENT-TOKENIZATION.PAYMENT-CREDENTIAL.CREATED Tokenized payment credential is created
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.PAYMENT-CREDENTIAL.UPDATED
documented No payload yet
PAYMENT-TOKENIZATION.PAYMENT-CREDENTIAL.UPDATED Tokenized payment credential changes
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.TOKEN-STATUS.CHANGED
documented No payload yet
PAYMENT-TOKENIZATION.TOKEN-STATUS.CHANGED Token's status changes
Identified by event_type field in the body
Resource payment_token
No payload yet.
PAYMENT-TOKENIZATION.TRANSACTION.CREATED
documented No payload yet
PAYMENT-TOKENIZATION.TRANSACTION.CREATED Tokenization transaction is created
Identified by event_type field in the body
Resource payment_token
No payload yet.
payout
PAYMENT.PAYOUTSBATCH.DENIED
documented No payload yet
PAYMENT.PAYOUTSBATCH.DENIED Payout batch gets denied
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTSBATCH.PROCESSING
documented No payload yet
PAYMENT.PAYOUTSBATCH.PROCESSING Payout batch starts processing
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTSBATCH.SUCCESS
documented No payload yet
PAYMENT.PAYOUTSBATCH.SUCCESS Payout batch finishes successfully
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.BLOCKED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.BLOCKED Single payout item gets blocked
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.CANCELED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.CANCELED Unclaimed payout item gets canceled
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.FAILED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.FAILED Single payout item fails
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.HELD
documented No payload yet
PAYMENT.PAYOUTS-ITEM.HELD Single payout item is put on hold
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.REFUNDED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.REFUNDED Single payout item gets refunded
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.RETURNED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.RETURNED Single payout item comes back as returned
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.SUCCEEDED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.SUCCEEDED Single payout item succeeds
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.PAYOUTS-ITEM.UNCLAIMED
documented No payload yet
PAYMENT.PAYOUTS-ITEM.UNCLAIMED Recipient hasn't claimed a payout item
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED
documented No payload yet
PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED Seller and partner receive disbursed funds
Identified by event_type field in the body
Resource payout
No payload yet.
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED
documented No payload yet
PAYMENT.REFERENCED-PAYOUT-ITEM.FAILED Disbursing funds to seller and partner fails
Identified by event_type field in the body
Resource payout
No payload yet.
sale
PAYMENT.SALE.COMPLETED
verified from a captured delivery
PAYMENT.SALE.COMPLETED Sale completes, including each subscription payment
Identified by event_type field in the body
Resource sale
{
"id": "WH-2WR32451HC0233532-67976317FL4543714",
"event_version": "1.0",
"create_time": "2014-10-23T17:23:52Z",
"resource_type": "sale",
"event_type": "PAYMENT.SALE.COMPLETED",
"summary": "A successful sale payment was made for $ 0.48 USD",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-2WR32451HC0233532-67976317FL4543714 |
Full schema: 29 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
PAYMENT.SALE.DENIED
documented No payload yet
PAYMENT.SALE.DENIED Pending sale ends up denied
Identified by event_type field in the body
Resource sale
No payload yet.
PAYMENT.SALE.PENDING
documented No payload yet
PAYMENT.SALE.PENDING Sale moves to pending
Identified by event_type field in the body
Resource sale
No payload yet.
PAYMENT.SALE.REFUNDED
documented No payload yet
PAYMENT.SALE.REFUNDED Merchant issues a refund on a sale
Identified by event_type field in the body
Resource sale
No payload yet.
PAYMENT.SALE.REVERSED
documented No payload yet
PAYMENT.SALE.REVERSED PayPal pulls back a sale, including subscription payments
Identified by event_type field in the body
Resource sale
No payload yet.
subscription
BILLING.PLAN.CREATED
verified from a captured delivery
BILLING.PLAN.CREATED Billing plan gets created
Identified by event_type field in the body
Resource subscription
{
"id": "WH-2N1678257S892762B-8MC99539P4557624Y",
"event_version": "1.0",
"create_time": "2016-04-28T11:21:44Z",
"resource_type": "plan",
"event_type": "BILLING.PLAN.CREATED",
"summary": "A billing plan was created",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-2N1678257S892762B-8MC99539P4557624Y |
Full schema: 51 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
BILLING.PLAN.UPDATED
verified from a captured delivery
BILLING.PLAN.UPDATED Billing plan gets changed
Identified by event_type field in the body
Resource subscription
{
"id": "WH-303507964T970970H-60Y688551M4794625",
"event_version": "1.0",
"create_time": "2016-04-28T11:23:52Z",
"resource_type": "plan",
"event_type": "BILLING.PLAN.UPDATED",
"summary": "A billing plan was updated",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-303507964T970970H-60Y688551M4794625 |
Full schema: 51 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
BILLING.PLAN.ACTIVATED
verified from a captured delivery
BILLING.PLAN.ACTIVATED Billing plan is switched on
Identified by event_type field in the body
Resource subscription
{
"id": "WH-55TG7562XN2588878-8YH955435R661687G",
"create_time": "2018-19-12T22:20:32.000Z",
"event_type": "BILLING.PLAN.ACTIVATED",
"event_version": "1.0",
"resource_type": "plan",
"resource_version": "2.0",
"summary": "A billing plan was activated.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-55TG7562XN2588878-8YH955435R661687G |
Full schema: 55 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
BILLING.PLAN.DEACTIVATED
documented No payload yet
BILLING.PLAN.DEACTIVATED Billing plan is switched off
Identified by event_type field in the body
Resource subscription
No payload yet.
BILLING.PLAN.PRICING-CHANGE.ACTIVATED
verified from a captured delivery
BILLING.PLAN.PRICING-CHANGE.ACTIVATED New pricing on a plan takes effect
Identified by event_type field in the body
Resource subscription
{
"id": "WH-55TG7562XN2588878-8YH955435R771687G",
"create_time": "2018-19-12T22:20:32.000Z",
"event_type": "BILLING.PLAN.PRICING-CHANGE.ACTIVATED",
"event_version": "1.0",
"resource_type": "plan",
"resource_version": "2.0",
"summary": "A billing plan pricing change is activated.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-55TG7562XN2588878-8YH955435R771687G |
Full schema: 57 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.CREATED
verified from a captured delivery
BILLING.SUBSCRIPTION.CREATED New subscription or billing agreement is set up
Identified by event_type field in the body
Resource subscription
{
"id": "WH-19973937YW279670F-02S63370HL636500Y",
"event_version": "1.0",
"create_time": "2016-04-28T11:29:31Z",
"resource_type": "Agreement",
"event_type": "BILLING.SUBSCRIPTION.CREATED",
"summary": "A billing subscription was created",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-19973937YW279670F-02S63370HL636500Y |
Full schema: 72 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.ACTIVATED
verified from a captured delivery
BILLING.SUBSCRIPTION.ACTIVATED Subscription becomes active
Identified by event_type field in the body
Resource subscription
{
"id": "WH-77687562XN25889J8-8Y6T55435R66168T6",
"create_time": "2018-19-12T22:20:32.000Z",
"event_type": "BILLING.SUBSCRIPTION.ACTIVATED",
"event_version": "1.0",
"resource_type": "subscription",
"resource_version": "2.0",
"summary": "A billing agreement was activated.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-77687562XN25889J8-8Y6T55435R66168T6 |
Full schema: 64 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.UPDATED
verified from a captured delivery
BILLING.SUBSCRIPTION.UPDATED Subscription or billing agreement changes
Identified by event_type field in the body
Resource subscription
{
"id": "WH-7BW55401AV391063H-02P24463AR970092S",
"event_version": "1.0",
"create_time": "2016-04-28T11:43:08Z",
"resource_type": "Agreement",
"event_type": "BILLING.SUBSCRIPTION.UPDATED",
"summary": "A billing subscription was updated",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-7BW55401AV391063H-02P24463AR970092S |
Full schema: 75 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.EXPIRED
verified from a captured delivery
BILLING.SUBSCRIPTION.EXPIRED Subscription reaches its end and expires
Identified by event_type field in the body
Resource subscription
{
"id": "WH-UY687577TY25889J9-2R6T55435R66168Y6",
"create_time": "2018-19-12T22:20:32.000Z",
"event_type": "BILLING.SUBSCRIPTION.EXPIRED",
"event_version": "1.0",
"resource_type": "subscription",
"resource_version": "2.0",
"summary": "A billing agreement has expired.",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-UY687577TY25889J9-2R6T55435R66168Y6 |
Full schema: 64 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.CANCELLED
verified from a captured delivery
BILLING.SUBSCRIPTION.CANCELLED Subscription or billing agreement gets cancelled
Identified by event_type field in the body
Resource subscription
{
"id": "WH-6TD369808N914414D-1YJ376786E892292F",
"event_version": "1.0",
"create_time": "2016-04-28T11:53:10Z",
"resource_type": "Agreement",
"event_type": "BILLING.SUBSCRIPTION.CANCELLED",
"summary": "A billing subscription was cancelled",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-6TD369808N914414D-1YJ376786E892292F |
Full schema: 75 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.SUSPENDED
verified from a captured delivery
BILLING.SUBSCRIPTION.SUSPENDED Subscription or billing agreement is paused
Identified by event_type field in the body
Resource subscription
{
"id": "WH-0RD44774E41721427-487281337V896051W",
"event_version": "1.0",
"create_time": "2016-04-28T11:37:14Z",
"resource_type": "Agreement",
"event_type": "BILLING.SUBSCRIPTION.SUSPENDED",
"summary": "A billing subscription was suspended",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-0RD44774E41721427-487281337V896051W |
Full schema: 75 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.RE-ACTIVATED
verified from a captured delivery
BILLING.SUBSCRIPTION.RE-ACTIVATED Suspended billing agreement is active again
Identified by event_type field in the body
Resource subscription
{
"id": "WH-8KT47529P7696805Y-3CS72897S14937140",
"event_version": "1.0",
"create_time": "2016-04-28T11:41:01Z",
"resource_type": "Agreement",
"event_type": "BILLING.SUBSCRIPTION.RE-ACTIVATED",
"summary": "A billing subscription was reactivated",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-8KT47529P7696805Y-3CS72897S14937140 |
Full schema: 76 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.PAYMENT.FAILED
verified from a captured delivery
BILLING.SUBSCRIPTION.PAYMENT.FAILED Subscription payment attempt fails
Identified by event_type field in the body
Resource subscription
{
"id": "WH-77687562XN25889J2-8Y6T55435R66168T4",
"create_time": "2019-01-01T01:20:54.000Z",
"event_type": "BILLING.SUBSCRIPTION.PAYMENT.FAILED",
"event_version": "1.0",
"resource_type": "subscription",
"resource_version": "2.0",
"summary": "Subscription payment failed",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-77687562XN25889J2-8Y6T55435R66168T4 |
Full schema: 71 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-time,x-b3-spanid
BILLING.SUBSCRIPTION.PAYMENT.SUCCEEDED
documented No payload yet
BILLING.SUBSCRIPTION.PAYMENT.SUCCEEDED Subscription payment goes through
Identified by event_type field in the body
Resource subscription
No payload yet.
CATALOG.PRODUCT.CREATED
verified from a captured delivery
CATALOG.PRODUCT.CREATED Catalog product gets created
Identified by event_type field in the body
Resource subscription
{
"id": "WH-55TG7562XN2588878-8YH955435R661687G",
"create_time": "2018-12-19T22:20:32.000Z",
"event_type": "CATALOG.PRODUCT.CREATED",
"event_version": "1.0",
"resource_type": "product",
"resource_version": "2.0",
"summary": "Product created",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-55TG7562XN2588878-8YH955435R661687G |
Full schema: 27 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
CATALOG.PRODUCT.UPDATED
verified from a captured delivery
CATALOG.PRODUCT.UPDATED Catalog product gets changed
Identified by event_type field in the body
Resource subscription
{
"id": "WH-55TG7562XN2588878-8YH955435R661687G",
"create_time": "2018-12-19T22:20:32.000Z",
"event_type": "CATALOG.PRODUCT.UPDATED",
"event_version": "1.0",
"resource_type": "product",
"resource_version": "2.0",
"summary": "Product updated",
"resource": { … },
"links": [ … ]
} Key fields
| Field | Type | Example |
|---|---|---|
id | string | WH-55TG7562XN2588878-8YH955435R661687G |
Full schema: 27 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,cal_poolstack,client_pid,content-type,correlation-id,paypal-auth-algo,paypal-auth-version,paypal-cert-url,paypal-transmission-id,paypal-transmission-sig,paypal-transmission-time,x-b3-spanid
Other PayPal events
IDENTITY.AUTHORIZATION-CONSENT.REVOKED
documented No payload yet
IDENTITY.AUTHORIZATION-CONSENT.REVOKED User's Log in with PayPal consent token is revoked
Identified by event_type field in the body
No payload yet.
PAYMENT.ORDER.CREATED
documented No payload yet
PAYMENT.ORDER.CREATED Payment order gets created
Identified by event_type field in the body
No payload yet.
PAYMENT.ORDER.CANCELLED
documented No payload yet
PAYMENT.ORDER.CANCELLED Payment order gets canceled
Identified by event_type field in the body
No payload yet.
Route PayPal events by type.
Event Gateway receives every PayPal delivery and filters and routes it by event type, so each service gets only the events it handles.