Skip to main content
Record a claim refund

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

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

Response

The recorded refund. Retrying records another one.

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