API reference

Payment Intents

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 as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: Payment Intents API

Knox answers these operations with the same requests and responses as Stripe's API. Authenticate with your secret key, Authorization: Bearer sk_test_..., from your server, and send form-encoded bodies. Test mode only: live processing is currently disabled.

Create a PaymentIntent

POST/v1/payment_intents

Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API. When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

Body parameters

  • amountintegerRequired

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

  • currencystringRequired

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • allowed_payment_method_typesarray of strings

    The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the payment_method_types field of the response, based on the other PaymentIntent parameters, such as currency, amount, and customer.

  • amount_detailsobject

    Provides industry-specific information about the amount.

    Show 5 child parameters
    • discount_amountinteger
    • enforce_arithmetic_validationboolean
    • line_itemsarray of objects
      Show 8 child parameters
      • product_namestringRequired
      • quantityintegerRequired
      • unit_costintegerRequired
      • discount_amountinteger
      • payment_method_optionsobject

        Child parameters are listed in the OpenAPI document.

      • product_codestring
      • taxobject

        Child parameters are listed in the OpenAPI document.

      • unit_of_measurestring
    • shippingobject
      Show 3 child parameters
      • amountinteger
      • from_postal_codestring
      • to_postal_codestring
    • taxobject
      Show 1 child parameter
      • total_tax_amountintegerRequired
  • application_fee_amountinteger

    The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

  • automatic_payment_methodsobject

    When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.

    Show 2 child parameters
    • enabledbooleanRequired
    • allow_redirectsstring
      Possible values
      • always
      • never
  • capture_methodstring

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

    Possible values
    • automatic
    • automatic_async
    • manual
  • confirmboolean

    Set to true to attempt to confirm this PaymentIntent immediately. This parameter defaults to false. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.

  • confirmation_methodstring

    Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.

    Possible values
    • automatic
    • manual
  • confirmation_tokenstring

    ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

  • customerstring

    ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

  • customer_accountstring

    ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Account instead.

  • descriptionstring

    An arbitrary string attached to the object. Often useful for displaying to users.

  • error_on_requires_actionboolean

    Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true.

  • excluded_payment_method_typesarray of strings

    The list of payment method types to exclude from use with this payment.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • hooksobject

    Automations to be run during the PaymentIntent lifecycle

    Show 1 child parameter
    • inputsobject
      Show 1 child parameter
  • mandatestring

    ID of the mandate that's used for this payment. This parameter can only be used with confirm=true.

  • mandate_dataobject

    This hash contains details about the Mandate to create. This parameter can only be used with confirm=true.

    Show 1 child parameter
    • customer_acceptanceobjectRequired
      Show 4 child parameters
      • typestringRequired
        Possible values
        • offline
        • online
      • accepted_atinteger
      • offlineobject
      • onlineobject

        Child parameters are listed in the OpenAPI document.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • off_sessionboolean | string

    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 payment method details and charge them later. This parameter can only be used with confirm=true.

    Possible values
    • one_off
    • recurring
  • on_behalf_ofstring

    The Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts.

  • payment_detailsobject

    Provides industry-specific information about the charge.

    Show 2 child parameters
    • customer_referencestring
    • order_referencestring
  • payment_methodstring

    ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If you omit this parameter with confirm=true, customer.default_source attaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the payment_method moving forward. If the payment method is attached to a Customer, you must also provide the ID of that Customer as the customer parameter of this PaymentIntent.

  • payment_method_configurationstring

    The ID of the payment method configuration to use with this PaymentIntent.

  • payment_method_dataobject

    If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

    Show 59 child parameters
    • typestringRequired
      Possible values
      • acss_debit
      • affirm
      • afterpay_clearpay
      • alipay
      • alma
      • amazon_pay
      • au_becs_debit
      • bacs_debit
      • bancontact
      • billie
      • bizum
      • blik
      • boleto
      • cashapp
      • crypto
      • customer_balance
      • and 37 more
    • acss_debitobject
      Show 3 child parameters
      • account_numberstringRequired
      • institution_numberstringRequired
      • transit_numberstringRequired
    • affirmobject
    • afterpay_clearpayobject
    • alipayobject
    • allow_redisplaystring
      Possible values
      • always
      • limited
      • unspecified
    • almaobject
    • amazon_payobject
    • au_becs_debitobject
      Show 2 child parameters
      • account_numberstringRequired
      • bsb_numberstringRequired
    • bacs_debitobject
      Show 2 child parameters
      • account_numberstring
      • sort_codestring
    • bancontactobject
    • billieobject
    • billing_detailsobject
      Show 5 child parameters
      • addressobject

        Child parameters are listed in the OpenAPI document.

      • emailstring
      • namestring
      • phonestring
      • tax_idstring
    • bizumobject
    • blikobject
    • boletoobject
      Show 1 child parameter
      • tax_idstringRequired
    • cashappobject
    • cryptoobject
    • customer_balanceobject
    • epsobject
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 12 more
    • fpxobject
      Show 1 child parameter
      • bankstringRequired
        Possible values
        • affin_bank
        • agrobank
        • alliance_bank
        • ambank
        • bank_islam
        • bank_muamalat
        • bank_of_china
        • bank_rakyat
        • bnp_paribas
        • bsn
        • cimb
        • citibank
        • deutsche_bank
        • hong_leong_bank
        • hsbc
        • kfh
        • and 9 more
    • giropayobject
    • grabpayobject
    • idealobject
      Show 1 child parameter
      • bankstring
        Possible values
        • abn_amro
        • adyen
        • asn_bank
        • bunq
        • buut
        • finom
        • handelsbanken
        • ing
        • knab
        • mollie
        • moneyou
        • n26
        • nn
        • rabobank
        • regiobank
        • revolut
        • and 4 more
    • interac_presentobject
    • kakao_payobject
    • klarnaobject
      Show 1 child parameter
    • konbiniobject
    • kr_cardobject
    • linkobject
    • mb_wayobject
    • metadataobject
    • mobilepayobject
    • multibancoobject
    • naver_payobject
      Show 1 child parameter
      • fundingstring
        Possible values
        • card
        • points
    • nz_bank_accountobject
      Show 6 child parameters
      • account_numberstringRequired
      • bank_codestringRequired
      • branch_codestringRequired
      • suffixstringRequired
      • account_holder_namestring
      • referencestring
    • oxxoobject
    • p24object
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 10 more
    • pay_by_bankobject
    • paycoobject
    • paynowobject
    • paypalobject
    • paytoobject
      Show 3 child parameters
      • account_numberstring
      • bsb_numberstring
      • pay_idstring
    • pixobject
    • promptpayobject
    • radar_optionsobject
      Show 1 child parameter
      • sessionstring
    • revolut_payobject
    • samsung_payobject
    • satispayobject
    • scalapayobject
    • sepa_debitobject
      Show 1 child parameter
      • ibanstringRequired
    • sofortobject
      Show 1 child parameter
      • countrystringRequired
        Possible values
        • AT
        • BE
        • DE
        • ES
        • IT
        • NL
    • sunbitobject
    • swishobject
    • twintobject
    • upiobject
      Show 1 child parameter
    • us_bank_accountobject
      Show 5 child parameters
      • account_holder_typestring
        Possible values
        • company
        • individual
      • account_numberstring
      • account_typestring
        Possible values
        • checking
        • savings
      • financial_connections_accountstring
      • routing_numberstring
    • wechat_payobject
    • zipobject
  • payment_method_optionsobject

    Payment method-specific configuration for this PaymentIntent.

    Show 56 child parameters
    • acss_debitobject
      Show 4 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • affirmobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
      • setup_future_usagestring
        Possible values
        • none
    • afterpay_clearpayobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • alipayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • almaobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • amazon_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • au_becs_debitobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bacs_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bancontactobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • fr
        • nl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • billieobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • bizumobject
    • blikobject
      Show 2 child parameters
      • codestring
      • setup_future_usagestring
        Possible values
        • none
    • boletoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cardobject
      Show 15 child parameters
      • capture_methodstring
        Possible values
        • manual
      • cvc_tokenstring
      • installmentsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networkstring
        Possible values
        • amex
        • cartes_bancaires
        • diners
        • discover
        • eftpos_au
        • girocard
        • interac
        • jcb
        • link
        • mastercard
        • unionpay
        • unknown
        • visa
      • request_extended_authorizationstring
        Possible values
        • if_available
        • never
      • request_incremental_authorizationstring
        Possible values
        • if_available
        • never
      • request_multicapturestring
        Possible values
        • if_available
        • never
      • request_overcapturestring
        Possible values
        • if_available
        • never
      • request_three_d_securestring
        Possible values
        • any
        • automatic
        • challenge
      • require_cvc_recollectionboolean
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • statement_descriptor_suffix_kanastring
      • statement_descriptor_suffix_kanjistring
      • three_d_secureobject

        Child parameters are listed in the OpenAPI document.

    • card_presentobject
      Show 4 child parameters
      • capture_methodstring
        Possible values
        • manual
        • manual_preferred
      • request_extended_authorizationboolean
      • request_incremental_authorization_supportboolean
      • routingobject

        Child parameters are listed in the OpenAPI document.

    • cashappobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cryptoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • customer_balanceobject
      Show 3 child parameters
      • bank_transferobject

        Child parameters are listed in the OpenAPI document.

      • funding_typestring
        Possible values
        • bank_transfer
      • setup_future_usagestring
        Possible values
        • none
    • epsobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • fpxobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • giropayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • grabpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • idealobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • interac_presentobject
    • kakao_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • klarnaobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • on_demandobject

        Child parameters are listed in the OpenAPI document.

      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-CH
        • de-DE
        • el-GR
        • en-AT
        • en-AU
        • en-BE
        • en-CA
        • en-CH
        • en-CZ
        • en-DE
        • en-DK
        • en-ES
        • en-FI
        • and 30 more
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • subscriptionsarray of objects

        Child parameters are listed in the OpenAPI document.

    • konbiniobject
      Show 5 child parameters
      • confirmation_numberstring
      • expires_after_daysinteger
      • expires_atinteger
      • product_descriptionstring
      • setup_future_usagestring
        Possible values
        • none
    • kr_cardobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • linkobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • mb_wayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • mobilepayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • multibancoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • naver_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • nz_bank_accountobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • oxxoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
    • p24object
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
      • tos_shown_and_acceptedboolean
    • pay_by_bankobject
    • paycoobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • paynowobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • paypalobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-DE
        • de-LU
        • el-GR
        • en-GB
        • en-US
        • es-ES
        • fi-FI
        • fr-BE
        • fr-FR
        • fr-LU
        • hu-HU
        • it-IT
        • nl-BE
        • and 5 more
      • referencestring
      • risk_correlation_idstring
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • paytoobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • pixobject
      Show 5 child parameters
      • amount_includes_iofstring
        Possible values
        • always
        • never
      • expires_after_secondsinteger
      • expires_atinteger
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • promptpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • revolut_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • samsung_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • satispayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • scalapayobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • sepa_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • sofortobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • es
        • fr
        • it
        • nl
        • pl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • sunbitobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • swishobject
      Show 2 child parameters
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • twintobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • upiobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • us_bank_accountobject
      Show 7 child parameters
      • financial_connectionsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networksobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • transaction_purposestring
        Possible values
        • goods
        • other
        • services
        • unspecified
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • wechat_payobject
      Show 3 child parameters
      • app_idstring
      • clientstring
        Possible values
        • android
        • ios
        • web
      • setup_future_usagestring
        Possible values
        • none
    • zipobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
  • payment_method_typesarray of strings

    The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.

  • radar_optionsobject

    Options to configure Radar. Learn more about Radar Sessions.

    Show 2 child parameters
    • referrerstring
    • sessionstring
  • receipt_emailstring

    Email address to send the receipt to. If you specify receipt_email for a payment in live mode, you send a receipt regardless of your email settings.

  • return_urlstring

    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.

  • setup_future_usagestring

    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. If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead. When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

    Possible values
    • off_session
    • on_session
  • shippingobject

    Shipping information for this PaymentIntent.

    Show 5 child parameters
    • addressobjectRequired
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • namestringRequired
    • carrierstring
    • phonestring
    • tracking_numberstring
  • statement_descriptorstring

    Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

  • statement_descriptor_suffixstring

    Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

  • transfer_dataobject

    The parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.

    Show 5 child parameters
    • destinationstringRequired
    • amountinteger
    • descriptionstring
    • metadataobject
    • payment_dataobject
      Show 2 child parameters
      • descriptionstring
      • metadataobject
  • transfer_groupstring

    A string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.

  • use_stripe_sdkboolean

    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

