Withdraw ranked-auction earnings

POST

/collection/{highlightId}/sales/earnings

Build a transaction to withdraw a ranked auction’s cumulative earnings to the payment recipient after the auction has ended. Native-currency auctions only.

Authorizations

• bearerAuth

Parameters

Path Parameters

highlightId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body ^required

object

saleId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Earnings withdrawal transaction configuration

object

chainId

required

integer

> 0 <= 9007199254740991

to

required

Any of:

string

string

null

null

data

required

string

value

required

string

400

Invalid request

401

Unauthorized

404

Not found

409

Already claimed

500

Internal server error