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
number
string
required
Minimum string length: 1
storeId
string
required
Minimum string length: 1
sellerId
string
required
Minimum string length: 1
originalTransactionId
string
required
Minimum string length: 1
refundMethod
enum<string>
required
Available options:
cash,
card,
store_credit,
exchange
lines
object[]
required
Minimum array length: 1
customerId
string | null
Minimum string length: 1
reason
string | null
Minimum string length: 1

Response

The processed return: the signed refund transaction plus its refund metadata.

The processed return: the signed refund transaction plus its refund metadata.

transaction
object
required
originalTransactionId
string
required
refundMethod
enum<string>
required
Available options:
cash,
card,
store_credit,
exchange
reason
string | null
required