Withdraw bid refund

Builds a transaction that pays out all of a bidder's held auction refunds in one currency (mint). The bidder signs.

If a new token account has to be created for the bidder, the transaction comes back partially signed. Keep that signature when the bidder signs.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

bidder*string

Length1 <= length

mint*string

Refund currency mint, not the artwork asset ID.

Length1 <= length

destination?string

Where to send the refund. For SOL, any wallet (defaults to the bidder). For tokens, a token account the bidder owns for this currency (defaults to their associated token account).

Length1 <= length

targetPriorityFeeLamports?integer

Priority fee per transaction, in lamports. By default it is a cap: mallow pays what the network currently needs, up to this amount (50,000 when omitted). Set exactPriorityFee to pay exactly this amount instead. The fee is never less than 15,000 lamports.

Formatuint64

exactPriorityFee?boolean

Pay targetPriorityFeeLamports exactly instead of treating it as a cap. Defaults to false.

blockhash?string

Recent blockhash to build the transaction with (base58). Omit it to let mallow supply one; identical requests a few seconds apart then return the same transaction.

Response Body

`application/json`

curl -X POST "https://example.com/v2/tx/auctions/withdraw-bid-refund" \  -H "Content-Type: application/json" \  -d '{    "bidder": "string",    "mint": "string"  }'

{  "result": {    "tx": "string"  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`