refund.failed

Occurs when a payment refund fails.

WEBHOOK refund.failed

Example

{
  "id": "ref_abc123",
  "paymentId": "pay_019e60cb...",
  "amount": "25.00",
  "currency": "USD",
  "status": "succeeded",
  "reason": "requested_by_customer",
  "referenceValue": "<string>",
  "provider": "stripe",
  "providerCreatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Body

application/json

id · string

Internal refund ID.

Example:

"ref_abc123"

paymentId · string

Example:

"pay_019e60cb..."

amount · string

Dollar value, 2 d.p.

Example:

"25.00"

currency · string

Example:

"USD"

status · string

Example:

"succeeded"

reason · string | null

Example:

"requested_by_customer"

referenceValue · string | null

provider · string | null

Example:

"stripe"

providerCreatedAt · string<date-time> | null

createdAt · string<date-time>

updatedAt · string<date-time>

Response

200

Webhook processed successfully.