Claim gumball item

Builds the transaction sending a drawn item to its buyer. Anyone can sign and pay as payer.

A cnft with royalties can't be claimed on its own; use POST /v2/tx/gumball/settle-sale, which delivers it as well.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payer*string

Signer and fee payer (base58).

gumballMachine*string

seller*string

The item's recorded seller (base58).

buyer*string

The item's recorded buyer (base58). Receives the item.

asset*string

Address of the item (base58): the mint for nft and pnft, the asset address for core, or the asset id for cnft and cnft-v2.

index*integer

Index of the item's config line in the gumball machine.

Formatuint32

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.

Response Body

`application/json`

curl -X POST "https://example.com/v2/tx/gumball/claim-item" \  -H "Content-Type: application/json" \  -d '{    "payer": "string",    "gumballMachine": "string",    "seller": "string",    "buyer": "string",    "asset": "string",    "index": 0  }'

{  "result": {    "tx": "string",    "setupTx": "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`