menu

Payment API

What's on this page

API Reference / Cancel

Cancel

When it is possible to cancel a payment, a cancelUrl will be included in the Payment object.

Methods supporting cancel

  • Card
  • Payconiq
  • LandingPage
  • BankTransfer
  • Terminal

A cancellation is only possible up to a certain point in the payment flow. If the cancel is sent after this point it is rejected. A rejected cancel has no effect on the payment process.

When a LandingPage is cancelled, the underlying child transaction will be cancelled too. If the child transaction is already past the cancellation point, the whole cancel will be rejected.

Cancel request

  • Resource: cancelUrl or /api/v1/cancel?reference={reference}
  • Method: POST
  • Content-Type: application/json
  • Authentication: basic auth

Cancel response

Response if the cancel is allowed

  • Status Code: 200
  • Content Type: application/json
  • Content: No content

Response if the cancel is not allowed

  • Status Code: 400
  • Content Type: application/json
  • Content: Error