PApaypal
Wallets

Wallet transaction created.

Webhook for wallet transaction creation.

postWebhookusage-billing.wallet-transaction.created

Headers

paypal-transmission-idstring

The unique ID of the transmission, from the paypal-transmission-id HTTP header.

paypal-transmission-timestring

The date and time when the message was transmitted, from the paypal-transmission-time HTTP header.

Payload

idstring required

Unique identifier for the webhook event.

create_timestring date-time required

Date and time in ISO 8601 format.

event_versionstring

Version of the event schema.

summarystring

Brief description of the event.

resource_versionstring

Version of the resource schema.

resource_type'subscription-alert' | 'wallet' | 'wallet-transaction' | 'credit-note' | 'invoice' | 'subscription' required

Type of resource that triggered the webhook.

event_type'USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED' | 'USAGE-BILLING.WALLET.CREATED' | 'USAGE-BILLING.WALLET.UPDATED' | 'USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED' | 'USAGE-BILLING.WALLET.TERMINATED' | 'USAGE-BILLING.WALLET-TRANSACTION.CREATED' | 'USAGE-BILLING.WALLET-TRANSACTION.UPDATED' | 'USAGE-BILLING.CREDIT-NOTE.CREATED' | 'USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED' | 'USAGE-BILLING.INVOICE.CREATED' | 'USAGE-BILLING.INVOICE.PAYMENT.OVERDUE' | 'USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED' | 'USAGE-BILLING.INVOICE.PAYMENT.FAILED' | 'USAGE-BILLING.SUBSCRIPTION.UPDATED' | 'USAGE-BILLING.SUBSCRIPTION.TERMINATED' | 'USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED' required

Type of event that occurred in webhooks.

Example payload

{
  "id": "8PT597110X687430LKGECATA",
  "create_time": "2023-10-01T12:00:00Z",
  "event_version": "1.0",
  "summary": "A new alert was triggered.",
  "resource_version": "1.0",
  "links": [
    {
      "href": "https://api-m.paypal.com/v1/notfications/webhooks-events/8PT597110X687430LKGECATA",
      "rel": "self",
      "method": "GET"
    }
  ],
  "resource": {
    "external_customer_id": "client-12345",
    "status": "ACTIVE",
    "available_balance": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "ongoing_usage": {
      "value": 100,
      "currency_code": "USD"
    },
    "net_balance": {
      "value": 50,
      "currency_code": "USD"
    },
    "name": "Prepaid Wallet",
    "rate_amount": "1.5",
    "available_credits": "28.0",
    "ongoing_usage_credits": "10.0",
    "net_balance_credits": "18.0",
    "consumed_credits": "2.0",
    "created_at": "2023-10-01T12:00:00Z",
    "expiration_at": "2023-10-01T12:00:00Z",
    "terminated_at": "2023-10-01T12:00:00Z",
    "applies_to": {
      "fee_types": [
        "SUBSCRIPTION"
      ]
    },
    "recurring_transaction_rules": [
      {
        "trigger": "THRESHOLD",
        "paid_credits": "20.0",
        "granted_credits": "10.0",
        "method": "FIXED",
        "interval": "MONTHLY",
        "started_at": "2023-10-01T12:00:00Z",
        "expiration_at": "2023-10-01T12:00:00Z",
        "threshold_credits": "5.0",
        "target_ongoing_balance": "200.0"
      }
    ],
    "id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
  }
}

Response

Return a 204 status to indicate that the data was received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.