import type * as Whop from "../../../../index.js";
/**
 * @example
 *     {
 *         account_id: "biz_xxxxxxxxxxxxxx"
 *     }
 */
export interface CreatePaymentsRequest extends Whop.PaymentInput {
    /** The code an affiliate link carries, which is the affiliate's username. The affiliate is credited for this payment as on a checkout session. A code naming no one eligible to earn on the product is ignored, and the payment goes ahead. A promo code with its own affiliate takes precedence. No affiliate is credited on a variant without a product or on a purchase of several variants. At most 255 characters. Not supported with a `card_present` `payment_method`. */
    affiliate_code?: string | null;
    /** Minutes after authorization at which Whop captures the hold automatically unless it has been voided. Requires `capture: false`. Between 5 and 5760 (4 days). */
    auto_capture_after_minutes?: number | null;
    /** The buyer's billing address, returned on the payment as `billing_address` and used to calculate tax when Whop calculates it for the account. Only with a `paypal` `payment_method`. Only the keys you supply are kept. */
    billing_address?: CreatePaymentsRequest.BillingAddress | null;
    /** Whether to capture a card payment immediately. Defaults to true. Pass false to place an authorization hold that must be captured in full within five days via the capture endpoint, or automatically after `auto_capture_after_minutes`. */
    capture?: boolean | null;
    /** A confirmation token describing a payment method the buyer just supplied. Provide this instead of `member_id` and `payment_method_id`; the buyer is resolved from the token's billing email, or from `email`. The buyer may still have a step to complete — poll the payment's status for what to do next. */
    confirmation_token?: string | null;
    /** The buyer's email, resolving or creating the user the payment belongs to. With `confirmation_token` it overrides the email the token carries, and is ignored when the token was created by a signed-in buyer; with a `card_present` `payment_method` it names a buyer the point of sale already knows, otherwise the sale belongs to a guest until a buyer is attached; with a `paypal` `payment_method` it names the buyer and is required unless `member_id` is provided. Ignored with `member_id`. */
    email?: string | null;
    /** The buyer's IPv4 or IPv6 address, used to assess the charge's risk and passed to the processor. Ignored unless a saved payment method is charged with `off_session` set to false. */
    ip_address?: string | null;
    /** What the buyer is purchasing. Each entry takes exactly one of `variant_id` or an inline `variant`. One entry charges that variant; several entries form a cart, which requires every variant to be compatible, belong to this account, and use the same currency. Mutually exclusive with `variant_id` and `variant`. */
    line_items?: CreatePaymentsRequest.LineItems.Item[];
    /** The member to charge, prefixed `mber_`. Required with `payment_method_id` unless `confirmation_token` is provided. With a `paypal` `payment_method` it names the buyer instead of `email`, and must belong to a user. */
    member_id?: string | null;
    /** Custom metadata to attach to the payment. */
    metadata?: Record<string, string | null> | null;
    /** Whether the buyer is absent from your checkout and can't authenticate. Pass true when you charge the card without the buyer, such as a renewal on your own schedule. Pass false when the buyer is present, such as a one-click upsell right after checkout: the charge is processed as a customer-initiated card-on-file payment, and if the issuer asks the buyer to authenticate, the payment's status is `requires_action` with a `next_action` to send them to, after which they return to `return_url`. From API version 2026-10-07-1 it defaults to false when `return_url` is provided and to true otherwise; before that version it defaults to true. A saved Apple Pay, Google Pay or PayPal payment method is always charged with `off_session` true. Ignored unless `member_id` and `payment_method_id` are provided. */
    off_session?: boolean | null;
    /** A payment method named on this call rather than described by a confirmation token. `type` names it and the member named after it carries its details. Nothing is collected on this call: the payment is created first and the buyer or device then acts on the `next_action` the status endpoint serves. `card_present` (Tap to Pay): the reader collects against the payment with the client secret in `next_action`. `paypal`: the buyer approves on PayPal's page, reached through a `redirect` `next_action`, then returns to `return_url`; `member_id` or `email` names the buyer. Mutually exclusive with `confirmation_token` and `payment_method_id`, and with `member_id` except for `paypal`. */
    payment_method?: CreatePaymentsRequest.PaymentMethod | null;
    /** The stored payment method to charge, prefixed `payt_`. It must belong to the member. Required unless `confirmation_token` is provided. */
    payment_method_id?: string | null;
    /** A payment quote from `POST /payment_quotes`, prefixed `pq_`. The payment charges exactly the quote: its purchase (its variants and quantities, or the `variant` it priced), which this body may then omit, its promo code, and its tax, the quote's `tax_amount` rather than a figure calculated now. Omit it, or send null, to have tax calculated when the payment is charged. The quote must belong to `account_id`. A purchase field you omit or send as null takes the quote's value; the buyer's email, the addresses and the payment method are this request's own, never the quote's. Whatever you do send must describe the quoted purchase: the same variants, quantities and promo code. A quote that priced `variant` takes only the same `variant` you sent to `POST /payment_quotes` (or omit the purchase to take the quoted one), never `variant_id` or `line_items`, and a quote that priced variants by id never takes `variant`. Unless the quote located no buyer (`located_by` is null), the address the payment carries (its shipping address, else its billing address) must put the buyer where the quote priced tax, by country, state and postal code; otherwise the payment is refused with 400 before the payment method is used. A quote located by IP address or by the country the buyer chose (`located_by` is `ip_address` or `presentment_country`) is a preview and cannot be paid. A quote is consumed by one payment: a declined payment keeps it and can be retried; a new payment needs a new quote. A quote cannot be charged by a processor that doesn't take quotes, such as a seller's own connected PayPal account; such a payment is refused before the payment method is used. A quote priced in a `presentment_currency` is charged in that currency at the quote's `exchange_rate`. A payment refused over its quote carries an error `code`. `quote_expired`: the quote has expired; quote again. `quote_tax_unavailable`: the quote could not price tax; quote again, or omit `quote_id`. `quote_preview_only`: the quote was located by IP address or by the country the buyer chose; quote again with the buyer's address. `quote_in_use` (409): another payment holds the quote. `quote_mismatch`: the purchase or the buyer's address is not the one quoted. `quote_rate_expired`: the exchange rate the quote was priced at has moved too far to charge; quote again. `payment_method_currency_unsupported`: the payment method cannot pay in the quote's currency; use another method, or quote again in another currency. `quote_processor_unsupported`: the payment would be processed by a processor that doesn't take quotes, such as a seller's own connected PayPal account; use another method, or omit `quote_id` to have tax calculated when the payment is charged. */
    quote_id?: string | null;
    /** Where the buyer continues after completing an off-site step such as 3D Secure. An absolute https URL without credentials, at most 2,048 characters. Required when a saved payment method is charged with `off_session` false; otherwise ignored unless `confirmation_token` or a `paypal` `payment_method` is provided. */
    return_url?: string | null;
    /** Attests that the buyer was told the payment method will be saved for later charges, and saves it once they approve, so it can be charged with `member_id` and `payment_method_id`. PayPal shows the buyer the agreement to future charges on its approval page. Omit it for a one-time payment that saves nothing. Ignored unless a `paypal` `payment_method` is provided. */
    setup_future_usage?: CreatePaymentsRequest.SetupFutureUsage | null;
    /** Where physical goods ship, returned on the payment as `shipping_address`. Only the keys you supply are kept; omit it for digital goods. */
    shipping_address?: CreatePaymentsRequest.ShippingAddress | null;
    /** Overrides the text on the buyer's card statement for this payment only. Takes precedence over the product's and account's custom descriptors, and changes neither. Must start with `WHOP*` unless the business processes as the merchant of record. For businesses processing as the merchant of record, omit the `WHOP*` prefix; the descriptor appears as provided. Must be 5-22 characters, contain at least one letter, and use only Latin letters, numbers, spaces, underscores, hyphens, or asterisks. */
    statement_descriptor?: string | null;
}
export declare namespace CreatePaymentsRequest {
    /**
     * The buyer's billing address, returned on the payment as `billing_address` and used to calculate tax when Whop calculates it for the account. Only with a `paypal` `payment_method`. Only the keys you supply are kept.
     */
    interface BillingAddress {
        /** City name. */
        city?: (string | null) | undefined;
        /** ISO 3166-1 alpha-2 country code, such as `US`. */
        country?: (string | null) | undefined;
        /** First line of the street address. */
        line1?: (string | null) | undefined;
        /** Second line of the street address. */
        line2?: (string | null) | undefined;
        /** The buyer's full name. */
        name?: (string | null) | undefined;
        /** Postal or ZIP code. */
        postal_code?: (string | null) | undefined;
        /** State, province, or region code, such as `CA`. */
        state?: (string | null) | undefined;
    }
    type LineItems = LineItems.Item[];
    namespace LineItems {
        type Item = unknown;
    }
    /**
     * A payment method named on this call rather than described by a confirmation token. `type` names it and the member named after it carries its details. Nothing is collected on this call: the payment is created first and the buyer or device then acts on the `next_action` the status endpoint serves. `card_present` (Tap to Pay): the reader collects against the payment with the client secret in `next_action`. `paypal`: the buyer approves on PayPal's page, reached through a `redirect` `next_action`, then returns to `return_url`; `member_id` or `email` names the buyer. Mutually exclusive with `confirmation_token` and `payment_method_id`, and with `member_id` except for `paypal`.
     */
    interface PaymentMethod {
        /** Required when `type` is `card_present`. */
        card_present?: PaymentMethod.CardPresent | undefined;
        /** The kind of payment method; the member named after it carries its details. */
        type: PaymentMethod.Type;
    }
    namespace PaymentMethod {
        /**
         * Required when `type` is `card_present`.
         */
        interface CardPresent {
            /** Which Tap to Pay SDK collects the payment. Stripe offers Tap to Pay in different countries per platform, so eligibility is checked for the named one, as it is for the connection-token session. */
            platform: CardPresent.Platform;
        }
        namespace CardPresent {
            /** Which Tap to Pay SDK collects the payment. Stripe offers Tap to Pay in different countries per platform, so eligibility is checked for the named one, as it is for the connection-token session. */
            const Platform: {
                readonly Ios: "ios";
                readonly Android: "android";
            };
            type Platform = (typeof Platform)[keyof typeof Platform];
        }
        /** The kind of payment method; the member named after it carries its details. */
        const Type: {
            readonly CardPresent: "card_present";
            readonly Paypal: "paypal";
        };
        type Type = (typeof Type)[keyof typeof Type];
    }
    /** Attests that the buyer was told the payment method will be saved for later charges, and saves it once they approve, so it can be charged with `member_id` and `payment_method_id`. PayPal shows the buyer the agreement to future charges on its approval page. Omit it for a one-time payment that saves nothing. Ignored unless a `paypal` `payment_method` is provided. */
    const SetupFutureUsage: {
        readonly OffSession: "off_session";
    };
    type SetupFutureUsage = (typeof SetupFutureUsage)[keyof typeof SetupFutureUsage];
    /**
     * Where physical goods ship, returned on the payment as `shipping_address`. Only the keys you supply are kept; omit it for digital goods.
     */
    interface ShippingAddress {
        /** City name. */
        city?: (string | null) | undefined;
        /** ISO 3166-1 alpha-2 country code, such as `US`. */
        country?: (string | null) | undefined;
        /** First line of the street address. */
        line1?: (string | null) | undefined;
        /** Second line of the street address. */
        line2?: (string | null) | undefined;
        /** The recipient's full name, as it should appear on the shipping label. */
        name?: (string | null) | undefined;
        /** Postal or ZIP code. */
        postal_code?: (string | null) | undefined;
        /** State, province, or region code, such as `CA`. */
        state?: (string | null) | undefined;
    }
}