Payment Intent

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through multiple statuses throughout its lifetime to perform authentication flows and ultimately creates at most one successful payment.

  • Type: Payment Intent

    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through multiple statuses throughout its lifetime to perform authentication flows and ultimately creates at most one successful payment.

    • id
      Type: string
      required

      Unique identifier for the payment intent session

    • created
      Type: stringFormat: date-time
      required

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

    • amount
      Type: amountWithCurrencyPrecisionFormat: int64
      required

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

    • currency
      Type: Currency
      required

      Three-letter ISO currency code

      Properties: 2
    • status
      Type: stringenum
      required

      Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded.

      values
      canceledprocessingrequires_actionrequires_capturerequires_confirmationrequires_payment_methodsucceeded
    • payment_method
      required

      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: PaymentMethodId

        ID of the payment method to use when confirming a Payment Intent or Checkout Session.

    • customer

      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.

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

        • email
          Type: string | null
          max length:  
          1000

          The customer's email address.

        • 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 of string | null
          max length:  
          5000

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

        • address
          Type: Address

          The customer's address.

          Properties: 6
        • invoice_settings
          Type: CustomerInvoiceSetting

          Customer invoice settings

          Properties: 1
        • id
          Type: string
          max length:  
          100
          required

          Unique identifier for the object.

    • metadata

      Metadata attached to the Payment Intent. This value is returned when you retrieve the Payment Intent and appears in Payment Intent webhook event payloads.

      Metadata attached to the Payment Intent. This value is returned when you retrieve the Payment Intent and appears in Payment Intent webhook event payloads.

      • propertyName
        additionalPropertyType: string
    • capture_method
      Type: stringenum
      required

      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
    • amount_capturable
      Type: amountWithCurrencyPrecisionFormat: int64
      required

      Amount that can be captured from this PaymentIntent.

    • amount_received
      Type: amountWithCurrencyPrecisionFormat: int64
      required

      Amount that this PaymentIntent collects.

    • updated
      Type: stringFormat: date-time
      required

      Time at which the object was last updated.

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

    • next_action
      Type: PaymentIntentNextAction
      required
      Properties: 3
    • latest_payment
      required

      ID of the latest Payment created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted.

      • Type: PaymentId
        max length:  
        100

        ID of the latest Payment created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted.

    • cancellation_reason
      Type: PaymentIntentCancellationReasonenum
      required

      Reason for canceling this PaymentIntent. Possible values are: duplicate, fraudulent, requested_by_customer, or abandoned

      values
      abandonedduplicatefraudulentrequested_by_customer
    • canceled_at
      Type: string | nullFormat: date-time
      required

      Time at which the PaymentIntent was canceled.