PaymentIntentBase

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

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

  • customer

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

      • id
        Type: string
        max length:  
        100
        required

        Unique identifier for the object.

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

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

      • payment_methods
        Type: array object[] · PaymentMethod[]

        List of payment methods attached to the customer.

        PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

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

  • on_behalf_of
    Type: string

    Account ID to which the payment will be credited

  • payment_method
    • Type: string · PaymentMethodId

      ID of the payment method to attach to this PaymentIntent.

  • setup_future_usage
    Type: string | nullenum

    Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still attach the payment method to a Customer after the transaction completes. When processing card payments, Paypercut uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

    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.