APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
CheckoutOrders

Cancel an order

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.

Authorization

AuthorizationBasic <token>

In: header

Header Parameters

Idempotency-Key?string

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

Request Body

application/json

merchantAccount*string

The merchant account identifier that orderData belongs to.

order*

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/orders/cancel" \  -H "Idempotency-Key: 37ca9c97-d1d1-4c62-89e8-706891a563ed" \  -H "Content-Type: application/json" \  -d '{    "order": {      "pspReference": "8815517812932012",      "orderData": "823fh892f8f18f4...148f13f9f3f"    },    "merchantAccount": "YOUR_MERCHANT_ACCOUNT"  }'
{  "pspReference": "8816178914079738",  "resultCode": "Received"}

Create an order POST

Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods.

Get the balance of a gift card POST

Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.