Returns

The payment_intent object.

POST /v1/payment_intents
curl https://api.knoxapi.com/v1/payment_intents \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d amount=1099 \
  -d currency=usd
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

List all PaymentIntents

GET/v1/payment_intents

Returns a list of PaymentIntents.

Query parameters

  • createdobject | integer

    A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.

    Show 4 child parameters
    • gtinteger
    • gteinteger
    • ltinteger
    • lteinteger
  • customerstring

    Only return PaymentIntents for the customer that this customer ID specifies.

  • customer_accountstring

    Only return PaymentIntents for the account representing the customer that this ID specifies.

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of payment_intent objects.

GET /v1/payment_intents
curl -G https://api.knoxapi.com/v1/payment_intents \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/payment_intents",
  "has_more": false,
  "data": [
    {
      "amount": 1099,
      "amount_capturable": 0,
      "amount_details": {
        "tip": {}
      },
      "amount_received": 0,
      "application": null,
      "application_fee_amount": null,
      "automatic_payment_methods": {
        "enabled": true
      },
      "canceled_at": 1234567890,
      "cancellation_reason": null,
      "capture_method": "automatic",
      "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
      "confirmation_method": "automatic",
      "created": 1234567890,
      "currency": "usd",
      "customer": null,
      "description": null,
      "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
      "last_payment_error": {
        "type": "idempotency_error"
      },
      "latest_charge": null,
      "livemode": false,
      "metadata": {},
      "next_action": {
        "type": "type"
      },
      "object": "payment_intent",
      "on_behalf_of": null,
      "payment_method": null,
      "payment_method_configuration_details": {
        "id": "obj_123",
        "parent": null
      },
      "payment_method_options": {},
      "payment_method_types": [
        "card"
      ],
      "processing": {
        "type": "card"
      },
      "receipt_email": null,
      "review": null,
      "setup_future_usage": null,
      "shipping": {},
      "statement_descriptor": null,
      "statement_descriptor_suffix": null,
      "status": "requires_payment_method",
      "transfer_data": {
        "destination": {
          "id": "obj_123",
          "object": "account"
        }
      },
      "transfer_group": null,
      "source": null,
      "excluded_payment_method_types": null,
      "customer_account": null,
      "managed_payments": {
        "enabled": true
      },
      "allowed_payment_method_types": null
    }
  ]
}

