Withdraw gumball payout

Builds a transaction that withdraws up to amount of the funds a gumball machine holds for recipient: buyer refunds, or seller, curator or marketplace proceeds. The recipient signs. This works after the machine is closed too; see GET /v2/gumball/{gumballMachine}/payouts for balances.

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

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

gumballMachine*string

recipient*string

Recorded payout recipient and transaction signer.

amount*string

Amount to withdraw in base units, up to the amount owed. The last withdrawal from a closed machine can pay out slightly more, as it also sweeps leftover tokens.

Match^[0-9]+$

destination?string

Token account the recipient owns for the payout currency. Defaults to their associated token account. Ignored for SOL, which always goes to the recipient.

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/gumball/withdraw-payout" \  -H "Content-Type: application/json" \  -d '{    "gumballMachine": "string",    "recipient": "string",    "amount": "string"  }'

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

Withdraw gumball payout

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`