Submit a correction or refund

Once a settlement is cleared, it cannot be modified or deleted — any correction or refund is submitted as a new settlement. See Settlement Corrections for why this two-step mechanism exists.

Implementation:

• Set the cancel field to true on the root annex in the reversal transaction
• Include both the cancellation and replacement transactions in the same settlement submission
• Optionally reference the original settlement using the correctionForSmntId field at the settlement level

The example below corrects the advance settlement from Submit an advance settlement, where the payment amount was recorded incorrectly. The first transaction reverses the original 372.00 payment; the second resubmits it with the corrected amount:

Code
{
  "posRef": "EOS:Pos:ExternalPSP",
  "distributionChannelRef": "ENT:DistributionChannel:ExternalPSP",
  "settlementNo": 3,
  "settlementDate": "2025-11-27",
  "correctionForSmntId": 111122222,
  "genericTransactions": [
    {
      "transactionType": "ADVANCE",
      "genericAnnexes": [
        {
          "annexRef": "EOS:Payment:Advance",
          "cancel": true,
          "attributes": {
            "paymentType": "AgentVYG",
            "paymentTypeGroup": "AGENT"
          },
          "priceContribution": {
            "amount": "372.00"
          },
          "description": "Reversal of incorrect advance payment"
        }
      ]
    },
    {
      "transactionType": "ADVANCE",
      "genericAnnexes": [
        {
          "annexRef": "EOS:Payment:Advance",
          "attributes": {
            "paymentType": "AgentVYG",
            "paymentTypeGroup": "AGENT"
          },
          "priceContribution": {
            "amount": "400.00"
          },
          "description": "Corrected advance payment"
        }
      ]
    }
  ]
}

Key point: Corrections must include both the reversal and optional replacement within a single settlement to maintain proper accounting and audit trails.