Skip to main content
Update a claim refund

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

if-match
string
Maximum string length: 4096

Path Parameters

id
string<uuid>
required
refund_id
string<uuid>
required

Body

application/json
amount
string
Maximum string length: 100
Pattern: ^\d+(?:\.\d+)?$
currency_code
string
Pattern: ^[A-Z]{3}$
comment
string | null
Maximum string length: 2000
credit_note_id
string<uuid> | null

Response

Current refund.

id
string<uuid>
required
amount
string
required
currency_code
string
required
comment
string | null
required
credit_note_id
string<uuid> | null
required
created_by_user_id
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required