/** * @example * { * payout_method_id: "potk_xxxxxxxxxxxxxx" * } */ export interface CreateQuotePayoutsRequest { /** Account to pay out from, prefixed `biz_`. Provide exactly one of `account_id` or `user_id`. */ account_id?: string; /** The amount to pay out in the specified currency, fees included. Provide exactly one of `amount` or `recipient_amount`. */ amount?: number; /** The currency to pay out. When omitted, uses `usd` if that balance can cover a withdrawal, otherwise the account's only other funded currency. */ currency?: string; /** A saved card of the account, prefixed `payt_`, to quote paying this payout from. The quote's `amount` is the card charge, `fee` adds the estimated card fees to the payout fee, and `net_amount` is what the recipient receives. */ payment_method_id?: string; /** The saved payout method to quote (a potk_ identifier). */ payout_method_id: string; /** Whether the parent platform covers the payout fee instead of the account being paid out. */ platform_covers_fees?: boolean; /** The amount the recipient should receive, with fees added on top. When the payout method pays out in `currency`, the quote's `destination_amount` covers it; otherwise its `net_amount` does. Provide exactly one of `amount` or `recipient_amount`. */ recipient_amount?: number; /** How fast the funds should arrive. */ speed?: CreateQuotePayoutsRequest.Speed; /** Payment description sent with the payout, such as an invoice number or what it pays for. Must be 5-80 printable ASCII characters (letters, digits, spaces and punctuation); Whop sends it in upper case. Not all countries and banks show it on the recipient's statement, and it is not the sender name. Omit or pass `null` to use the default descriptor. */ statement_descriptor?: string | null; /** User to pay out from, prefixed `user_`. Provide exactly one of `account_id` or `user_id`. */ user_id?: string; } export declare namespace CreateQuotePayoutsRequest { /** How fast the funds should arrive. */ const Speed: { readonly Standard: "standard"; readonly Instant: "instant"; }; type Speed = (typeof Speed)[keyof typeof Speed]; }