Cancel an unfilled 0fns order placement
Craft and broadcast an on-chain cancelOrder to cancel a 0fns OrderBook order placement that was not filled, reclaiming its escrow. The escrowed input token is returned to the wallet that funded the order.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Allocations:Update: Always requiredWallets:Transactions:Create: Always required. The cancellation (cancelOrder) is broadcast from your wallet.FeeSponsors:Use: Required if feeSponsorId is specified and the sponsoree wallet belongs to an EndUser user kind.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Body
Cancel an unfilled 0fns OrderBook order placement and reclaim its escrow to the funding wallet.
The 0fns allocation action whose unfilled OrderBook order placement should be cancelled.
1 - 64^allctn-a-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"allctn-a-04p5n-gkkgd-5qk71nuev5n2ug1t"
An optional external identifier provided by the client to ensure idempotency and prevent duplicate operations.
Id of the fee sponsor that will pay the network fees for this allocation. When set, allocation transactions are broadcast as sponsored user operations.
1 - 64^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"fs-5vqdl-gliqk-b4rfukqauov1sp7j"
Response
Success
The broadcast 0fns order-placement cancellation transaction.
Id of the broadcast on-chain cancelOrder transaction.