PaymentIntentResponseBase

  • amount
    Type: integer · amountWithCurrencyPrecisionFormat: int64

    Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

  • payment_method
    nullable

    ID of the payment method attached to this PaymentIntent, or the expanded PaymentMethod object when requested with expand=payment_method. This value is null until a payment method is provided.

    • Type: string · PaymentMethodId

      ID of the payment method to attach to this PaymentIntent.

  • customer
    nullable

    ID of the customer attached to this PaymentIntent, or the expanded Customer object when requested with expand=customer. This value is null when no customer is attached.

    • This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

      • created
        Type: stringFormat: date-time
        required

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • livemode
        Type: boolean
        required

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • id
        Type: string
        max length:  
        100
        required

        Unique identifier for the object.

      • address

        The customer's address.

      • email
        Type: string | null
        max length:  
        1000

        The customer's email address.

      • invoice_settings

        Customer invoice settings

      • name
        Type: string | null
        max length:  
        5000

        The customer's full name or business name.

      • phone
        Type: string | null
        max length:  
        5000

        The customer's phone number.

      • preferred_locales
        Type: array string[] | null

        The customer's preferred locales (languages), ordered by preference.

  • capture_method
    Type: stringenum

    Controls when the funds will be captured from the customer's account.

    values
    • automatic

      Paypercut automatically captures funds when the customer authorizes the payment.

    • manual

      Place a hold on the funds when the customer authorizes the payment, but don't capture the funds until later.

  • on_behalf_of
    Type: string

    Account ID to which the payment will be credited

  • setup_future_usage
    Type: string | null · SetupFutureUsageenum

    Indicates that you intend to make future payments with the Payment Intent's payment method. Use on_session when future payments will be made while the customer is present in your checkout flow. Use off_session when future payments may happen while the customer is not present, such as subscriptions or saved-card charges. If the Payment Intent has a customer, Paypercut can attach and promote a single-use payment method to that customer after the Payment Intent is confirmed and the customer completes any required authentication. When this value is provided during confirmation, it takes precedence over the value stored on the Payment Intent.

    values
    • off_session
    • on_session
  • statement_descriptor
    Type: string | null
    max length:  
    100

    Text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor.