Skip to main content
WEBHOOK

Body

application/json

A refund row, or the payment that was clawed back — the same shape the REST invoice exposes as a transaction. reversal_reason is deliberately absent: it is free provider text and is not carried on the outbox event.

​
amount
integer<int64>
required
​
amount_refunded
integer<int64>
required
​
amount_reversed
integer<int64>
required
​
currency
string
required
​
payment_type
enum<string>
required
Available options:
PAYMENT,
REFUND
​
status
enum<string>
required
Available options:
READY,
PENDING,
SETTLED,
CANCELLED,
FAILED,
REFUNDED
​
transaction_id
string<MeteroidId>
required
Example:

"pay_7n42DGM5Tflk9n8mt7Fhc7"

​
id
string<MeteroidId>
required
Example:

"evt_7n42DGM5Tflk9n8mt7Fhc7"

​
timestamp
string<date-time>
required
​
type
enum<string>
required
Available options:
metric.created,
customer.created,
subscription.created,
subscription.updated,
subscription.cancelled,
subscription.ended,
invoice.created,
invoice.finalized,
invoice.paid,
invoice.voided,
invoice.closed,
invoice.consolidated,
invoice.deleted,
invoice.accounting_pdf_generated,
quote.accepted,
quote.converted,
credit_note.created,
credit_note.finalized,
credit_note.voided,
plan.created,
plan.published,
plan.archived,
product.created,
product.updated,
product.archived,
metric.updated,
metric.archived,
coupon.created,
coupon.updated,
coupon.archived,
addon.created,
addon.updated,
addon.archived,
refund.issued,
refund.settled,
refund.failed,
payment.reversed
​
credit_note_id
string<MeteroidId> | null
Example:

"crn_7n42DGM5Tflk9n8mt7Fhc7"

​
error
string | null
​
invoice_id
string<MeteroidId> | null
Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

​
parent_transaction_id
string<MeteroidId> | null
Example:

"pay_7n42DGM5Tflk9n8mt7Fhc7"

​
processed_at
string<date-time> | null
​
provider_transaction_id
string | null
​
refund_mode
enum<string> | null

How a voluntary refund was issued: through the provider, or recorded after a wire or cash movement made outside Meteroid.

Available options:
ONLINE,
OFFLINE
​
reversal_kind
enum<string> | null

Why a payment was involuntarily clawed back.

Available options:
REFUND,
CHARGEBACK,
DEBTOR_RECALL,
INSUFFICIENT_FUNDS,
MANDATE_INVALID,
RETURNED,
DISPUTE,
OTHER

Response

200

Webhook received successfully