Input fields
UUID!
required
A unique client-generated UUID that makes the payout safe to retry. Reusing a
key with a different amount, source balance, or payee is rejected. Keys are
shared across all transfer types, so a key already used for another kind of
transfer cannot be reused here.
UUID!
required
An external payee that belongs to the authenticated user’s account.
UUID!
required
The cash balance to debit. Must belong to the authenticated user’s account and
be active.
Float!
required
The amount the payee receives, in USD. Greater than 0, at most two decimal
places. The sender is debited this amount plus the fee. See
totalDebited on
the result.Boolean
Optional. Confirms that the sender knowingly pays an external payee whose
ExternalPayee.status is REVIEW. Without it a
payout to a REVIEW payee is refused with error code PT-0009; ask the user to confirm and send
the payout again with this set to true. Has no effect on a payee that is not under review.