Skip to documentationDocumentation
On this page

refund.created

Refund created and funds reserved.

A refund was created and its merchant debit reserved for execution. The refund is not complete yet.

Money and processing#

Save refund_id against invoice_id and your own refund request. amount is principal, recipient_amount is the planned transfer, and merchant_debit_amount is the commercial debit. Wait for completion or failure before marking the refund finished.

Schema version 1#

Fields are taken from the public OpenAPI contract. Required nullable fields must be present and may contain null.

  • id · string · Required

    Stable event UUID for merchant-side idempotency. · Format: uuid

  • event_seq · integer · Required

    Global event sequence. Gaps are possible; it does not establish delivery or processing order. · Format: int64

  • type · "refund.created" · Required

    —

  • schema_version · 1 · Required

    —

  • environment · "live" | "test" · Required

    —

  • merchant_id · string · Required

    Format: uuid

  • subject_type · "refund" · Required

    —

  • subject_id · string · Required

    Format: uuid

  • occurred_at · string · Required

    Canonical business occurrence timestamp. · Format: date-time

  • data · object · Required

    Unknown properties are rejected

  • data.refund_id · string · Required

    Format: uuid

  • data.invoice_id · string · Required

    Format: uuid

  • data.currency · string · Required

    —

  • data.network · string · Required

    —

  • data.environment · "live" | "test" · Required

    —

  • data.amount · string · Required

    Format: decimal · Pattern: ^\d+(.\d+)?$

  • data.recipient_amount · string · Required

    Format: decimal · Pattern: ^\d+(.\d+)?$

  • data.merchant_debit_amount · string · Required

    Format: decimal · Pattern: ^\d+(.\d+)?$

  • data.destination · string · Required

    —

  • data.status · "pending" · Required

    —

Example — version 1#

json example
{
  "id": "00000000-0000-0000-0000-000000000001",
  "event_seq": 184203,
  "type": "refund.created",
  "schema_version": 1,
  "environment": "live",
  "merchant_id": "00000000-0000-0000-0000-000000000002",
  "subject_type": "refund",
  "subject_id": "00000000-0000-0000-0000-000000000003",
  "occurred_at": "2026-09-14T10:00:00Z",
  "data": {
    "refund_id": "00000000-0000-0000-0000-000000000003",
    "invoice_id": "00000000-0000-0000-0000-000000000004",
    "currency": "USDC",
    "network": "ethereum",
    "environment": "live",
    "amount": "5.00",
    "recipient_amount": "5.00",
    "merchant_debit_amount": "5.10",
    "destination": "0x0000000000000000000000000000000000000001",
    "status": "pending"
  }
}

See delivery and envelope, signature verification, and business processes.