Cm3WriteOffRefund

Use this action to reverse a write-off. The reversal always covers the full amount of the referenced write-off transaction; partial refunds are not supported. If an invoice has multiple partial write-offs, reverse each one individually using its own OriginalTransactionKey (basic field).

Endpoints in different environments:

https://testcheckout.buckaroo.nl/json/Transaction for test invoices;

https://checkout.buckaroo.nl/json/Transaction for live invoices

Parameters

Parameter	Type	Required	Description
Currency	String	Yes	Basic parameter. Currency code (e.g. EUR). Must match the currency of the original write-off transaction.
AmountCredit	Decimal	Yes	Basic parameter. Must equal the full amount of the original write-off transaction.
Description	String	No	Basic parameter. Description for the refund transaction.
Invoice	String	Yes	Basic parameter. Invoice number the original write-off was applied to.
OriginalTransactionKey	String	Yes	Basic parameter. Transaction key of the write-off (V376) transaction to reverse.

Request

{
  "Currency": "EUR",
  "AmountCredit": 10,
  "Description": "Undo WriteOff invoice TESTINV2000007",
  "Invoice": "TESTINV2000007",
  "OriginalTransactionKey": "39C880B202D9446EA10EAC29CBBA2345",
  "Services": {
    "ServiceList": [
      {
        "Name": "CreditManagement3",
        "Action": "Cm3WriteOffRefund"
      }
    ]
  }
}

Response (success)

{
    "Key": "814D2BFC70214B438BA2AE852F23B333",
    "Status": {
        "Code": {
            "Code": 190,
            "Description": "Success"
        },
        "SubCode": {
            "Code": "S001",
            "Description": "Transaction successfully processed"
        },
        "DateTime": "2026-08-03T08:46:17"
    },
    "RequiredAction": null,
    "Services": [
        {
            "Name": "CreditManagement3",
            "Action": null,
            "Parameters": [
                {
                    "Name": "Processed",
                    "Value": "Classic"
                }
            ]
        }
    ],
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "TESTINV2000007",
    "ServiceCode": "CreditManagement3",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 10,
    "TransactionType": "V377",
    "MutationType": 2,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "39C880B202D9446EA10EAC29CB33333"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "F308F5476E9E4BFE8CA8194FA73C333"
}

Response (validation error)

{
    "Key": "B57DC384F47F4752A1BE7C53EAD95333",
    "Status": {
        "Code": {
            "Code": 690,
            "Description": "Rejected"
        },
        "SubCode": {
            "Code": "S121",
            "Description": "The transaction cannot be partially refunded."
        },
        "DateTime": "2026-08-03T09:01:22"
    },
    "RequiredAction": null,
    "Services": null,
    "CustomParameters": null,
    "AdditionalParameters": null,
    "RequestErrors": null,
    "Invoice": "TESTINV2000007",
    "ServiceCode": "CreditManagement3",
    "IsTest": true,
    "Currency": "EUR",
    "AmountCredit": 100,
    "TransactionType": "V377",
    "MutationType": 2,
    "RelatedTransactions": [
        {
            "RelationType": "refund",
            "RelatedTransactionKey": "39C880B202D9446EA10EAC29CBBAD333"
        }
    ],
    "ConsumerMessage": null,
    "Order": null,
    "IssuingCountry": null,
    "StartRecurrent": false,
    "Recurring": false,
    "CustomerName": null,
    "PayerHash": null,
    "PaymentKey": "772C8BDCD824408E9C126CBC83203333"
}

Push parameters

A WriteOff refund triggers two events: Cm3RefundWriteOff to communicate the invoice event, and ChangedTransactionStatus to communicate the creation of the write-off refund transaction.

Parameter	Description
AmountWriteOffs	Basic parameter. Updated net total of write-offs after the refund is applied.
IsWrittenOff	Basic parameter. Set back to false if the refund causes the open amount to exceed 0.
RefundAmount	Event parameter. Refunded amount.
RefundCurrency	Event parameter. Currency of the refunded amount.

Example push

{
  "Invoice": {
    "InvoiceKey": "0948B3022CCA41E78B9857CB4DCC7333",
    "InvoiceNumber": "TESTINV2000007",
    "WebsiteKey": "7Cnv8ra333",
    "DebtorCode": "JohnSmith123",
    "DebtorGuid": "087EBCB0D2B9418B87B0CDD8DEC2C333",
    "SchemeKey": "d5gj5t",
    "IsTest": true,
    "Type": "RegularInvoice",
    "Culture": "nl-NL",
    "InvoiceDate": "2018-06-05T00:00:00",
    "DueDate": "2019-04-18T00:00:00",
    "InvoiceStatusCode": 10,
    "PreviousStepIndex": 0,
    "PreviousStepDateTime": "0001-01-01T00:00:00",
    "InvoicePayLink": "https://testcheckout.buckaroo.nl/html/?brq_paydirect_inv=033",
    "Event": "Cm3RefundWriteOff",
    "EventCategory": "FinancialChange",
    "EventDateTime": "2026-08-03T08:46:37.5714782",
    "EventParameters": [
      {
        "Key": "RefundAmount",
        "Value": "10"
      },
      {
        "Key": "RefundCurrency",
        "Value": "EUR"
      }
    ],
    "Currency": "EUR",
    "AmountDebit": 10.0000,
    "AmountCredit": 0.0000,
    "AmountAdminCosts": 0.0000,
    "AmountCreditNotes": 0.0,
    "AmountPaid": 0.0,
    "AmountAdminCostsPaid": 0.0,
    "AmountPendingSlow": 0.0,
    "OpenAmount": 10.0000,
    "OpenAmountAdminCosts": 0.0000,
    "OpenAmountInclAdminCosts": 10.0000,
    "IsPaid": false,
    "CustomParameters": [],
    "AdditionalParameters": [],
    "DebtorFileGuid": null,
    "DebtorFilePayLink": null,
    "DebtorFileNumber": null,
    "OriginalInvoiceNumber": null,
    "AmountWriteOffs": 0.0000,
    "IsWrittenOff": false
  }
}