Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Flow

List payouts for an entity with optional ref-based filtering

Retrieves a paginated list of payout transactions for an entity within Flow workflows. Supports filtering by client references and Flow workflow states. Client references are automatically converted to database references by adding the 'flow-' prefix.

get/entities/{entityDID}/flow/payouts

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

Query parameters

string
OR
string[]

Client references to filter by (single or array)

limitstring

Maximum number of results to return

offsetstring

Number of results to skip for pagination

string
OR
string[]

Flow workflow states to filter by (single or array)

is_initiatorboolean

Filter by initiator status (true for outgoing, false for incoming)

Response

List of payouts retrieved successfully