RemovePendingRefundCommand (v1.0.0)

Command to remove a pending refund from the eligible refunds list

RemovePendingRefundCommand

Removes a pending refund from the eligible refunds tracking when it’s no longer needed for automatic authorization.

Schema

schema.json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "RemovePendingRefundCommand",
"description": "Command to remove a pending refund from the eligible refunds list",
"properties": {
"accountId": {
"type": "object",
"description": "Account identifier",
"properties": {
"value": {
"type": "string",
"format": "uuid",
"description": "The unique account UUID"
}
},
"required": ["value"]
},
"pendingRefundId": {
"type": "object",
"description": "Pending refund identifier",
"properties": {
"value": {
"type": "string",
"format": "uuid",
"description": "The unique pending refund UUID"
}
},
"required": ["value"]
},
"reason": {
"type": "string",
"description": "Reason for removing the pending refund",
"example": "Refund processed successfully"
}
},
"required": ["accountId", "pendingRefundId"],
"additionalProperties": false
}

Purpose

This command removes a managed transaction from the eligible pending refunds map, typically when the refund has been processed, cancelled, or is no longer eligible for automatic authorization.

Key Attributes

  • ID: Merchant account aggregate identifier
  • Managed Transaction ID: Unique identifier for the managed transaction to remove

Business Rules

  • Only removes the refund if it exists in the eligible refunds map
  • Used when refunds are processed manually or become ineligible

Result

Produces a RemovePendingRefundEvent when the managed transaction exists in the map.