Stripe Confirm API

openapi: 3.2.0
info:
  title: Stripe Accounts Account Confirm API
  description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Confirm
paths:
  /v1/payment_intents/{intent}/confirm:
    post:
      description: '<p>Confirm that your customer intends to pay with current or provided

        payment method. Upon confirmation, the PaymentIntent will attempt to initiate

        a payment.

        If the selected payment method requires additional authentication steps, the

        PaymentIntent will transition to the <code>requires_action</code> status and

        suggest additional actions via <code>next_action</code>. If payment fails,

        the PaymentIntent transitions to the <code>requires_payment_method</code> status or the

        <code>canceled</code> status if the confirmation limit is reached. If

        payment succeeds, the PaymentIntent will transition to the <code>succeeded</code>

        status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>).

        If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted

        using our <a href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a>

        and the PaymentIntent’s <a href="#payment_intent_object-client_secret">client_secret</a>.

        After <code>next_action</code>s are handled by the client, no additional

        confirmation is required to complete the payment.

        If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be

        initiated using a secret key.

        If any actions are required for the payment, the PaymentIntent will

        return to the <code>requires_confirmation</code> state

        after those actions are completed. Your server needs to then

        explicitly re-confirm the PaymentIntent to initiate the next payment

        attempt. Read the <a href="/docs/payments/payment-intents/web-manual">expanded documentation</a>

        to learn more about manual confirmation.</p>'
      operationId: postPaymentIntentsIntentConfirm
      parameters:
      - in: path
        name: intent
        required: true
        schema:
          maxLength: 5000
          type: string
        style: simple
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding:
              expand:
                explode: true
                style: deepObject
              mandate_data:
                explode: true
                style: deepObject
              off_session:
                explode: true
                style: deepObject
              payment_method_data:
                explode: true
                style: deepObject
              payment_method_options:
                explode: true
                style: deepObject
              payment_method_types:
                explode: true
                style: deepObject
              radar_options:
                explode: true
                style: deepObject
              receipt_email:
                explode: true
                style: deepObject
              shipping:
                explode: true
                style: deepObject
            schema:
              additionalProperties: false
              $ref: '#/components/schemas/PostPaymentIntentsIntentConfirmRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/payment_intent'
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response.
      summary: Stripe Post   Payment Intents Confirm
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      tags:
      - Confirm
