mallow docs

Settle auction

POST
/v2/tx/auctions/settle

Builds the transaction that closes out asset's ended auction, signed by authority.

Settling transfers the asset to the winning bidder and distributes proceeds — marketplace fee, royalties to the creators recorded on-chain, and the remainder to the seller. authority need not be the seller; anyone may settle an auction that has ended and has a winner, which lets a buyer claim without waiting on the seller.

Auctions with endTime set can only be settled once that time has passed, otherwise 400. An auction with no end time settles on demand once a bid exists.

If the auction ended with no bids, this instead builds the reclaim path returning the asset to the seller — and then only the seller may call it.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Closes out an ended auction: transfers the asset to the winning bidder and distributes proceeds. With no bids, it instead builds the reclaim path returning the asset to the seller.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/tx/auctions/settle" \  -H "Content-Type: application/json" \  -d '{    "authority": "string",    "asset": "string"  }'
{  "result": {    "tx": "string"  }}