PApaypal
Credit Notes

Credit Note refund failure.

Webhook for credit note refund failure.

postWebhookusage-billing.credit-note.refund.failed

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": {
    "billing_entity_code": "acme_inc",
    "sequential_id": 2,
    "number": "PP-1234-US",
    "invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "invoice_number": "PP-1234",
    "issuing_date": "2023-10-01",
    "credit_status": "AVAILABLE",
    "refund_status": "PENDING",
    "reason": "OTHER",
    "description": "Free text",
    "total_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "taxes_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "taxes_rate": 0.2,
    "sub_total_excluding_taxes_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "balance_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "credit_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "refund_amount": {
      "value": 120.35,
      "currency_code": "USD"
    },
    "created_at": "2023-10-01T12:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "items": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "fee": {
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "total_amount": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "name": "Basic Plan"
        }
      }
    ],
    "applied_taxes": [
      {
        "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "tax_name": "TVA",
        "tax_code": "french_standard_vat",
        "tax_rate": 20,
        "tax_description": "French standard VAT",
        "amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "created_at": "2023-10-01T12:00:00Z"
      }
    ]
  }
}

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.