order.refund.request

Reserve a refund amount on a paid order (intent row = the PSP conversation anchor).

• scope: orders:write
• storefront-visible (bumps the catalog generation): no
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "pattern": "^ord_[a-zA-Z0-9]{1,32}$"
    },
    "refundId": {
      "type": "string",
      "pattern": "^ref_[a-zA-Z0-9]{1,32}$"
    },
    "amountKurus": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000000000
    },
    "reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "returnId": {
      "type": "string",
      "pattern": "^ret_[a-zA-Z0-9]{1,32}$"
    }
  },
  "required": [
    "orderId",
    "refundId",
    "amountKurus"
  ],
  "additionalProperties": false
}