UpdateEligiblePendingRefundsArmCommand

Arms a pending refund eligibility trigger that will automatically authorize refunds when sufficient balance is available.

Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "UpdateEligiblePendingRefundsArmCommand",
  "description": "Command to update the eligibility status for pending refunds based on available balance",
  "properties": {
    "accountId": {
      "type": "object",
      "description": "Account identifier",
      "properties": {
        "value": {
          "type": "string",
          "format": "uuid",
          "description": "The unique account UUID"
        }
      },
      "required": ["value"]
    },
    "availableBalance": {
      "type": "integer",
      "description": "Available balance for refund eligibility calculation (in smallest currency unit, e.g., 150000 = 1500.00)",
      "example": 150000
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Z]{3}$",
      "description": "Currency of the balance (ISO 4217)",
      "example": "EUR"
    }
  },
  "required": ["accountId", "availableBalance", "currency"],
  "additionalProperties": false
}

Purpose

This command sets up automatic refund authorization by tracking eligible pending refunds and their required amounts. When the account balance becomes sufficient, eligible refunds are automatically scheduled for authorization.

Key Attributes

ID: Merchant account aggregate identifier
Amount: Required amount for the refund
Managed Transaction ID: Unique identifier for the managed transaction

Business Rules

Tracks refunds that are eligible for automatic authorization
Refunds are authorized when cumulative balance allows
Uses a first-in-first-out approach for refund authorization

Result

Produces an UpdateEligiblePendingRefundsArmedEvent when successful.

UpdateEligiblePendingRefundsArmCommand (v1.0.0)

Command to update the eligibility status for pending refunds based on available balance