order.refund.record

Finalize a refund intent after the PSP call (ok releases/settles the reservation).

• 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": {
    "refundId": {
      "type": "string",
      "pattern": "^ref_[a-zA-Z0-9]{1,32}$"
    },
    "ok": {
      "type": "boolean"
    },
    "providerRefundId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "errorCode": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    }
  },
  "required": [
    "refundId",
    "ok"
  ],
  "additionalProperties": false
}