Skip to main content

Link.cancelOffer

Link reference tool

Check out our Link reference tool to understand how Link methods work without having to write any code.

Here's how you can cancel an offer:

import { Link, ImmutableXClient, ImmutableOrderStatus} from ‘@imtbl/imx-sdk’;
const link = new Link('https://link.sandbox.x.immutable.com')
// cancel an offer by passing the orderId of the offer to cancel
await link.cancelOffer({
  orderId: '940'
});

Just like all other link SDK methods, cancelOffer returns a promise, which resolves once all operations are complete, or rejects once the link encounters a critical error.

Input parameters:

{
  orderId: string; // id of the order to cancel
}

Cancel an offer

Cancel an offer confirmation

Errors​

See error responses here.