Search PaymentIntents

GET/v1/payment_intents/search

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Query parameters

  • querystringRequired

    The search query string. See search query language and the list of supported query fields for payment intents.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • pagestring

    A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns

A search result of payment_intent objects.

GET /v1/payment_intents/search
curl -G https://api.knoxapi.com/v1/payment_intents/search \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode "query=metadata['order_id']:'6735'"
Response
{
  "object": "search_result",
  "url": "/v1/payment_intents/search",
  "has_more": false,
  "data": [
    {
      "amount": 1099,
      "amount_capturable": 0,
      "amount_details": {
        "tip": {}
      },
      "amount_received": 0,
      "application": null,
      "application_fee_amount": null,
      "automatic_payment_methods": {
        "enabled": true
      },
      "canceled_at": 1234567890,
      "cancellation_reason": null,
      "capture_method": "automatic",
      "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
      "confirmation_method": "automatic",
      "created": 1234567890,
      "currency": "usd",
      "customer": null,
      "description": null,
      "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
      "last_payment_error": {
        "type": "idempotency_error"
      },
      "latest_charge": null,
      "livemode": false,
      "metadata": {},
      "next_action": {
        "type": "type"
      },
      "object": "payment_intent",
      "on_behalf_of": null,
      "payment_method": null,
      "payment_method_configuration_details": {
        "id": "obj_123",
        "parent": null
      },
      "payment_method_options": {},
      "payment_method_types": [
        "card"
      ],
      "processing": {
        "type": "card"
      },
      "receipt_email": null,
      "review": null,
      "setup_future_usage": null,
      "shipping": {},
      "statement_descriptor": null,
      "statement_descriptor_suffix": null,
      "status": "requires_payment_method",
      "transfer_data": {
        "destination": {
          "id": "obj_123",
          "object": "account"
        }
      },
      "transfer_group": null,
      "source": null,
      "excluded_payment_method_types": null,
      "customer_account": null,
      "managed_payments": {
        "enabled": true
      },
      "allowed_payment_method_types": null
    }
  ],
  "next_page": null
}

Update a PaymentIntent

POST/v1/payment_intents/{intent}

Updates properties on a PaymentIntent object without confirming. Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Path parameters

  • intentstringRequired

