v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB

Flow

Create a new payout within Flow workflows (entity-level)

Creates a new payout transaction within a Flow workflow context. This endpoint initiates a payout workflow where the merchant can receive funds by selecting a wallet and specifying where they want the funds sent.

post/entities/{entityDID}/flow/payouts

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

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

The DID of the entity

Request body

refstring required

Client-provided reference (e.g., payout reference)

currencystring required

Currency code for the transaction

amountstring required

Transaction amount

supportedAssetsstring[]

Optional list of supported assets for this transaction (CAIP-19)

memostring

Optional transaction memo

Response

Payout created successfully