Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json
id
string
required
Minimum string length: 1
subjectKind
enum<string>
required
Available options:
deposit
subjectId
string
required
Minimum string length: 1
amountCents
integer
required
Required range: 0 < x <= 9007199254740991
note
string
Maximum string length: 500

Response

The recorded refund, including the minted avoir's id and bearer code.

The recorded refund, including the minted avoir's id and bearer code.

id
string
required
subjectKind
enum<string>
required
Available options:
deposit
subjectId
string
required
customerId
string
required
storeId
string
required
currency
string
required
amountCents
integer
required
Required range: 0 < x <= 9007199254740991
modality
enum<string>
required
Available options:
store_credit,
original_method
instrumentId
string
required
instrumentCode
string
required
note
string | null
required
actorId
string
required
refundedAt
string
required