Body parameters

  • allowed_payment_method_typesarray of strings

    The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the payment_method_types field of the response, based on the other PaymentIntent parameters, such as currency, amount, and customer.

  • amountinteger

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

  • amount_detailsobject

    Provides industry-specific information about the amount.

    Show 5 child parameters
    • discount_amountinteger
    • enforce_arithmetic_validationboolean
    • line_itemsarray of objects
      Show 8 child parameters
      • product_namestringRequired
      • quantityintegerRequired
      • unit_costintegerRequired
      • discount_amountinteger
      • payment_method_optionsobject

        Child parameters are listed in the OpenAPI document.

      • product_codestring
      • taxobject

        Child parameters are listed in the OpenAPI document.

      • unit_of_measurestring
    • shippingobject
      Show 3 child parameters
      • amountinteger
      • from_postal_codestring
      • to_postal_codestring
    • taxobject
      Show 1 child parameter
      • total_tax_amountintegerRequired
  • application_fee_amountinteger

    The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

  • capture_methodstring

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

    Possible values
    • automatic
    • automatic_async
    • manual
  • currencystring

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • customerstring

    ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

  • customer_accountstring

    ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If setup_future_usage is set and this PaymentIntent's payment method is not card_present, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Account instead.

  • descriptionstring

    An arbitrary string attached to the object. Often useful for displaying to users.

  • excluded_payment_method_typesarray of strings

    The list of payment method types to exclude from use with this payment.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • hooksobject

    Automations to be run during the PaymentIntent lifecycle

    Show 1 child parameter
    • inputsobject
      Show 1 child parameter
  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • payment_detailsobject

    Provides industry-specific information about the charge.

    Show 2 child parameters
    • customer_referencestring
    • order_referencestring
  • payment_methodstring

    ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string.

  • payment_method_configurationstring

    The ID of the payment method configuration to use with this PaymentIntent.

  • payment_method_dataobject

    If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

    Show 59 child parameters
    • typestringRequired
      Possible values
      • acss_debit
      • affirm
      • afterpay_clearpay
      • alipay
      • alma
      • amazon_pay
      • au_becs_debit
      • bacs_debit
      • bancontact
      • billie
      • bizum
      • blik
      • boleto
      • cashapp
      • crypto
      • customer_balance
      • and 37 more
    • acss_debitobject
      Show 3 child parameters
      • account_numberstringRequired
      • institution_numberstringRequired
      • transit_numberstringRequired
    • affirmobject
    • afterpay_clearpayobject
    • alipayobject
    • allow_redisplaystring
      Possible values
      • always
      • limited
      • unspecified
    • almaobject
    • amazon_payobject
    • au_becs_debitobject
      Show 2 child parameters
      • account_numberstringRequired
      • bsb_numberstringRequired
    • bacs_debitobject
      Show 2 child parameters
      • account_numberstring
      • sort_codestring
    • bancontactobject
    • billieobject
    • billing_detailsobject
      Show 5 child parameters
      • addressobject

        Child parameters are listed in the OpenAPI document.

      • emailstring
      • namestring
      • phonestring
      • tax_idstring
    • bizumobject
    • blikobject
    • boletoobject
      Show 1 child parameter
      • tax_idstringRequired
    • cashappobject
    • cryptoobject
    • customer_balanceobject
    • epsobject
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 12 more
    • fpxobject
      Show 1 child parameter
      • bankstringRequired
        Possible values
        • affin_bank
        • agrobank
        • alliance_bank
        • ambank
        • bank_islam
        • bank_muamalat
        • bank_of_china
        • bank_rakyat
        • bnp_paribas
        • bsn
        • cimb
        • citibank
        • deutsche_bank
        • hong_leong_bank
        • hsbc
        • kfh
        • and 9 more
    • giropayobject
    • grabpayobject
    • idealobject
      Show 1 child parameter
      • bankstring
        Possible values
        • abn_amro
        • adyen
        • asn_bank
        • bunq
        • buut
        • finom
        • handelsbanken
        • ing
        • knab
        • mollie
        • moneyou
        • n26
        • nn
        • rabobank
        • regiobank
        • revolut
        • and 4 more
    • interac_presentobject
    • kakao_payobject
    • klarnaobject
      Show 1 child parameter
    • konbiniobject
    • kr_cardobject
    • linkobject
    • mb_wayobject
    • metadataobject
    • mobilepayobject
    • multibancoobject
    • naver_payobject
      Show 1 child parameter
      • fundingstring
        Possible values
        • card
        • points
    • nz_bank_accountobject
      Show 6 child parameters
      • account_numberstringRequired
      • bank_codestringRequired
      • branch_codestringRequired
      • suffixstringRequired
      • account_holder_namestring
      • referencestring
    • oxxoobject
    • p24object
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 10 more
    • pay_by_bankobject
    • paycoobject
    • paynowobject
    • paypalobject
    • paytoobject
      Show 3 child parameters
      • account_numberstring
      • bsb_numberstring
      • pay_idstring
    • pixobject
    • promptpayobject
    • radar_optionsobject
      Show 1 child parameter
      • sessionstring
    • revolut_payobject
    • samsung_payobject
    • satispayobject
    • scalapayobject
    • sepa_debitobject
      Show 1 child parameter
      • ibanstringRequired
    • sofortobject
      Show 1 child parameter
      • countrystringRequired
        Possible values
        • AT
        • BE
        • DE
        • ES
        • IT
        • NL
    • sunbitobject
    • swishobject
    • twintobject
    • upiobject
      Show 1 child parameter
    • us_bank_accountobject
      Show 5 child parameters
      • account_holder_typestring
        Possible values
        • company
        • individual
      • account_numberstring
      • account_typestring
        Possible values
        • checking
        • savings
      • financial_connections_accountstring
      • routing_numberstring
    • wechat_payobject
    • zipobject
  • payment_method_optionsobject

    Payment-method-specific configuration for this PaymentIntent.

    Show 56 child parameters
    • acss_debitobject
      Show 4 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • affirmobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
      • setup_future_usagestring
        Possible values
        • none
    • afterpay_clearpayobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • alipayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • almaobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • amazon_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • au_becs_debitobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bacs_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bancontactobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • fr
        • nl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • billieobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • bizumobject
    • blikobject
      Show 2 child parameters
      • codestring
      • setup_future_usagestring
        Possible values
        • none
    • boletoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cardobject
      Show 15 child parameters
      • capture_methodstring
        Possible values
        • manual
      • cvc_tokenstring
      • installmentsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networkstring
        Possible values
        • amex
        • cartes_bancaires
        • diners
        • discover
        • eftpos_au
        • girocard
        • interac
        • jcb
        • link
        • mastercard
        • unionpay
        • unknown
        • visa
      • request_extended_authorizationstring
        Possible values
        • if_available
        • never
      • request_incremental_authorizationstring
        Possible values
        • if_available
        • never
      • request_multicapturestring
        Possible values
        • if_available
        • never
      • request_overcapturestring
        Possible values
        • if_available
        • never
      • request_three_d_securestring
        Possible values
        • any
        • automatic
        • challenge
      • require_cvc_recollectionboolean
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • statement_descriptor_suffix_kanastring
      • statement_descriptor_suffix_kanjistring
      • three_d_secureobject

        Child parameters are listed in the OpenAPI document.

    • card_presentobject
      Show 4 child parameters
      • capture_methodstring
        Possible values
        • manual
        • manual_preferred
      • request_extended_authorizationboolean
      • request_incremental_authorization_supportboolean
      • routingobject

        Child parameters are listed in the OpenAPI document.

    • cashappobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cryptoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • customer_balanceobject
      Show 3 child parameters
      • bank_transferobject

        Child parameters are listed in the OpenAPI document.

      • funding_typestring
        Possible values
        • bank_transfer
      • setup_future_usagestring
        Possible values
        • none
    • epsobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • fpxobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • giropayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • grabpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • idealobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • interac_presentobject
    • kakao_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • klarnaobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • on_demandobject

        Child parameters are listed in the OpenAPI document.

      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-CH
        • de-DE
        • el-GR
        • en-AT
        • en-AU
        • en-BE
        • en-CA
        • en-CH
        • en-CZ
        • en-DE
        • en-DK
        • en-ES
        • en-FI
        • and 30 more
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • subscriptionsarray of objects

        Child parameters are listed in the OpenAPI document.

    • konbiniobject
      Show 5 child parameters
      • confirmation_numberstring
      • expires_after_daysinteger
      • expires_atinteger
      • product_descriptionstring
      • setup_future_usagestring
        Possible values
        • none
    • kr_cardobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • linkobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • mb_wayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • mobilepayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • multibancoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • naver_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • nz_bank_accountobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • oxxoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
    • p24object
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
      • tos_shown_and_acceptedboolean
    • pay_by_bankobject
    • paycoobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • paynowobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • paypalobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-DE
        • de-LU
        • el-GR
        • en-GB
        • en-US
        • es-ES
        • fi-FI
        • fr-BE
        • fr-FR
        • fr-LU
        • hu-HU
        • it-IT
        • nl-BE
        • and 5 more
      • referencestring
      • risk_correlation_idstring
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • paytoobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • pixobject
      Show 5 child parameters
      • amount_includes_iofstring
        Possible values
        • always
        • never
      • expires_after_secondsinteger
      • expires_atinteger
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • promptpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • revolut_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • samsung_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • satispayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • scalapayobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • sepa_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • sofortobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • es
        • fr
        • it
        • nl
        • pl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • sunbitobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • swishobject
      Show 2 child parameters
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • twintobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • upiobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • us_bank_accountobject
      Show 7 child parameters
      • financial_connectionsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networksobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • transaction_purposestring
        Possible values
        • goods
        • other
        • services
        • unspecified
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • wechat_payobject
      Show 3 child parameters
      • app_idstring
      • clientstring
        Possible values
        • android
        • ios
        • web
      • setup_future_usagestring
        Possible values
        • none
    • zipobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
  • payment_method_typesarray of strings

    The list of payment method types (for example, card) that this PaymentIntent can use. Use automatic_payment_methods to manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.

  • receipt_emailstring

    Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

  • setup_future_usagestring

    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. If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead. When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session.

    Possible values
    • off_session
    • on_session
  • shippingobject

    Shipping information for this PaymentIntent.

    Show 5 child parameters
    • addressobjectRequired
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • namestringRequired
    • carrierstring
    • phonestring
    • tracking_numberstring
  • statement_descriptorstring

    Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

  • statement_descriptor_suffixstring

    Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

  • transfer_dataobject

    Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.

    Show 4 child parameters
    • amountinteger
    • descriptionstring
    • metadataobject
    • payment_dataobject
      Show 2 child parameters
      • descriptionstring
      • metadataobject
  • transfer_groupstring

    A string that identifies the resulting payment as part of a group. You can only provide transfer_group if it hasn't been set. Learn more about the use case for connected accounts.

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3 \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d "metadata[order_id]=6735"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Retrieve a PaymentIntent

GET/v1/payment_intents/{intent}

Retrieves the details of a PaymentIntent that has previously been created. You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string. If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Path parameters

  • intentstringRequired

Query parameters

  • client_secretstring

    The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The payment_intent object.

GET /v1/payment_intents/{intent}
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3 \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

List all PaymentIntent LineItems

GET/v1/payment_intents/{intent}/amount_details_line_items

Lists all LineItems of a given PaymentIntent.

Path parameters

  • intentstringRequired

Query parameters

  • ending_beforestring

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • limitinteger

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • starting_afterstring

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Returns

A list of payment_intent_amount_details_line_item objects.

GET /v1/payment_intents/{intent}/amount_details_line_items
curl -G https://api.knoxapi.com/v1/payment_intents/obj_123/amount_details_line_items \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  --data-urlencode limit=3
Response
{
  "object": "list",
  "url": "/v1/payment_intents",
  "has_more": false,
  "data": [
    {
      "discount_amount": null,
      "id": "obj_123",
      "object": "payment_intent_amount_details_line_item",
      "payment_method_options": {},
      "product_code": null,
      "product_name": "product_name",
      "quantity": 1285004149,
      "tax": {
        "total_tax_amount": 1109208903
      },
      "unit_cost": 472784472,
      "unit_of_measure": null
    }
  ]
}

Reconcile a customer_balance PaymentIntent

POST/v1/payment_intents/{intent}/apply_customer_balance

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Path parameters

  • intentstringRequired

