Skip to the page

Praecise Platform

Rivier/ Reference/ shop

Ask for a refund of part or all of what an order paid

post/shop/orders/{id}/refund

Ask for a refund of part or all of what an order paid. A person approves it on the payments side before any money moves.

Before you call

Credential: Authorization: Bearer $KEY
Scope: shop:write
Mcp: rivier_shop_order_refund
Graphql: Mutation.refundShopOrder
Sdk: shop.order.refund
Cli: shop order refund

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

amountMinorinteger
At least 1. At most 9007199254740991.
reasonstringrequired
At most 300 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/shop/orders/{id}/refund' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown