Refund pending

Emitted when a refund is initiated (REFUND_PENDING).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Canonical merchant-facing webhook body sent on lifecycle events. Signed with the same Stripe-style HMAC-SHA256 algorithm as inbound requests (header X-Signature).

event*string

Event identifier (e.g. deal.completed).

deal_id*string

Formatuuid

merchant_id*string

Formatuuid

tenant_id*string

Formatuuid

amount*integer

Deal amount in smallest currency units.

Formatint64

currency*string

ISO 4217 currency code.

status*OrderStatus

Canonical V2 order lifecycle state (FSA). Matches domain.OrderStatus and the OrderStatus proto enum exactly.

Value in

"INITIALIZED"
"ESCROW_LOCKED"
"PAYMENT_NOTIFIED"
"PAYMENT_VERIFIED"
"COMPLETED"
"EXPIRED"
"CANCELLED"
"APPEALED"
"REFUND_PENDING"
"SPAM_REJECTED"
"SOFT_DISPUTED"

timestamp*string

RFC 3339 event timestamp.

Formatdate-time

received_amount?integer

Actual amount received (differs from amount on partial/overpaid).

Formatint64

amount_match_status?AmountMatchStatus

Match quality between expected and received payment amounts. Lowercase string values.

Value in

"full"
"partial"
"overpaid"

provider_metadata?

Provider-specific passthrough data (deeplinks, payment-page URLs, etc.).

Response Body

`application/json`

Example Requests

POST/deal.refund_pending

Refund pending

Request Body

Response Body

200application/json

Request Bodyapplication/json

`application/json`