Body parameters

  • amountinteger

    Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. If the PaymentIntent was created by an Invoice, the full amount of the PaymentIntent is applied regardless of this parameter. A positive integer representing how much to charge in the smallest currency unit (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.

  • currencystring

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/apply_customer_balance
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/apply_customer_balance \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Cancel a PaymentIntent

POST/v1/payment_intents/{intent}/cancel

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing. After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. You can directly cancel the PaymentIntent for a Checkout Session only when the PaymentIntent has a status of requires_capture. Otherwise, you must expire the Checkout Session.

Path parameters

  • intentstringRequired

Body parameters

  • cancellation_reasonstring

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

    Possible values
    • abandoned
    • duplicate
    • fraudulent
    • requested_by_customer
  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/cancel
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/cancel \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Capture a PaymentIntent

POST/v1/payment_intents/{intent}/capture

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture. Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. Learn more about separate authorization and capture.

Path parameters

  • intentstringRequired

Body parameters

  • amount_detailsobject

    Provides industry-specific information about the amount.

    Show 5 child parameters
    • discount_amountinteger
    • enforce_arithmetic_validationboolean
    • line_itemsarray of objects
      Show 8 child parameters
      • product_namestringRequired
      • quantityintegerRequired
      • unit_costintegerRequired
      • discount_amountinteger
      • payment_method_optionsobject

        Child parameters are listed in the OpenAPI document.

      • product_codestring
      • taxobject

        Child parameters are listed in the OpenAPI document.

      • unit_of_measurestring
    • shippingobject
      Show 3 child parameters
      • amountinteger
      • from_postal_codestring
      • to_postal_codestring
    • taxobject
      Show 1 child parameter
      • total_tax_amountintegerRequired
  • amount_to_captureinteger

    The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full amount_capturable if it's not provided.

  • application_fee_amountinteger

    The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • final_captureboolean

    Defaults to true. When capturing a PaymentIntent, setting final_capture to false notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.

  • hooksobject

    Automations to be run during the PaymentIntent lifecycle

    Show 1 child parameter
    • inputsobject
      Show 1 child parameter
  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • payment_detailsobject

    Provides industry-specific information about the charge.

    Show 2 child parameters
    • customer_referencestring
    • order_referencestring
  • statement_descriptorstring

    Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs. Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

  • statement_descriptor_suffixstring

    Provides information about a card charge. Concatenated to the account's statement descriptor prefix to form the complete statement descriptor that appears on the customer's statement.

  • transfer_dataobject

    The parameters that you can use to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts.

    Show 1 child parameter
    • amountinteger

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/capture
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/capture \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Confirm a PaymentIntent

POST/v1/payment_intents/{intent}/confirm

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 requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

Path parameters

  • intentstringRequired

Body parameters

  • allowed_payment_method_typesarray of strings

    The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the payment_method_types field of the response, based on the other PaymentIntent parameters, such as currency, amount, and customer.

  • amount_detailsobject

    Provides industry-specific information about the amount.

    Show 5 child parameters
    • discount_amountinteger
    • enforce_arithmetic_validationboolean
    • line_itemsarray of objects
      Show 8 child parameters
      • product_namestringRequired
      • quantityintegerRequired
      • unit_costintegerRequired
      • discount_amountinteger
      • payment_method_optionsobject

        Child parameters are listed in the OpenAPI document.

      • product_codestring
      • taxobject

        Child parameters are listed in the OpenAPI document.

      • unit_of_measurestring
    • shippingobject
      Show 3 child parameters
      • amountinteger
      • from_postal_codestring
      • to_postal_codestring
    • taxobject
      Show 1 child parameter
      • total_tax_amountintegerRequired
  • amount_to_confirminteger

    Amount to confirm on the PaymentIntent. Defaults to amount if not provided.

  • capture_methodstring

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

    Possible values
    • automatic
    • automatic_async
    • manual
  • client_secretstring

    The client secret of the PaymentIntent.

  • confirmation_tokenstring

    ID of the ConfirmationToken used to confirm this PaymentIntent. If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

  • error_on_requires_actionboolean

    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.

  • excluded_payment_method_typesarray of strings

    The list of payment method types to exclude from use with this payment.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • hooksobject

    Automations to be run during the PaymentIntent lifecycle

    Show 1 child parameter
    • inputsobject
      Show 1 child parameter
  • mandatestring

    ID of the mandate that's used for this payment.

  • mandate_dataobject
    Show 1 child parameter
    • customer_acceptanceobjectRequired
      Show 4 child parameters
      • typestringRequired
        Possible values
        • offline
        • online
      • accepted_atinteger
      • offlineobject
      • onlineobject

        Child parameters are listed in the OpenAPI document.

  • off_sessionboolean | string

    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 payment method details and charge them later.

    Possible values
    • one_off
    • recurring
  • payment_detailsobject

    Provides industry-specific information about the charge.

    Show 2 child parameters
    • customer_referencestring
    • order_referencestring
  • payment_methodstring

    ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent. If the payment method is attached to a Customer, it must match the customer that is set on this PaymentIntent.

  • payment_method_dataobject

    If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the payment_method property on the PaymentIntent.

    Show 59 child parameters
    • typestringRequired
      Possible values
      • acss_debit
      • affirm
      • afterpay_clearpay
      • alipay
      • alma
      • amazon_pay
      • au_becs_debit
      • bacs_debit
      • bancontact
      • billie
      • bizum
      • blik
      • boleto
      • cashapp
      • crypto
      • customer_balance
      • and 37 more
    • acss_debitobject
      Show 3 child parameters
      • account_numberstringRequired
      • institution_numberstringRequired
      • transit_numberstringRequired
    • affirmobject
    • afterpay_clearpayobject
    • alipayobject
    • allow_redisplaystring
      Possible values
      • always
      • limited
      • unspecified
    • almaobject
    • amazon_payobject
    • au_becs_debitobject
      Show 2 child parameters
      • account_numberstringRequired
      • bsb_numberstringRequired
    • bacs_debitobject
      Show 2 child parameters
      • account_numberstring
      • sort_codestring
    • bancontactobject
    • billieobject
    • billing_detailsobject
      Show 5 child parameters
      • addressobject

        Child parameters are listed in the OpenAPI document.

      • emailstring
      • namestring
      • phonestring
      • tax_idstring
    • bizumobject
    • blikobject
    • boletoobject
      Show 1 child parameter
      • tax_idstringRequired
    • cashappobject
    • cryptoobject
    • customer_balanceobject
    • epsobject
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 12 more
    • fpxobject
      Show 1 child parameter
      • bankstringRequired
        Possible values
        • affin_bank
        • agrobank
        • alliance_bank
        • ambank
        • bank_islam
        • bank_muamalat
        • bank_of_china
        • bank_rakyat
        • bnp_paribas
        • bsn
        • cimb
        • citibank
        • deutsche_bank
        • hong_leong_bank
        • hsbc
        • kfh
        • and 9 more
    • giropayobject
    • grabpayobject
    • idealobject
      Show 1 child parameter
      • bankstring
        Possible values
        • abn_amro
        • adyen
        • asn_bank
        • bunq
        • buut
        • finom
        • handelsbanken
        • ing
        • knab
        • mollie
        • moneyou
        • n26
        • nn
        • rabobank
        • regiobank
        • revolut
        • and 4 more
    • interac_presentobject
    • kakao_payobject
    • klarnaobject
      Show 1 child parameter
    • konbiniobject
    • kr_cardobject
    • linkobject
    • mb_wayobject
    • metadataobject
    • mobilepayobject
    • multibancoobject
    • naver_payobject
      Show 1 child parameter
      • fundingstring
        Possible values
        • card
        • points
    • nz_bank_accountobject
      Show 6 child parameters
      • account_numberstringRequired
      • bank_codestringRequired
      • branch_codestringRequired
      • suffixstringRequired
      • account_holder_namestring
      • referencestring
    • oxxoobject
    • p24object
      Show 1 child parameter
      • bankstring
        Possible values
        • 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
        • and 10 more
    • pay_by_bankobject
    • paycoobject
    • paynowobject
    • paypalobject
    • paytoobject
      Show 3 child parameters
      • account_numberstring
      • bsb_numberstring
      • pay_idstring
    • pixobject
    • promptpayobject
    • radar_optionsobject
      Show 1 child parameter
      • sessionstring
    • revolut_payobject
    • samsung_payobject
    • satispayobject
    • scalapayobject
    • sepa_debitobject
      Show 1 child parameter
      • ibanstringRequired
    • sofortobject
      Show 1 child parameter
      • countrystringRequired
        Possible values
        • AT
        • BE
        • DE
        • ES
        • IT
        • NL
    • sunbitobject
    • swishobject
    • twintobject
    • upiobject
      Show 1 child parameter
    • us_bank_accountobject
      Show 5 child parameters
      • account_holder_typestring
        Possible values
        • company
        • individual
      • account_numberstring
      • account_typestring
        Possible values
        • checking
        • savings
      • financial_connections_accountstring
      • routing_numberstring
    • wechat_payobject
    • zipobject
  • payment_method_optionsobject

    Payment method-specific configuration for this PaymentIntent.

    Show 56 child parameters
    • acss_debitobject
      Show 4 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • affirmobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
      • setup_future_usagestring
        Possible values
        • none
    • afterpay_clearpayobject
      Show 3 child parameters
      • capture_methodstring
        Possible values
        • manual
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • alipayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • almaobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • amazon_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • au_becs_debitobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bacs_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • bancontactobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • fr
        • nl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • billieobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • bizumobject
    • blikobject
      Show 2 child parameters
      • codestring
      • setup_future_usagestring
        Possible values
        • none
    • boletoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cardobject
      Show 15 child parameters
      • capture_methodstring
        Possible values
        • manual
      • cvc_tokenstring
      • installmentsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networkstring
        Possible values
        • amex
        • cartes_bancaires
        • diners
        • discover
        • eftpos_au
        • girocard
        • interac
        • jcb
        • link
        • mastercard
        • unionpay
        • unknown
        • visa
      • request_extended_authorizationstring
        Possible values
        • if_available
        • never
      • request_incremental_authorizationstring
        Possible values
        • if_available
        • never
      • request_multicapturestring
        Possible values
        • if_available
        • never
      • request_overcapturestring
        Possible values
        • if_available
        • never
      • request_three_d_securestring
        Possible values
        • any
        • automatic
        • challenge
      • require_cvc_recollectionboolean
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • statement_descriptor_suffix_kanastring
      • statement_descriptor_suffix_kanjistring
      • three_d_secureobject

        Child parameters are listed in the OpenAPI document.

    • card_presentobject
      Show 4 child parameters
      • capture_methodstring
        Possible values
        • manual
        • manual_preferred
      • request_extended_authorizationboolean
      • request_incremental_authorization_supportboolean
      • routingobject

        Child parameters are listed in the OpenAPI document.

    • cashappobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • cryptoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • customer_balanceobject
      Show 3 child parameters
      • bank_transferobject

        Child parameters are listed in the OpenAPI document.

      • funding_typestring
        Possible values
        • bank_transfer
      • setup_future_usagestring
        Possible values
        • none
    • epsobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • fpxobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • giropayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • grabpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • idealobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • interac_presentobject
    • kakao_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • klarnaobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • on_demandobject

        Child parameters are listed in the OpenAPI document.

      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-CH
        • de-DE
        • el-GR
        • en-AT
        • en-AU
        • en-BE
        • en-CA
        • en-CH
        • en-CZ
        • en-DE
        • en-DK
        • en-ES
        • en-FI
        • and 30 more
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • subscriptionsarray of objects

        Child parameters are listed in the OpenAPI document.

    • konbiniobject
      Show 5 child parameters
      • confirmation_numberstring
      • expires_after_daysinteger
      • expires_atinteger
      • product_descriptionstring
      • setup_future_usagestring
        Possible values
        • none
    • kr_cardobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • linkobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • mb_wayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • mobilepayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • multibancoobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • naver_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • nz_bank_accountobject
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • oxxoobject
      Show 2 child parameters
      • expires_after_daysinteger
      • setup_future_usagestring
        Possible values
        • none
    • p24object
      Show 2 child parameters
      • setup_future_usagestring
        Possible values
        • none
      • tos_shown_and_acceptedboolean
    • pay_by_bankobject
    • paycoobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • paynowobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • paypalobject
      Show 5 child parameters
      • capture_methodstring
        Possible values
        • manual
      • preferred_localestring
        Possible values
        • cs-CZ
        • da-DK
        • de-AT
        • de-DE
        • de-LU
        • el-GR
        • en-GB
        • en-US
        • es-ES
        • fi-FI
        • fr-BE
        • fr-FR
        • fr-LU
        • hu-HU
        • it-IT
        • nl-BE
        • and 5 more
      • referencestring
      • risk_correlation_idstring
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • paytoobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • pixobject
      Show 5 child parameters
      • amount_includes_iofstring
        Possible values
        • always
        • never
      • expires_after_secondsinteger
      • expires_atinteger
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • promptpayobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
    • revolut_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • samsung_payobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • satispayobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • scalapayobject
      Show 1 child parameter
      • capture_methodstring
        Possible values
        • manual
    • sepa_debitobject
      Show 3 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
    • sofortobject
      Show 2 child parameters
      • preferred_languagestring
        Possible values
        • de
        • en
        • es
        • fr
        • it
        • nl
        • pl
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • sunbitobject
      Show 2 child parameters
      • capture_methodstring
        Possible values
        • manual
      • setup_future_usagestring
        Possible values
        • none
    • swishobject
      Show 2 child parameters
      • referencestring
      • setup_future_usagestring
        Possible values
        • none
    • twintobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
        • off_session
    • upiobject
      Show 2 child parameters
      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
    • us_bank_accountobject
      Show 7 child parameters
      • financial_connectionsobject

        Child parameters are listed in the OpenAPI document.

      • mandate_optionsobject

        Child parameters are listed in the OpenAPI document.

      • networksobject

        Child parameters are listed in the OpenAPI document.

      • setup_future_usagestring
        Possible values
        • none
        • off_session
        • on_session
      • target_datestring
      • transaction_purposestring
        Possible values
        • goods
        • other
        • services
        • unspecified
      • verification_methodstring
        Possible values
        • automatic
        • instant
        • microdeposits
    • wechat_payobject
      Show 3 child parameters
      • app_idstring
      • clientstring
        Possible values
        • android
        • ios
        • web
      • setup_future_usagestring
        Possible values
        • none
    • zipobject
      Show 1 child parameter
      • setup_future_usagestring
        Possible values
        • none
  • payment_method_typesarray of strings

    The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.

  • radar_optionsobject

    Options to configure Radar. Learn more about Radar Sessions.

    Show 2 child parameters
    • referrerstring
    • sessionstring
  • receipt_emailstring

    Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

  • return_urlstring

    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.

  • setup_future_usagestring

    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. If the payment method is card_present and isn't a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead. When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. If you've already set setup_future_usage and you're performing a request using a publishable key, you can only update the value from on_session to off_session.

    Possible values
    • off_session
    • on_session
  • shippingobject

    Shipping information for this PaymentIntent.

    Show 5 child parameters
    • addressobjectRequired
      Show 6 child parameters
      • citystring
      • countrystring
      • line1string
      • line2string
      • postal_codestring
      • statestring
    • namestringRequired
    • carrierstring
    • phonestring
    • tracking_numberstring
  • use_stripe_sdkboolean

    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/confirm
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/confirm \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Increment an authorization

POST/v1/payment_intents/{intent}/increment_authorization

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true. Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount. If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount. Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented. Learn more about incremental authorizations with in-person payments and online payments.

Path parameters

  • intentstringRequired

Body parameters

  • amountintegerRequired

    The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.

  • amount_detailsobject

    Provides industry-specific information about the amount.

    Show 5 child parameters
    • discount_amountinteger
    • enforce_arithmetic_validationboolean
    • line_itemsarray of objects
      Show 8 child parameters
      • product_namestringRequired
      • quantityintegerRequired
      • unit_costintegerRequired
      • discount_amountinteger
      • payment_method_optionsobject

        Child parameters are listed in the OpenAPI document.

      • product_codestring
      • taxobject

        Child parameters are listed in the OpenAPI document.

      • unit_of_measurestring
    • shippingobject
      Show 3 child parameters
      • amountinteger
      • from_postal_codestring
      • to_postal_codestring
    • taxobject
      Show 1 child parameter
      • total_tax_amountintegerRequired
  • application_fee_amountinteger

    The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

  • descriptionstring

    An arbitrary string attached to the object. Often useful for displaying to users.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

  • hooksobject

    Automations to be run during the PaymentIntent lifecycle

    Show 1 child parameter
    • inputsobject
      Show 1 child parameter
  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • payment_detailsobject

    Provides industry-specific information about the charge.

    Show 2 child parameters
    • customer_referencestring
    • order_referencestring
  • statement_descriptorstring

    Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

  • transfer_dataobject

    The parameters used to automatically create a transfer after the payment is captured. Learn more about the use case for connected accounts.

    Show 1 child parameter
    • amountinteger

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/increment_authorization
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/increment_authorization \
  -H "Authorization: Bearer $KNOX_SECRET_KEY" \
  -d amount=1099
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Verify microdeposits on a PaymentIntent

POST/v1/payment_intents/{intent}/verify_microdeposits

Verifies microdeposits on a PaymentIntent object.

Path parameters

  • intentstringRequired

Body parameters

  • amountsarray of integers

    Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.

  • client_secretstring

    The client secret of the PaymentIntent.

  • descriptor_codestring

    A six-character code starting with SM present in the microdeposit sent to the bank account.

  • expandarray of strings

    Specifies which fields in the response should be expanded.

Returns

The payment_intent object.

POST /v1/payment_intents/{intent}/verify_microdeposits
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/verify_microdeposits \
  -H "Authorization: Bearer $KNOX_SECRET_KEY"
Response
{
  "amount": 1099,
  "amount_capturable": 0,
  "amount_details": {
    "tip": {}
  },
  "amount_received": 0,
  "application": null,
  "application_fee_amount": null,
  "automatic_payment_methods": {
    "enabled": true
  },
  "canceled_at": 1234567890,
  "cancellation_reason": null,
  "capture_method": "automatic",
  "client_secret": "pi_1PgafyB7WZ01zgkWSjxsAJo3_secret_Dm43xiq1k0ywrRRjDoi8y1gkM",
  "confirmation_method": "automatic",
  "created": 1234567890,
  "currency": "usd",
  "customer": null,
  "description": null,
  "id": "pi_1PgafyB7WZ01zgkWSjxsAJo3",
  "last_payment_error": {
    "type": "idempotency_error"
  },
  "latest_charge": null,
  "livemode": false,
  "metadata": {},
  "next_action": {
    "type": "type"
  },
  "object": "payment_intent",
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_configuration_details": {
    "id": "obj_123",
    "parent": null
  },
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "processing": {
    "type": "card"
  },
  "receipt_email": null,
  "review": null,
  "setup_future_usage": null,
  "shipping": {},
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "requires_payment_method",
  "transfer_data": {
    "destination": {
      "id": "obj_123",
      "object": "account"
    }
  },
  "transfer_group": null,
  "source": null,
  "excluded_payment_method_types": null,
  "customer_account": null,
  "managed_payments": {
    "enabled": true
  },
  "allowed_payment_method_types": null
}

Operations and schemas come from the pinned Stripe OpenAPI specification (MIT); response examples from its fixtures. Nested object definitions and enums are in the complete specification.