POST /orders/cancel

Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Idempotency-Key String No

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name Type Required Description
order Object Yes

The order request object that contains a pspReference that represents the order and the matching encrypted order data.

order.pspReference String Yes

The pspReference that belongs to the order.

order.orderData String Yes

The encrypted order data.

merchantAccount String Yes

The merchant account identifier that orderData belongs to.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.