Agricole Documentation | Template Builder

Cancel payments

If you have initially processed your transactions as authorisations (which have status.Output.statusCode=5), you can cancel them to unblock the funds. To do so, send a request to our dedicated CancelPayment endpoint:

{
  "amountOfMoney": {
    "amount": 1000,
    "currencyCode": "EUR"
  },
  "isFinal": false
}

Property	Description
{merchantId}	Your account on our platform through which the initial transaction was processed. Add it as a path parameter to the CancelPayment endpoint Url.
{paymentId}	The payment.Id of the initial transaction which our platform returned in the CreatePayment/GetHostedCheckout request. Add it as a path parameter to the CancelPayment endpoint Url.
order.amountOfMoney amount currencyCode	amount: The gross amount you want to cancel for the original authorisation. currencyCode: The ISO 4217 currency code for this amount. If left empty, our platform will cancel the full original amount.
isFinal	Define whether to close the transaction for subsequent cancellations if you only partially cancel the amount. “true”: The transaction will be closed for any further cancellation requests. “false”: The transaction will remain open for subsequent (partial) cancellation requests for uncaptured amounts. If left empty, the default value is “false”.

Template Builder