Skip to main content
Cancel a pending (unpaid) one-time order. Only orders that have not yet been paid can be canceled.
POST /v1/actions/onetime-order/cancel-order
Authentication: API Key

Request Body

FieldTypeRequiredDescription
orderIdstringYesOrder ID in Short ID format (ORD_xxx)

Example Request

import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

const result = await client.orders.cancelOnetimeOrder({
  orderId: "ORD_3K5L8M2N4P6Q9R7J",
});

console.log(result.orderId); // "ORD_3K5L8M2N4P6Q9R7J"
console.log(result.status);  // "canceled"

Success Response

{
  "data": {
    "orderId": "ORD_3K5L8M2N4P6Q9R7J",
    "status": "canceled"
  }
}

Response Fields

FieldTypeDescription
orderIdstringOrder ID in Short ID format
statusstringNew order status (canceled)

Errors

StatusMessageDescription
400Order is not pendingOnly orders with pending status can be canceled
404Order not foundNo order matches the given orderId
Only orders with pending status (payment not yet completed) can be canceled. For completed orders, use the refund endpoint instead.