Skip to main content
Input object Request payload for the single-call payout mutation: a transfer plus a dynamic payout destination. Provide the sub-input matching payoutType (vcPurchase for VC_PURCHASE, withdraw for WITHDRAW).

​
Input fields

​
UUID!
required
A unique client-generated UUID (v4), used as the idempotency key for the transfer leg (and, derived, for the payout destination leg). This deduplicates retries within the idempotency window; it is not a durable, server-side replay guarantee.
​
PayoutType!
required
Which payout destination to fulfil after the transfer.
​
PayoutTransferInput!
required
The transfer, always performed first.
​
PayoutVcPurchaseInput
Optional virtual card decoration (nickname/memo/category). Only used when payoutType is VC_PURCHASE; everything else about the card is resolved by the API.
​
PayoutWithdrawInput
Withdrawal details (method + funding target). Required when payoutType is WITHDRAW, ignored otherwise.