Skip to main content
WEBHOOK
refund.updated
{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "refund.updated",
  "data": {
    "id": "rf_xxxxxxxxxxxxxxx",
    "amount": 6.9,
    "currency": "usd",
    "status": "pending",
    "created_at": "2023-12-01T05:00:00.401Z",
    "provider": "stripe",
    "provider_created_at": "2023-12-01T05:00:00.401Z",
    "reference_status": "available",
    "reference_type": "acquirer_reference_number",
    "reference_value": "74850120752",
    "payment": {
      "id": "pay_xxxxxxxxxxxxxx",
      "total": 6.9,
      "subtotal": 6.9,
      "usd_total": 6.9,
      "currency": "usd",
      "created_at": "2023-12-01T05:00:00.401Z",
      "paid_at": "2023-12-01T05:00:00.401Z",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "payment_method_type": "acss_debit",
      "billing_reason": "subscription_create",
      "card_brand": "mastercard",
      "card_last4": "4242",
      "tax_amount": 6.9,
      "tax_behavior": "exclusive",
      "tax_refunded_amount": 6.9,
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42",
        "email": "john.doe@example.com"
      },
      "member": {
        "id": "<string>",
        "phone": "<string>"
      },
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx",
        "status": "trialing"
      }
    }
  },
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json
​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
timestamp
string<date-time>
required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "refund.updated"
Example:

"refund.updated"

​
data
object
required

A refund represents a full or partial reversal of a payment, including the amount, status, and payment provider.

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

Return a 200 status to indicate that the data was received successfully