components:
  schemas:
    PostPaymentIntentsIntentConfirmRequest:
      type: object
      properties:
        capture_method:
          description: Controls when the funds will be captured from the customer's account.
          enum:
          - automatic
          - automatic_async
          - manual
          type: string
        client_secret:
          description: The client secret of the PaymentIntent.
          maxLength: 5000
          type: string
        error_on_requires_action:
          description: Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication).
          type: boolean
        expand:
          description: Specifies which fields in the response should be expanded.
          items:
            maxLength: 5000
            type: string
          type: array
        mandate:
          description: ID of the mandate that's used for this payment.
          maxLength: 5000
          type: string
        mandate_data:
          anyOf:
          - properties:
              customer_acceptance:
                properties:
                  accepted_at:
                    format: unix-time
                    type: integer
                  offline:
                    properties: {}
                    title: offline_param
                    type: object
                  online:
                    properties:
                      ip_address:
                        type: string
                      user_agent:
                        maxLength: 5000
                        type: string
                    required:
                    - ip_address
                    - user_agent
                    title: online_param
                    type: object
                  type:
                    enum:
                    - offline
                    - online
                    maxLength: 5000
                    type: string
                required:
                - type
                title: customer_acceptance_param
                type: object
            required:
            - customer_acceptance
            title: secret_key_param
            type: object
          - enum:
            - ''
            type: string
          - description: This hash contains details about the Mandate to create
            properties:
              customer_acceptance:
                properties:
                  online:
                    properties:
                      ip_address:
                        type: string
                      user_agent:
                        maxLength: 5000
                        type: string
                    title: online_param
                    type: object
                  type:
                    enum:
                    - online
                    maxLength: 5000
                    type: string
                required:
                - online
                - type
                title: customer_acceptance_param
                type: object
            required:
            - customer_acceptance
            title: client_key_param
            type: object
        off_session:
          anyOf:
          - type: boolean
          - enum:
            - one_off
            - recurring
            maxLength: 5000
            type: string
          description: Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
        payment_method:
          description: ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.
          maxLength: 5000
          type: string
        payment_method_data:
          description: 'If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear

            in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)

            property on the PaymentIntent.'
          properties:
            acss_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                institution_number:
                  maxLength: 5000
                  type: string
                transit_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - institution_number
              - transit_number
              title: payment_method_param
              type: object
            affirm:
              properties: {}
              title: param
              type: object
            afterpay_clearpay:
              properties: {}
              title: param
              type: object
            alipay:
              properties: {}
              title: param
              type: object
            au_becs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                bsb_number:
                  maxLength: 5000
                  type: string
              required:
              - account_number
              - bsb_number
              title: param
              type: object
            bacs_debit:
              properties:
                account_number:
                  maxLength: 5000
                  type: string
                sort_code:
                  maxLength: 5000
                  type: string
              title: param
              type: object
            bancontact:
              properties: {}
              title: param
              type: object
            billing_details:
              properties:
                address:
                  anyOf:
                  - properties:
                      city:
                        maxLength: 5000
                        type: string
                      country:
                        maxLength: 5000
                        type: string
                      line1:
                        maxLength: 5000
                        type: string
                      line2:
                        maxLength: 5000
                        type: string
                      postal_code:
                        maxLength: 5000
                        type: string
                      state:
                        maxLength: 5000
                        type: string
                    title: billing_details_address
                    type: object
                  - enum:
                    - ''
                    type: string
                email:
                  anyOf:
                  - type: string
                  - enum:
                    - ''
                    type: string
                name:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
                phone:
                  anyOf:
                  - maxLength: 5000
                    type: string
                  - enum:
                    - ''
                    type: string
              title: billing_details_inner_params
              type: object
            blik:
              properties: {}
              title: param
              type: object
            boleto:
              properties:
                tax_id:
                  maxLength: 5000
                  type: string
              required:
              - tax_id
              title: param
              type: object
            cashapp:
              properties: {}
              title: param
              type: object
            customer_balance:
              properties: {}
              title: param
              type: object
            eps:
              properties:
                bank:
                  enum:
                  - arzte_und_apotheker_bank
                  - austrian_anadi_bank_ag
                  - bank_austria
                  - bankhaus_carl_spangler
                  - bankhaus_schelhammer_und_schattera_ag
                  - bawag_psk_ag
                  - bks_bank_ag
                  - brull_kallmus_bank_ag
                  - btv_vier_lander_bank
                  - capital_bank_grawe_gruppe_ag
                  - deutsche_bank_ag
                  - dolomitenbank
                  - easybank_ag
                  - erste_bank_und_sparkassen
                  - hypo_alpeadriabank_international_ag
                  - hypo_bank_burgenland_aktiengesellschaft
                  - hypo_noe_lb_fur_niederosterreich_u_wien
                  - hypo_oberosterreich_salzburg_steiermark
                  - hypo_tirol_bank_ag
                  - hypo_vorarlberg_bank_ag
                  - marchfelder_bank
                  - oberbank_ag
                  - raiffeisen_bankengruppe_osterreich
                  - schoellerbank_ag
                  - sparda_bank_wien
                  - volksbank_gruppe
                  - volkskreditbank_ag
                  - vr_bank_braunau
                  maxLength: 5000
                  type: string
              title: param
              type: object
            fpx:
              properties:
                bank:
                  enum:
                  - affin_bank
                  - agrobank
                  - alliance_bank
                  - ambank
                  - bank_islam
                  - bank_muamalat
                  - bank_of_china
                  - bank_rakyat
                  - bsn
                  - cimb
                  - deutsche_bank
                  - hong_leong_bank
                  - hsbc
                  - kfh
                  - maybank2e
                  - maybank2u
                  - ocbc
                  - pb_enterprise
                  - public_bank
                  - rhb
                  - standard_chartered
                  - uob
                  maxLength: 5000
                  type: string
                  x-stripeBypassValidation: true
              required:
              - bank
              title: param
              type: object
            giropay:
              properties: {}
              title: param
              type: object
            grabpay:
              properties: {}
              title: param
              type: object
            ideal:
              properties:
                bank:
                  enum:
                  - abn_amro
                  - asn_bank
                  - bunq
                  - handelsbanken
                  - ing
                  - knab
                  - moneyou
                  - n26
                  - rabobank
                  - regiobank
                  - revolut
                  - sns_bank
                  - triodos_bank
                  - van_lanschot
                  - yoursafe
                  maxLength: 5000
                  type: string
              title: param
              type: object
            interac_present:
              properties: {}
              title: param
              type: object
            klarna:
              properties:
                dob:
                  properties:
                    day:
                      type: integer
                    month:
                      type: integer
                    year:
                      type: integer
                  required:
                  - day
                  - month
                  - year
                  title: date_of_birth
                  type: object
              title: param
              type: object
            konbini:
              properties: {}
              title: param
              type: object
            link:
              properties: {}
              title: param
              type: object
            metadata:
              additionalProperties:
                type: string
              type: object
            oxxo:
              properties: {}
              title: param
              type: object
            p24:
              properties:
                bank:
                  enum:
                  - alior_bank
                  - bank_millennium
                  - bank_nowy_bfg_sa
                  - bank_pekao_sa
                  - banki_spbdzielcze
                  - blik
                  - bnp_paribas
                  - boz
                  - citi_handlowy
                  - credit_agricole
                  - envelobank
                  - etransfer_pocztowy24
                  - getin_bank
                  - ideabank
                  - ing
                  - inteligo
                  - mbank_mtransfer
                  - nest_przelew
                  - noble_pay
                  - pbac_z_ipko
                  - plus_bank
                  - santander_przelew24
                  - tmobile_usbugi_bankowe
                  - toyota_bank
                  - volkswagen_bank
                  type: string
                  x-stripeBypassValidation: true
              title: param
              type: object
            paynow:
              properties: {}
              title: param
              type: object
            paypal:
              properties: {}
              title: param
              type: object
            pix:
              properties: {}
              title: param
              type: object
            promptpay:
              properties: {}
              title: param
              type: object
            radar_options:
              properties:
                session:
                  maxLength: 5000
                  type: string
              title: radar_options
              type: object
            revolut_pay:
              properties: {}
              title: param
              type: object
            sepa_debit:
              properties:
                iban:
                  maxLength: 5000
                  type: string
              required:
              - iban
              title: param
              type: object
            sofort:
              properties:
                country:
                  enum:
                  - AT
                  - BE
                  - DE
                  - ES
                  - IT
                  - NL
                  type: string
              required:
              - country
              title: param
              type: object
            type:
              enum:
              - acss_debit
              - affirm
              - afterpay_clearpay
              - alipay
              - au_becs_debit
              - bacs_debit
              - bancontact
              - blik
              - boleto
              - cashapp
              - customer_balance
              - eps
              - fpx
              - giropay
              - grabpay
              - ideal
              - klarna
              - konbini
              - link
              - oxxo
              - p24
              - paynow
              - paypal
              - pix
              - promptpay
              - revolut_pay
              - sepa_debit
              - sofort
              - us_bank_account
              - wechat_pay
              - zip
              type: string
              x-stripeBypassValidation: true
            us_bank_account:
              properties:
                account_holder_type:
                  enum:
                  - company
                  - individual
                  type: string
                account_number:
                  maxLength: 5000
                  type: string
                account_type:
                  enum:
                  - checking
                  - savings
                  type: string
                financial_connections_account:
                  maxLength: 5000
                  type: string
                routing_number:
                  maxLength: 5000
                  type: string
              title: payment_method_param
              type: object
            wechat_pay:
              properties: {}
              title: param
              type: object
            zip:
              properties: {}
              title: param
              type: object
          required:
          - type
          title: payment_method_data_params
          type: object
        payment_method_options:
          description: Payment method-specific configuration for this PaymentIntent.
          properties:
            acss_debit:
              anyOf:
              - properties:
                  mandate_options:
                    properties:
                      custom_mandate_url:
                        anyOf:
                        - type: string
                        - enum:
                          - ''
                          type: string
                      interval_description:
                        maxLength: 500
                        type: string
                      payment_schedule:
                        enum:
                        - combined
                        - interval
                        - sporadic
                        type: string
                      transaction_type:
                        enum:
                        - business
                        - personal
                        type: string
                    title: payment_intent_payment_method_options_mandate_options_param
                    type: object
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  verification_method:
                    enum:
                    - automatic
                    - instant
                    - microdeposits
                    type: string
                    x-stripeBypassValidation: true
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            affirm:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  preferred_locale:
                    maxLength: 30
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            afterpay_clearpay:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  reference:
                    maxLength: 128
                    type: string
                  setup_future_usage:
                    enum:
                    - none
                    type: string
                    x-stripeBypassValidation: true
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            alipay:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            au_becs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bacs_debit:
              anyOf:
              - properties:
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            bancontact:
              anyOf:
              - properties:
                  preferred_language:
                    enum:
                    - de
                    - en
                    - fr
                    - nl
                    type: string
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            blik:
              anyOf:
              - properties:
                  code:
                    maxLength: 5000
                    type: string
                title: payment_intent_payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            boleto:
              anyOf:
              - properties:
                  expires_after_days:
                    type: integer
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                title: payment_method_options_param
                type: object
              - enum:
                - ''
                type: string
            card:
              anyOf:
              - properties:
                  capture_method:
                    enum:
                    - ''
                    - manual
                    type: string
                  cvc_token:
                    maxLength: 5000
                    type: string
                  installments:
                    properties:
                      enabled:
                        type: boolean
                      plan:
                        anyOf:
                        - properties:
                            count:
                              type: integer
                            interval:
                              enum:
                              - month
                              type: string
                            type:
                              enum:
                              - fixed_count
                              type: string
                          required:
                          - count
                          - interval
                          - type
                          title: installment_plan
                          type: object
                        - enum:
                          - ''
                          type: string
                    title: installments_param
                    type: object
                  mandate_options:
                    properties:
                      amount:
                        type: integer
                      amount_type:
                        enum:
                        - fixed
                        - maximum
                        type: string
                      description:
                        maxLength: 200
                        type: string
                      end_date:
                        format: unix-time
                        type: integer
                      interval:
                        enum:
                        - day
                        - month
                        - sporadic
                        - week
                        - year
                        type: string
                      interval_count:
                        type: integer
                      reference:
                        maxLength: 80
                        type: string
                      start_date:
                        format: unix-time
                        type: integer
                      supported_types:
                        items:
                          enum:
                          - india
                          type: string
                        type: array
                    required:
                    - amount
                    - amount_type
                    - interval
                    - reference
                    - start_date
                    title: mandate_options_param
                    type: object
                  network:
                    enum:
                    - amex
                    - cartes_bancaires
                    - diners
                    - discover
                    - eftpos_au
                    - interac
                    - jcb
                    - mastercard
                    - unionpay
                    - unknown
                    - visa
                    maxLength: 5000
                    type: string
                    x-stripeBypassValidation: true
                  request_extended_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_incremental_authorization:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_multicapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_overcapture:
                    enum:
                    - if_available
                    - never
                    type: string
                  request_three_d_secure:
                    enum:
                    - any
                    - automatic
                    - challenge
                    type: string
                    x-stripeBypassValidation: true
                  setup_future_usage:
                    enum:
                    - ''
                    - none
                    - off_session
                    - on_session
                    type: string
                  statement_descriptor_suffix_kana:
                    anyOf:
                    - maxLength: 22
                      type: string
                    - enum:
                      - ''
                      type: string
                  statement_descriptor_suffix_kanji:
                    anyOf:
                    - maxLength: 17
                      type: string
                    - enum:
                      - ''
                      type: string
                  three_d_secure:
                    properties:
                      ares_trans_status:
                        enum:
                        - A
                        - C
                        - I
                        - N
                        - R
                        - U
                        - Y
                        type: string
                      cryptogram:
                        maxLength: 5000
                        type: string
                      electronic_commerce_indicator:
                        enum:
                        - '01'
                        - '02'
                        - '05'
                        - '06'
                        - '07'
                        

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-confirm-api-openapi.yml