Payment Intent (v2)

Payment Intent snapshot for payment_intent.authorized and payment_intent.captured events with api_version v2. Related resources are included as objects when available.

  • status
    Type: stringenum

    Payment Intent status at the time of the event.

    values
    • canceled

      The Payment Intent has been canceled.

    • processing

      The payment is still processing.

    • requires_action

      The customer must complete an additional action.

    • requires_capture

      Funds are authorized and available for capture.

    • requires_confirmation

      The Payment Intent is ready to be confirmed.

    • requires_payment_method

      A Payment Method is needed before confirmation.

    • succeeded

      The Payment Intent has completed successfully.

  • id
    Type: string

    Payment Intent ID.

  • created
    Type: stringFormat: date-time

    Time the Payment Intent was created.

  • updated
    Type: stringFormat: date-time

    Time the Payment Intent was last updated.

  • object
    enum
    const:  
    payment_intent

    Identifies the resource carried by this event.

  • amount
    Type: integerFormat: int64

    Amount intended to be collected. Expressed in the smallest currency unit.

  • amount_capturable
    Type: integerFormat: int64

    Amount available to capture. Expressed in the smallest currency unit.

  • amount_received
    Type: integerFormat: int64

    Amount already received. Expressed in the smallest currency unit.

  • currency
    Type: string

    Three-letter currency code.

  • currency_scale
    Type: integer

    Number of decimal places used for amounts in this currency.

  • capture_method
    Type: stringenum

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

    values
    • automatic

      Funds are captured automatically after authorization.

    • manual

      Your integration must capture authorized funds.

  • account_id
    Type: string

    Account associated with the Payment Intent.

  • checkout_id
    Type: string | null

    Related Checkout Session ID.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • statement_descriptor
    Type: string | null

    Text for the customer's payment statement.

  • on_behalf_of
    Type: string | null

    Account on whose behalf the payment is collected.

  • transfer_group
    Type: string | null

    Identifier used to associate related transfers.

  • application_fee_amount
    Type: integer | nullFormat: int64

    Application fee amount. Expressed in the smallest currency unit.

  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string
  • payment_method
    Type: Payment Method

    Payment Method details included in the resource snapshot.

    Properties: 9
  • latest_payment
    Type: Related Payment

    Summary of the latest Payment associated with the Payment Intent.

    Properties: 4
  • customer
    Type: Customer

    Customer details included in a Checkout Session or Payment Intent snapshot.

    Properties: 4
  • setup_future_usage
    Type: string | null

    Intended context for future use of the Payment Method.

  • cancellation_reason
    Type: string | null

    Reason for cancellation, when canceled.

  • canceled_at
    Type: string | nullFormat: date-time

    Time the Payment Intent was canceled.