A payment was refunded.

Sent when a refund of a payment completes. The event identifies both the refund and the original payment it reverses. A rejected or returned bank debit is reported as payment.failed, not as a refund.

Payload
data
object
required
string
enum
required
Allowed:
uuid
required

Equal to the WebHook-ID header value.

uri
required
string
enum
required
Allowed:
string

Populated by interpolating the event payload into the template "payments/{refundPaymentId}"; a placeholder whose field is missing or null is left as the literal "{token}".

string

Populated with the active tenant's code; omitted when no tenant context is active.

date-time
required
const
enum
required
Allowed:
Headers
uuid
required

Unique delivery identifier for subscriber deduplication. Equal to the envelope's "id" property, and covered by the RFC 9421 signature.

string
required

Sender identity (e.g. api.daysmart.com).

string
required

RFC 9530 digest of the raw body, "sha-256=::". Recompute from the received body and confirm it matches before verifying the signature.

string
required

RFC 9421 covered components and signature parameters (created, keyid, alg). See the webhookSignature security scheme for the full verification recipe.

string
required

RFC 9421 HTTP Message Signature, "sig1=::", verifiable against the published JWKS.

Responses
410

Endpoint gone. Subscription auto-deactivated (EndpointGone); delivery abandoned. No retry.

415

Unsupported content type. Subscription auto-deactivated (EndpointUnsupported); delivery abandoned. No retry.

429

Rate limit exceeded. Delivery retried after Retry-After delay (default 60s).

2XX

Webhook received successfully. Delivery marked Delivered.

4XX

Client error. Delivery abandoned; subscription stays active. No retry.

5XX

Server error. Delivery retried with exponential backoff up to maxAttempts.

LoadingLoading…