orders.refund

Refund part or all of a captured payment through the original PSP extension.

• method + path: POST /v1/orders/{ord}/refund
• TR label: Ödeme iadesi
• auth: authenticated · scope gates: any of admin, orders:read, orders:write — “Siparişleri yalnızca mağaza sahibi görebilir”; then any of admin, orders:write — “İade işlemi için yetki yok”
• agentPolicy: propose — a live mutation — an Ajan token's call is recorded into its open proposal (202 proposed: true); a Geliştirici token executes it directly.
• effects: db, provider, mail
• idempotency: client — idempotencyKey in the body is honoured across retries
• wraps: order.refund.request, order.refund.record, order.return.settle

Machine-readable body schema: /schemas/routes/orders.refund.json.

Body

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "amountKurus": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000000000000
    },
    "reason": {
      "type": "string",
      "maxLength": 200
    },
    "idempotencyKey": {
      "type": "string"
    },
    "returnId": {
      "type": "string",
      "pattern": "^ret_[0-9A-HJKMNP-TV-Z]{26}$"
    }
  },
  "required": [
    "amountKurus"
  ],
  "additionalProperties": false
}