CancelLOCParams

type CancelLOCParams = object;

Parameters for cancelling a LOC. Cancelling removes the LOC and releases its unused collateral (or any converted assets) back to the creator’s vault balance. Build with sdk.loc.buildCancelWorkflow.

Remarks

Before expiration only the beneficiary, or a caller holding the beneficiary’s signed authorization, may cancel; after expiration anyone may. Expiration alone releases nothing — someone must submit the cancellation.

Properties

beneficiaryAuthorization?

optional beneficiaryAuthorization?: Bytes;

EIP-712 CancelAuthorization signed by the beneficiary. Build and sign it with sdk.loc.buildCancelAuthorizationWorkflow. A direct buildCancelWorkflow call needs it only when the connected signer is not the beneficiary and the LOC has not expired. Multicall-based batch methods need it for every unexpired entry because Multicall is the immediate caller. Explicit undefined is equivalent to omission.

---

id

id: bigint;

ID of the LOC to cancel (LetterOfCreditReference.id). Before expiration only the beneficiary or a holder of its authorization may cancel; after expiration anyone may.