PaymentIntentData

Create-time PaymentIntent options accepted when creating a Checkout Session.

  • amount
    Type: amountWithCurrencyPrecisionFormat: int64

    Amount intended to be collected by this PaymentIntent.

  • 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.

  • 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.

  • setup_future_usage
    Type: 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_sessionon_session
  • payment_method
    Type: PaymentMethodId

    Single-use or reusable payment method to use for the Payment Intent created by the Checkout Session.

  • customer
    Type: Customer ID
    max length:  
    100
  • metadata

    Metadata to attach to the Payment Intent created by Checkout. When Checkout creates the first Payment from this Payment Intent, this metadata is copied onto the Payment as its initial metadata snapshot.

    • propertyName
      additionalPropertyType: string