Skip to content
Paymee Developers

refund.succeeded

POST

A refund returned the money to the buyer, whichever channel issued it (API, dashboard, or a plugin).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The refund.succeeded event.

object
id
required

Event id (evt_…), stable across retries; also the X-Paymee-Webhook-Id header.

string
event
required
  • refund.succeeded - refund.succeeded
string
Allowed values: refund.succeeded
created_at
required
string format: date-time
livemode
required

False for events from test mode (sk_test_ keys).

boolean
data
required

A refund.

object
id
required

Refund id (re_…).

string
session_id
required

The refunded payment session (ps_…).

string
merchant_reference
required

The session’s merchant_reference.

string
amount
required

Refunded amount, as a decimal string.

string
currency
required

ISO 4217 currency of amount.

string
refund_type
  • FULL - Full
  • PARTIAL - Partial
string
Allowed values: FULL PARTIAL
status
required

PENDING while the refund is in progress, SUCCEEDED once the money is returned, FAILED if it was not.

string
Allowed values: PENDING SUCCEEDED FAILED
reason
Refund reason
string
processor_message
required

Why the refund is pending or failed, when known. Informational; may change.

string | null
created_at
required
string format: date-time
completed_at
required

When the refund reached SUCCEEDED or FAILED.

string | null

Responses

Section titled “Responses”

200

Section titled “200”

Any 2xx within 10 seconds acknowledges the event; anything else is retried.