Cancel Invoice

Cancel an open invoice to prevent payment

Cancel an invoice

Cancel an open invoice. Only OPEN invoices can be canceled.

1 import { Gwop } from "@gwop/sdk";
2 
3 const gwop = new Gwop({
4   merchantApiKey: process.env.GWOP_MERCHANT_API_KEY,
5 });
6 
7 const { result } = await gwop.invoices.cancel({
8   id: "e136eabd-5185-4331-8aa4-b020c9bd9b57", // merchant-side UUID
9 });
10 
11 console.log(result.status);     // "CANCELED"
12 console.log(result.canceledAt); // 2026-03-25T01:52:51.023Z

Cancel takes the merchant-side UUID (id), not the public inv_* identifier. This is the id you received from invoices.create().

Response

1 {
2   "id": "e136eabd-5185-4331-8aa4-b020c9bd9b57",
3   "status": "CANCELED",
4   "canceledAt": "2026-03-25T01:52:51.023Z"
5 }

Field	Type	Description
`id`	`string`	Merchant-side UUID
`status`	`string`	Always `"CANCELED"`
`canceledAt`	`Date`	Cancellation timestamp

Idempotent cancellation

Canceling an already-canceled invoice returns success — no error is thrown. This makes retries safe:

1 // Both calls succeed
2 await gwop.invoices.cancel({ id: invoiceId });
3 await gwop.invoices.cancel({ id: invoiceId }); // same response

Only OPEN invoices can be canceled

Attempting to cancel a PAID, EXPIRED, or PAYING invoice throws an error:

1 import { ErrorCode, isGwopError } from "@gwop/sdk/errors";
2 
3 try {
4   await gwop.invoices.cancel({ id: paidInvoiceId });
5 } catch (err) {
6   if (isGwopError(err, ErrorCode.InvoiceCancelNotAllowed)) {
7     // Only OPEN invoices can be canceled
8   }
9 }

Cancel Invoice

Cancel Invoice

Cancel an invoice

Response

Idempotent cancellation

Only OPEN invoices can be canceled

After cancellation

Next step

Cancel an invoice

Response

Idempotent cancellation

Only OPEN invoices can be canceled

After cancellation

Next step

1	import { Gwop } from "@gwop/sdk";
2
3	const gwop = new Gwop({
4	merchantApiKey: process.env.GWOP_MERCHANT_API_KEY,
5	});
6
7	const { result } = await gwop.invoices.cancel({
8	id: "e136eabd-5185-4331-8aa4-b020c9bd9b57", // merchant-side UUID
9	});
10
11	console.log(result.status); // "CANCELED"
12	console.log(result.canceledAt); // 2026-03-25T01:52:51.023Z

1	{
2	"id": "e136eabd-5185-4331-8aa4-b020c9bd9b57",
3	"status": "CANCELED",
4	"canceledAt": "2026-03-25T01:52:51.023Z"
5	}

1	// Both calls succeed
2	await gwop.invoices.cancel({ id: invoiceId });
3	await gwop.invoices.cancel({ id: invoiceId }); // same response

1	import { ErrorCode, isGwopError } from "@gwop/sdk/errors";
2
3	try {
4	await gwop.invoices.cancel({ id: paidInvoiceId });
5	} catch (err) {
6	if (isGwopError(err, ErrorCode.InvoiceCancelNotAllowed)) {
7	// Only OPEN invoices can be canceled
8	}
9	}