Skip to main content

Get role payouts

Get payouts to parties from role-based contracts. Results are returned in pages, with paging being specified by request headers.

Query Parameters
contractId string[]

Possible values: Value must match regular expression ^[a-fA-F0-9]{64}%23[0-9]+$

roleToken string[]

Possible values: Value must match regular expression ^[a-fA-F0-9]*\..*$

status string

Possible values: [available, withdrawn]

The status of a payout. Either it is available to be withdrawn, or it has already been withdrawn.

Whether to include available or withdrawn payouts in the results.

Header Parameters
Range string
Responses
206
Schema — OPTIONAL
results object[]
links object
payout string — OPTIONAL
resource object
contractId string

Possible values: Value must match regular expression ^[a-fA-F0-9]{64}#[0-9]+$

A reference to a transaction output with a transaction ID and index.

payoutId string

Possible values: Value must match regular expression ^[a-fA-F0-9]{64}#[0-9]+$

A reference to a transaction output with a transaction ID and index.

role object
assetName string
policyId string

Possible values: Value must match regular expression ^[a-fA-F0-9]*$

The hex-encoded minting policy ID for a native Cardano token

status string

Possible values: [available, withdrawn]

The status of a payout. Either it is available to be withdrawn, or it has already been withdrawn.

withdrawalId string — OPTIONAL

Possible values: Value must match regular expression ^[a-fA-F0-9]{64}$

The hex-encoded identifier of a Cardano transaction

400

Invalid Range or status or roleToken or contractId