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
https://api.knoxapi.com- POST/
v1/ payment_intents - GET/
v1/ payment_intents - GET/
v1/ payment_intents/ search - POST/
v1/ payment_intents/ {intent} - GET/
v1/ payment_intents/ {intent} - GET/
v1/ payment_intents/ {intent}/ amount_details_line_items - POST/
v1/ payment_intents/ {intent}/ apply_customer_balance - POST/
v1/ payment_intents/ {intent}/ cancel - POST/
v1/ payment_intents/ {intent}/ capture - POST/
v1/ payment_intents/ {intent}/ confirm - POST/
v1/ payment_intents/ {intent}/ increment_authorization - POST/
v1/ payment_intents/ {intent}/ verify_microdeposits
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
amountintegerRequiredAmount 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).
currencystringRequiredThree-letter ISO currency code, in lowercase. Must be a supported currency.
allowed_payment_method_typesarray of stringsThe list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the
payment_method_typesfield of the response, based on the other PaymentIntent parameters, such ascurrency,amount, andcustomer.amount_detailsobjectProvides industry-specific information about the amount.
Show 5 child parameters
discount_amountintegerenforce_arithmetic_validationbooleanline_itemsarray of objectsShow 8 child parameters
product_namestringRequiredquantityintegerRequiredunit_costintegerRequireddiscount_amountintegerpayment_method_optionsobjectChild parameters are listed in the OpenAPI document.
product_codestringtaxobjectChild parameters are listed in the OpenAPI document.
unit_of_measurestring
shippingobjectShow 3 child parameters
amountintegerfrom_postal_codestringto_postal_codestring
taxobjectShow 1 child parameter
total_tax_amountintegerRequired
application_fee_amountintegerThe 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_methodsobjectWhen 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
enabledbooleanRequiredallow_redirectsstringPossible valuesalwaysnever
capture_methodstringControls when the funds will be captured from the customer's account.
Possible valuesautomaticautomatic_asyncmanual
confirmbooleanSet to
trueto attempt to confirm this PaymentIntent immediately. This parameter defaults tofalse. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the Confirm API.confirmation_methodstringDescribes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.
Possible valuesautomaticmanual
confirmation_tokenstringID 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.customerstringID 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 iscard_presentand isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.customer_accountstringID 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 iscard_presentand isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Account instead.descriptionstringAn arbitrary string attached to the object. Often useful for displaying to users.
error_on_requires_actionbooleanSet to
trueto fail the payment attempt if the PaymentIntent transitions intorequires_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 withconfirm=true.excluded_payment_method_typesarray of stringsThe list of payment method types to exclude from use with this payment.
expandarray of stringsSpecifies which fields in the response should be expanded.
hooksobjectAutomations to be run during the PaymentIntent lifecycle
Show 1 child parameter
inputsobjectShow 1 child parameter
taxobjectChild parameters are listed in the OpenAPI document.
mandatestringID of the mandate that's used for this payment. This parameter can only be used with
confirm=true.mandate_dataobjectThis hash contains details about the Mandate to create. This parameter can only be used with
confirm=true.Show 1 child parameter
customer_acceptanceobjectRequiredShow 4 child parameters
typestringRequiredPossible valuesofflineonline
accepted_atintegerofflineobjectonlineobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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 | stringSet to
trueto 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 withconfirm=true.Possible valuesone_offrecurring
on_behalf_ofstringThe Stripe account ID that these funds are intended for. Learn more about the use case for connected accounts.
payment_detailsobjectProvides industry-specific information about the charge.
Show 2 child parameters
customer_referencestringorder_referencestring
payment_methodstringID 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_sourceattaches as this PaymentIntent's payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide thepayment_methodmoving 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_configurationstringThe ID of the payment method configuration to use with this PaymentIntent.
payment_method_dataobjectIf 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
typestringRequiredPossible valuesacss_debitaffirmafterpay_clearpayalipayalmaamazon_payau_becs_debitbacs_debitbancontactbilliebizumblikboletocashappcryptocustomer_balance- and 37 more
acss_debitobjectShow 3 child parameters
account_numberstringRequiredinstitution_numberstringRequiredtransit_numberstringRequired
affirmobjectafterpay_clearpayobjectalipayobjectallow_redisplaystringPossible valuesalwayslimitedunspecified
almaobjectamazon_payobjectau_becs_debitobjectShow 2 child parameters
account_numberstringRequiredbsb_numberstringRequired
bacs_debitobjectShow 2 child parameters
account_numberstringsort_codestring
bancontactobjectbillieobjectbilling_detailsobjectShow 5 child parameters
addressobjectChild parameters are listed in the OpenAPI document.
emailstringnamestringphonestringtax_idstring
bizumobjectblikobjectboletoobjectShow 1 child parameter
tax_idstringRequired
cashappobjectcryptoobjectcustomer_balanceobjectepsobjectShow 1 child parameter
bankstringPossible valuesarzte_und_apotheker_bankaustrian_anadi_bank_agbank_austriabankhaus_carl_spanglerbankhaus_schelhammer_und_schattera_agbawag_psk_agbks_bank_agbrull_kallmus_bank_agbtv_vier_lander_bankcapital_bank_grawe_gruppe_agdeutsche_bank_agdolomitenbankeasybank_agerste_bank_und_sparkassenhypo_alpeadriabank_international_aghypo_bank_burgenland_aktiengesellschaft- and 12 more
fpxobjectShow 1 child parameter
bankstringRequiredPossible valuesaffin_bankagrobankalliance_bankambankbank_islambank_muamalatbank_of_chinabank_rakyatbnp_paribasbsncimbcitibankdeutsche_bankhong_leong_bankhsbckfh- and 9 more
giropayobjectgrabpayobjectidealobjectShow 1 child parameter
bankstringPossible valuesabn_amroadyenasn_bankbunqbuutfinomhandelsbankeningknabmolliemoneyoun26nnrabobankregiobankrevolut- and 4 more
interac_presentobjectkakao_payobjectklarnaobjectShow 1 child parameter
dobobjectChild parameters are listed in the OpenAPI document.
konbiniobjectkr_cardobjectlinkobjectmb_wayobjectmetadataobjectmobilepayobjectmultibancoobjectnaver_payobjectShow 1 child parameter
fundingstringPossible valuescardpoints
nz_bank_accountobjectShow 6 child parameters
account_numberstringRequiredbank_codestringRequiredbranch_codestringRequiredsuffixstringRequiredaccount_holder_namestringreferencestring
oxxoobjectp24objectShow 1 child parameter
bankstringPossible valuesalior_bankbank_millenniumbank_nowy_bfg_sabank_pekao_sabanki_spbdzielczeblikbnp_paribasbozciti_handlowycredit_agricoleenvelobanketransfer_pocztowy24getin_bankideabankinginteligo- and 10 more
pay_by_bankobjectpaycoobjectpaynowobjectpaypalobjectpaytoobjectShow 3 child parameters
account_numberstringbsb_numberstringpay_idstring
pixobjectpromptpayobjectradar_optionsobjectShow 1 child parameter
sessionstring
revolut_payobjectsamsung_payobjectsatispayobjectscalapayobjectsepa_debitobjectShow 1 child parameter
ibanstringRequired
sofortobjectShow 1 child parameter
countrystringRequiredPossible valuesATBEDEESITNL
sunbitobjectswishobjecttwintobjectupiobjectShow 1 child parameter
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
us_bank_accountobjectShow 5 child parameters
account_holder_typestringPossible valuescompanyindividual
account_numberstringaccount_typestringPossible valuescheckingsavings
financial_connections_accountstringrouting_numberstring
wechat_payobjectzipobject
payment_method_optionsobjectPayment method-specific configuration for this PaymentIntent.
Show 56 child parameters
acss_debitobjectShow 4 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringverification_methodstringPossible valuesautomaticinstantmicrodeposits
affirmobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringsetup_future_usagestringPossible valuesnone
afterpay_clearpayobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
referencestringsetup_future_usagestringPossible valuesnone
alipayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
almaobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
amazon_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
au_becs_debitobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bacs_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bancontactobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenfrnl
setup_future_usagestringPossible valuesnoneoff_session
billieobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
bizumobjectblikobjectShow 2 child parameters
codestringsetup_future_usagestringPossible valuesnone
boletoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnoneoff_sessionon_session
cardobjectShow 15 child parameters
capture_methodstringPossible valuesmanual
cvc_tokenstringinstallmentsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networkstringPossible valuesamexcartes_bancairesdinersdiscovereftpos_augirocardinteracjcblinkmastercardunionpayunknownvisa
request_extended_authorizationstringPossible valuesif_availablenever
request_incremental_authorizationstringPossible valuesif_availablenever
request_multicapturestringPossible valuesif_availablenever
request_overcapturestringPossible valuesif_availablenever
request_three_d_securestringPossible valuesanyautomaticchallenge
require_cvc_recollectionbooleansetup_future_usagestringPossible valuesnoneoff_sessionon_session
statement_descriptor_suffix_kanastringstatement_descriptor_suffix_kanjistringthree_d_secureobjectChild parameters are listed in the OpenAPI document.
card_presentobjectShow 4 child parameters
capture_methodstringPossible valuesmanualmanual_preferred
request_extended_authorizationbooleanrequest_incremental_authorization_supportbooleanroutingobjectChild parameters are listed in the OpenAPI document.
cashappobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
cryptoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
customer_balanceobjectShow 3 child parameters
bank_transferobjectChild parameters are listed in the OpenAPI document.
funding_typestringPossible valuesbank_transfer
setup_future_usagestringPossible valuesnone
epsobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
fpxobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
giropayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
grabpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
idealobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
interac_presentobjectkakao_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
klarnaobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
on_demandobjectChild parameters are listed in the OpenAPI document.
preferred_localestringPossible valuescs-CZda-DKde-ATde-CHde-DEel-GRen-ATen-AUen-BEen-CAen-CHen-CZen-DEen-DKen-ESen-FI- and 30 more
setup_future_usagestringPossible valuesnoneoff_sessionon_session
subscriptionsarray of objectsChild parameters are listed in the OpenAPI document.
konbiniobjectShow 5 child parameters
confirmation_numberstringexpires_after_daysintegerexpires_atintegerproduct_descriptionstringsetup_future_usagestringPossible valuesnone
kr_cardobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
linkobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
mb_wayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
mobilepayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
multibancoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
naver_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
nz_bank_accountobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
oxxoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnone
p24objectShow 2 child parameters
setup_future_usagestringPossible valuesnone
tos_shown_and_acceptedboolean
pay_by_bankobjectpaycoobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
paynowobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
paypalobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringPossible valuescs-CZda-DKde-ATde-DEde-LUel-GRen-GBen-USes-ESfi-FIfr-BEfr-FRfr-LUhu-HUit-ITnl-BE- and 5 more
referencestringrisk_correlation_idstringsetup_future_usagestringPossible valuesnoneoff_session
paytoobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
pixobjectShow 5 child parameters
amount_includes_iofstringPossible valuesalwaysnever
expires_after_secondsintegerexpires_atintegermandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
promptpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
revolut_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
samsung_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
satispayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
scalapayobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
sepa_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
sofortobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenesfritnlpl
setup_future_usagestringPossible valuesnoneoff_session
sunbitobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
swishobjectShow 2 child parameters
referencestringsetup_future_usagestringPossible valuesnone
twintobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
upiobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
us_bank_accountobjectShow 7 child parameters
financial_connectionsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networksobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringtransaction_purposestringPossible valuesgoodsotherservicesunspecified
verification_methodstringPossible valuesautomaticinstantmicrodeposits
wechat_payobjectShow 3 child parameters
app_idstringclientstringPossible valuesandroidiosweb
setup_future_usagestringPossible valuesnone
zipobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
payment_method_typesarray of stringsThe 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_optionsobjectOptions to configure Radar. Learn more about Radar Sessions.
Show 2 child parameters
referrerstringsessionstring
receipt_emailstringEmail address to send the receipt to. If you specify
receipt_emailfor a payment in live mode, you send a receipt regardless of your email settings.return_urlstringThe 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_usagestringIndicates 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_presentand 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 usessetup_future_usageto help you comply with regional legislation and network rules, such as SCA.Possible valuesoff_sessionon_session
shippingobjectShipping information for this PaymentIntent.
Show 5 child parameters
addressobjectRequiredShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
namestringRequiredcarrierstringphonestringtracking_numberstring
statement_descriptorstringText 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_suffixstringProvides 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_dataobjectThe parameters that you can use to automatically create a Transfer. Learn more about the use case for connected accounts.
Show 5 child parameters
destinationstringRequiredamountintegerdescriptionstringmetadataobjectpayment_dataobjectShow 2 child parameters
descriptionstringmetadataobject
transfer_groupstringA string that identifies the resulting payment as part of a group. Learn more about the use case for connected accounts.
use_stripe_sdkbooleanSet to
truewhen confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
Returns
The payment_intent object.
curl https://api.knoxapi.com/v1/payment_intents \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d amount=1099 \
-d currency=usdconst Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.create({
amount: 1099,
currency: 'usd',
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.create(params={
"amount": 1099,
"currency": "usd",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.create({
amount: 1099,
currency: 'usd',
}){
"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 | integerA filter on the list, based on the object
createdfield. 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
gtintegergteintegerltintegerlteinteger
customerstringOnly return PaymentIntents for the customer that this customer ID specifies.
customer_accountstringOnly return PaymentIntents for the account representing the customer that this ID specifies.
ending_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of payment_intent objects.
curl -G https://api.knoxapi.com/v1/payment_intents \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const page = await stripe.paymentIntents.list({
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
page = client.v1.payment_intents.list(params={
"limit": 3,
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
page = Stripe::PaymentIntent.list({
limit: 3,
}){
"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
querystringRequiredThe search query string. See search query language and the list of supported query fields for payment intents.
expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
pagestringA 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.
curl -G https://api.knoxapi.com/v1/payment_intents/search \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode "query=metadata['order_id']:'6735'"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const page = await stripe.paymentIntents.search({
query: "metadata['order_id']:'6735'",
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
page = client.v1.payment_intents.search(params={
"query": "metadata['order_id']:'6735'",
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
page = Stripe::PaymentIntent.search({
query: "metadata['order_id']:'6735'",
}){
"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 stringsThe list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the
payment_method_typesfield of the response, based on the other PaymentIntent parameters, such ascurrency,amount, andcustomer.amountintegerAmount 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_detailsobjectProvides industry-specific information about the amount.
Show 5 child parameters
discount_amountintegerenforce_arithmetic_validationbooleanline_itemsarray of objectsShow 8 child parameters
product_namestringRequiredquantityintegerRequiredunit_costintegerRequireddiscount_amountintegerpayment_method_optionsobjectChild parameters are listed in the OpenAPI document.
product_codestringtaxobjectChild parameters are listed in the OpenAPI document.
unit_of_measurestring
shippingobjectShow 3 child parameters
amountintegerfrom_postal_codestringto_postal_codestring
taxobjectShow 1 child parameter
total_tax_amountintegerRequired
application_fee_amountintegerThe 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_methodstringControls when the funds will be captured from the customer's account.
Possible valuesautomaticautomatic_asyncmanual
currencystringThree-letter ISO currency code, in lowercase. Must be a supported currency.
customerstringID 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 iscard_presentand isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.customer_accountstringID 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 iscard_presentand isn't a digital wallet, then a generated_card payment method representing the card is created and attached to the Account instead.descriptionstringAn arbitrary string attached to the object. Often useful for displaying to users.
excluded_payment_method_typesarray of stringsThe list of payment method types to exclude from use with this payment.
expandarray of stringsSpecifies which fields in the response should be expanded.
hooksobjectAutomations to be run during the PaymentIntent lifecycle
Show 1 child parameter
inputsobjectShow 1 child parameter
taxobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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_detailsobjectProvides industry-specific information about the charge.
Show 2 child parameters
customer_referencestringorder_referencestring
payment_methodstringID 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_configurationstringThe ID of the payment method configuration to use with this PaymentIntent.
payment_method_dataobjectIf 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
typestringRequiredPossible valuesacss_debitaffirmafterpay_clearpayalipayalmaamazon_payau_becs_debitbacs_debitbancontactbilliebizumblikboletocashappcryptocustomer_balance- and 37 more
acss_debitobjectShow 3 child parameters
account_numberstringRequiredinstitution_numberstringRequiredtransit_numberstringRequired
affirmobjectafterpay_clearpayobjectalipayobjectallow_redisplaystringPossible valuesalwayslimitedunspecified
almaobjectamazon_payobjectau_becs_debitobjectShow 2 child parameters
account_numberstringRequiredbsb_numberstringRequired
bacs_debitobjectShow 2 child parameters
account_numberstringsort_codestring
bancontactobjectbillieobjectbilling_detailsobjectShow 5 child parameters
addressobjectChild parameters are listed in the OpenAPI document.
emailstringnamestringphonestringtax_idstring
bizumobjectblikobjectboletoobjectShow 1 child parameter
tax_idstringRequired
cashappobjectcryptoobjectcustomer_balanceobjectepsobjectShow 1 child parameter
bankstringPossible valuesarzte_und_apotheker_bankaustrian_anadi_bank_agbank_austriabankhaus_carl_spanglerbankhaus_schelhammer_und_schattera_agbawag_psk_agbks_bank_agbrull_kallmus_bank_agbtv_vier_lander_bankcapital_bank_grawe_gruppe_agdeutsche_bank_agdolomitenbankeasybank_agerste_bank_und_sparkassenhypo_alpeadriabank_international_aghypo_bank_burgenland_aktiengesellschaft- and 12 more
fpxobjectShow 1 child parameter
bankstringRequiredPossible valuesaffin_bankagrobankalliance_bankambankbank_islambank_muamalatbank_of_chinabank_rakyatbnp_paribasbsncimbcitibankdeutsche_bankhong_leong_bankhsbckfh- and 9 more
giropayobjectgrabpayobjectidealobjectShow 1 child parameter
bankstringPossible valuesabn_amroadyenasn_bankbunqbuutfinomhandelsbankeningknabmolliemoneyoun26nnrabobankregiobankrevolut- and 4 more
interac_presentobjectkakao_payobjectklarnaobjectShow 1 child parameter
dobobjectChild parameters are listed in the OpenAPI document.
konbiniobjectkr_cardobjectlinkobjectmb_wayobjectmetadataobjectmobilepayobjectmultibancoobjectnaver_payobjectShow 1 child parameter
fundingstringPossible valuescardpoints
nz_bank_accountobjectShow 6 child parameters
account_numberstringRequiredbank_codestringRequiredbranch_codestringRequiredsuffixstringRequiredaccount_holder_namestringreferencestring
oxxoobjectp24objectShow 1 child parameter
bankstringPossible valuesalior_bankbank_millenniumbank_nowy_bfg_sabank_pekao_sabanki_spbdzielczeblikbnp_paribasbozciti_handlowycredit_agricoleenvelobanketransfer_pocztowy24getin_bankideabankinginteligo- and 10 more
pay_by_bankobjectpaycoobjectpaynowobjectpaypalobjectpaytoobjectShow 3 child parameters
account_numberstringbsb_numberstringpay_idstring
pixobjectpromptpayobjectradar_optionsobjectShow 1 child parameter
sessionstring
revolut_payobjectsamsung_payobjectsatispayobjectscalapayobjectsepa_debitobjectShow 1 child parameter
ibanstringRequired
sofortobjectShow 1 child parameter
countrystringRequiredPossible valuesATBEDEESITNL
sunbitobjectswishobjecttwintobjectupiobjectShow 1 child parameter
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
us_bank_accountobjectShow 5 child parameters
account_holder_typestringPossible valuescompanyindividual
account_numberstringaccount_typestringPossible valuescheckingsavings
financial_connections_accountstringrouting_numberstring
wechat_payobjectzipobject
payment_method_optionsobjectPayment-method-specific configuration for this PaymentIntent.
Show 56 child parameters
acss_debitobjectShow 4 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringverification_methodstringPossible valuesautomaticinstantmicrodeposits
affirmobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringsetup_future_usagestringPossible valuesnone
afterpay_clearpayobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
referencestringsetup_future_usagestringPossible valuesnone
alipayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
almaobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
amazon_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
au_becs_debitobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bacs_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bancontactobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenfrnl
setup_future_usagestringPossible valuesnoneoff_session
billieobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
bizumobjectblikobjectShow 2 child parameters
codestringsetup_future_usagestringPossible valuesnone
boletoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnoneoff_sessionon_session
cardobjectShow 15 child parameters
capture_methodstringPossible valuesmanual
cvc_tokenstringinstallmentsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networkstringPossible valuesamexcartes_bancairesdinersdiscovereftpos_augirocardinteracjcblinkmastercardunionpayunknownvisa
request_extended_authorizationstringPossible valuesif_availablenever
request_incremental_authorizationstringPossible valuesif_availablenever
request_multicapturestringPossible valuesif_availablenever
request_overcapturestringPossible valuesif_availablenever
request_three_d_securestringPossible valuesanyautomaticchallenge
require_cvc_recollectionbooleansetup_future_usagestringPossible valuesnoneoff_sessionon_session
statement_descriptor_suffix_kanastringstatement_descriptor_suffix_kanjistringthree_d_secureobjectChild parameters are listed in the OpenAPI document.
card_presentobjectShow 4 child parameters
capture_methodstringPossible valuesmanualmanual_preferred
request_extended_authorizationbooleanrequest_incremental_authorization_supportbooleanroutingobjectChild parameters are listed in the OpenAPI document.
cashappobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
cryptoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
customer_balanceobjectShow 3 child parameters
bank_transferobjectChild parameters are listed in the OpenAPI document.
funding_typestringPossible valuesbank_transfer
setup_future_usagestringPossible valuesnone
epsobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
fpxobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
giropayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
grabpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
idealobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
interac_presentobjectkakao_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
klarnaobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
on_demandobjectChild parameters are listed in the OpenAPI document.
preferred_localestringPossible valuescs-CZda-DKde-ATde-CHde-DEel-GRen-ATen-AUen-BEen-CAen-CHen-CZen-DEen-DKen-ESen-FI- and 30 more
setup_future_usagestringPossible valuesnoneoff_sessionon_session
subscriptionsarray of objectsChild parameters are listed in the OpenAPI document.
konbiniobjectShow 5 child parameters
confirmation_numberstringexpires_after_daysintegerexpires_atintegerproduct_descriptionstringsetup_future_usagestringPossible valuesnone
kr_cardobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
linkobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
mb_wayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
mobilepayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
multibancoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
naver_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
nz_bank_accountobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
oxxoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnone
p24objectShow 2 child parameters
setup_future_usagestringPossible valuesnone
tos_shown_and_acceptedboolean
pay_by_bankobjectpaycoobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
paynowobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
paypalobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringPossible valuescs-CZda-DKde-ATde-DEde-LUel-GRen-GBen-USes-ESfi-FIfr-BEfr-FRfr-LUhu-HUit-ITnl-BE- and 5 more
referencestringrisk_correlation_idstringsetup_future_usagestringPossible valuesnoneoff_session
paytoobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
pixobjectShow 5 child parameters
amount_includes_iofstringPossible valuesalwaysnever
expires_after_secondsintegerexpires_atintegermandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
promptpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
revolut_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
samsung_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
satispayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
scalapayobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
sepa_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
sofortobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenesfritnlpl
setup_future_usagestringPossible valuesnoneoff_session
sunbitobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
swishobjectShow 2 child parameters
referencestringsetup_future_usagestringPossible valuesnone
twintobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
upiobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
us_bank_accountobjectShow 7 child parameters
financial_connectionsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networksobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringtransaction_purposestringPossible valuesgoodsotherservicesunspecified
verification_methodstringPossible valuesautomaticinstantmicrodeposits
wechat_payobjectShow 3 child parameters
app_idstringclientstringPossible valuesandroidiosweb
setup_future_usagestringPossible valuesnone
zipobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
payment_method_typesarray of stringsThe list of payment method types (for example, card) that this PaymentIntent can use. Use
automatic_payment_methodsto manage payment methods from the Stripe Dashboard. A list of valid payment method types can be found here.receipt_emailstringEmail address that the receipt for the resulting payment will be sent to. If
receipt_emailis specified for a payment in live mode, a receipt will be sent regardless of your email settings.setup_future_usagestringIndicates 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_presentand 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 usessetup_future_usageto help you comply with regional legislation and network rules, such as SCA. If you've already setsetup_future_usageand you're performing a request using a publishable key, you can only update the value fromon_sessiontooff_session.Possible valuesoff_sessionon_session
shippingobjectShipping information for this PaymentIntent.
Show 5 child parameters
addressobjectRequiredShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
namestringRequiredcarrierstringphonestringtracking_numberstring
statement_descriptorstringText 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_suffixstringProvides 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_dataobjectUse this parameter to automatically create a Transfer when the payment succeeds. Learn more about the use case for connected accounts.
Show 4 child parameters
amountintegerdescriptionstringmetadataobjectpayment_dataobjectShow 2 child parameters
descriptionstringmetadataobject
transfer_groupstringA string that identifies the resulting payment as part of a group. You can only provide
transfer_groupif it hasn't been set. Learn more about the use case for connected accounts.
Returns
The payment_intent object.
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3 \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d "metadata[order_id]=6735"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.update('pi_1PgafyB7WZ01zgkWSjxsAJo3', {
metadata: {
order_id: '6735',
},
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.update("pi_1PgafyB7WZ01zgkWSjxsAJo3", params={
"metadata": {
"order_id": "6735",
},
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.update('pi_1PgafyB7WZ01zgkWSjxsAJo3', {
metadata: {
order_id: '6735',
},
}){
"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_secretstringThe client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The payment_intent object.
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3 \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.retrieve('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.retrieve("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.retrieve('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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_beforestringA cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.expandarray of stringsSpecifies which fields in the response should be expanded.
limitintegerA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterstringA cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A list of payment_intent_amount_details_line_item objects.
curl -G https://api.knoxapi.com/v1/payment_intents/obj_123/amount_details_line_items \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
--data-urlencode limit=3const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const response = await stripe.rawRequest('GET', '/v1/payment_intents/obj_123/amount_details_line_items', {
limit: 3,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
response = client.raw_request("get", "/v1/payment_intents/obj_123/amount_details_line_items", limit=3)require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
response = Stripe.raw_request(:get, '/v1/payment_intents/obj_123/amount_details_line_items', {
limit: 3,
}){
"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
amountintegerAmount 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.
currencystringThree-letter ISO currency code, in lowercase. Must be a supported currency.
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The payment_intent object.
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/apply_customer_balance \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.applyCustomerBalance('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.apply_customer_balance("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.apply_customer_balance('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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_reasonstringReason for canceling this PaymentIntent. Possible values are:
duplicate,fraudulent,requested_by_customer, orabandonedPossible valuesabandonedduplicatefraudulentrequested_by_customer
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The payment_intent object.
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/cancel \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.cancel('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.cancel("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.cancel('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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_detailsobjectProvides industry-specific information about the amount.
Show 5 child parameters
discount_amountintegerenforce_arithmetic_validationbooleanline_itemsarray of objectsShow 8 child parameters
product_namestringRequiredquantityintegerRequiredunit_costintegerRequireddiscount_amountintegerpayment_method_optionsobjectChild parameters are listed in the OpenAPI document.
product_codestringtaxobjectChild parameters are listed in the OpenAPI document.
unit_of_measurestring
shippingobjectShow 3 child parameters
amountintegerfrom_postal_codestringto_postal_codestring
taxobjectShow 1 child parameter
total_tax_amountintegerRequired
amount_to_captureintegerThe amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full
amount_capturableif it's not provided.application_fee_amountintegerThe 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 stringsSpecifies which fields in the response should be expanded.
final_capturebooleanDefaults to
true. When capturing a PaymentIntent, settingfinal_capturetofalsenotifies 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.hooksobjectAutomations to be run during the PaymentIntent lifecycle
Show 1 child parameter
inputsobjectShow 1 child parameter
taxobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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_detailsobjectProvides industry-specific information about the charge.
Show 2 child parameters
customer_referencestringorder_referencestring
statement_descriptorstringText 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_suffixstringProvides 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_dataobjectThe 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.
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/capture \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.capture('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.capture("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.capture('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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 stringsThe list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the
payment_method_typesfield of the response, based on the other PaymentIntent parameters, such ascurrency,amount, andcustomer.amount_detailsobjectProvides industry-specific information about the amount.
Show 5 child parameters
discount_amountintegerenforce_arithmetic_validationbooleanline_itemsarray of objectsShow 8 child parameters
product_namestringRequiredquantityintegerRequiredunit_costintegerRequireddiscount_amountintegerpayment_method_optionsobjectChild parameters are listed in the OpenAPI document.
product_codestringtaxobjectChild parameters are listed in the OpenAPI document.
unit_of_measurestring
shippingobjectShow 3 child parameters
amountintegerfrom_postal_codestringto_postal_codestring
taxobjectShow 1 child parameter
total_tax_amountintegerRequired
amount_to_confirmintegerAmount to confirm on the PaymentIntent. Defaults to
amountif not provided.capture_methodstringControls when the funds will be captured from the customer's account.
Possible valuesautomaticautomatic_asyncmanual
client_secretstringThe client secret of the PaymentIntent.
confirmation_tokenstringID 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_actionbooleanSet to
trueto fail the payment attempt if the PaymentIntent transitions intorequires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.excluded_payment_method_typesarray of stringsThe list of payment method types to exclude from use with this payment.
expandarray of stringsSpecifies which fields in the response should be expanded.
hooksobjectAutomations to be run during the PaymentIntent lifecycle
Show 1 child parameter
inputsobjectShow 1 child parameter
taxobjectChild parameters are listed in the OpenAPI document.
mandatestringID of the mandate that's used for this payment.
mandate_dataobjectShow 1 child parameter
customer_acceptanceobjectRequiredShow 4 child parameters
typestringRequiredPossible valuesofflineonline
accepted_atintegerofflineobjectonlineobjectChild parameters are listed in the OpenAPI document.
off_sessionboolean | stringSet to
trueto 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 valuesone_offrecurring
payment_detailsobjectProvides industry-specific information about the charge.
Show 2 child parameters
customer_referencestringorder_referencestring
payment_methodstringID 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_dataobjectIf 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
typestringRequiredPossible valuesacss_debitaffirmafterpay_clearpayalipayalmaamazon_payau_becs_debitbacs_debitbancontactbilliebizumblikboletocashappcryptocustomer_balance- and 37 more
acss_debitobjectShow 3 child parameters
account_numberstringRequiredinstitution_numberstringRequiredtransit_numberstringRequired
affirmobjectafterpay_clearpayobjectalipayobjectallow_redisplaystringPossible valuesalwayslimitedunspecified
almaobjectamazon_payobjectau_becs_debitobjectShow 2 child parameters
account_numberstringRequiredbsb_numberstringRequired
bacs_debitobjectShow 2 child parameters
account_numberstringsort_codestring
bancontactobjectbillieobjectbilling_detailsobjectShow 5 child parameters
addressobjectChild parameters are listed in the OpenAPI document.
emailstringnamestringphonestringtax_idstring
bizumobjectblikobjectboletoobjectShow 1 child parameter
tax_idstringRequired
cashappobjectcryptoobjectcustomer_balanceobjectepsobjectShow 1 child parameter
bankstringPossible valuesarzte_und_apotheker_bankaustrian_anadi_bank_agbank_austriabankhaus_carl_spanglerbankhaus_schelhammer_und_schattera_agbawag_psk_agbks_bank_agbrull_kallmus_bank_agbtv_vier_lander_bankcapital_bank_grawe_gruppe_agdeutsche_bank_agdolomitenbankeasybank_agerste_bank_und_sparkassenhypo_alpeadriabank_international_aghypo_bank_burgenland_aktiengesellschaft- and 12 more
fpxobjectShow 1 child parameter
bankstringRequiredPossible valuesaffin_bankagrobankalliance_bankambankbank_islambank_muamalatbank_of_chinabank_rakyatbnp_paribasbsncimbcitibankdeutsche_bankhong_leong_bankhsbckfh- and 9 more
giropayobjectgrabpayobjectidealobjectShow 1 child parameter
bankstringPossible valuesabn_amroadyenasn_bankbunqbuutfinomhandelsbankeningknabmolliemoneyoun26nnrabobankregiobankrevolut- and 4 more
interac_presentobjectkakao_payobjectklarnaobjectShow 1 child parameter
dobobjectChild parameters are listed in the OpenAPI document.
konbiniobjectkr_cardobjectlinkobjectmb_wayobjectmetadataobjectmobilepayobjectmultibancoobjectnaver_payobjectShow 1 child parameter
fundingstringPossible valuescardpoints
nz_bank_accountobjectShow 6 child parameters
account_numberstringRequiredbank_codestringRequiredbranch_codestringRequiredsuffixstringRequiredaccount_holder_namestringreferencestring
oxxoobjectp24objectShow 1 child parameter
bankstringPossible valuesalior_bankbank_millenniumbank_nowy_bfg_sabank_pekao_sabanki_spbdzielczeblikbnp_paribasbozciti_handlowycredit_agricoleenvelobanketransfer_pocztowy24getin_bankideabankinginteligo- and 10 more
pay_by_bankobjectpaycoobjectpaynowobjectpaypalobjectpaytoobjectShow 3 child parameters
account_numberstringbsb_numberstringpay_idstring
pixobjectpromptpayobjectradar_optionsobjectShow 1 child parameter
sessionstring
revolut_payobjectsamsung_payobjectsatispayobjectscalapayobjectsepa_debitobjectShow 1 child parameter
ibanstringRequired
sofortobjectShow 1 child parameter
countrystringRequiredPossible valuesATBEDEESITNL
sunbitobjectswishobjecttwintobjectupiobjectShow 1 child parameter
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
us_bank_accountobjectShow 5 child parameters
account_holder_typestringPossible valuescompanyindividual
account_numberstringaccount_typestringPossible valuescheckingsavings
financial_connections_accountstringrouting_numberstring
wechat_payobjectzipobject
payment_method_optionsobjectPayment method-specific configuration for this PaymentIntent.
Show 56 child parameters
acss_debitobjectShow 4 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringverification_methodstringPossible valuesautomaticinstantmicrodeposits
affirmobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringsetup_future_usagestringPossible valuesnone
afterpay_clearpayobjectShow 3 child parameters
capture_methodstringPossible valuesmanual
referencestringsetup_future_usagestringPossible valuesnone
alipayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
almaobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
amazon_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
au_becs_debitobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bacs_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
bancontactobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenfrnl
setup_future_usagestringPossible valuesnoneoff_session
billieobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
bizumobjectblikobjectShow 2 child parameters
codestringsetup_future_usagestringPossible valuesnone
boletoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnoneoff_sessionon_session
cardobjectShow 15 child parameters
capture_methodstringPossible valuesmanual
cvc_tokenstringinstallmentsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networkstringPossible valuesamexcartes_bancairesdinersdiscovereftpos_augirocardinteracjcblinkmastercardunionpayunknownvisa
request_extended_authorizationstringPossible valuesif_availablenever
request_incremental_authorizationstringPossible valuesif_availablenever
request_multicapturestringPossible valuesif_availablenever
request_overcapturestringPossible valuesif_availablenever
request_three_d_securestringPossible valuesanyautomaticchallenge
require_cvc_recollectionbooleansetup_future_usagestringPossible valuesnoneoff_sessionon_session
statement_descriptor_suffix_kanastringstatement_descriptor_suffix_kanjistringthree_d_secureobjectChild parameters are listed in the OpenAPI document.
card_presentobjectShow 4 child parameters
capture_methodstringPossible valuesmanualmanual_preferred
request_extended_authorizationbooleanrequest_incremental_authorization_supportbooleanroutingobjectChild parameters are listed in the OpenAPI document.
cashappobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
cryptoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
customer_balanceobjectShow 3 child parameters
bank_transferobjectChild parameters are listed in the OpenAPI document.
funding_typestringPossible valuesbank_transfer
setup_future_usagestringPossible valuesnone
epsobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
fpxobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
giropayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
grabpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
idealobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
interac_presentobjectkakao_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
klarnaobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
on_demandobjectChild parameters are listed in the OpenAPI document.
preferred_localestringPossible valuescs-CZda-DKde-ATde-CHde-DEel-GRen-ATen-AUen-BEen-CAen-CHen-CZen-DEen-DKen-ESen-FI- and 30 more
setup_future_usagestringPossible valuesnoneoff_sessionon_session
subscriptionsarray of objectsChild parameters are listed in the OpenAPI document.
konbiniobjectShow 5 child parameters
confirmation_numberstringexpires_after_daysintegerexpires_atintegerproduct_descriptionstringsetup_future_usagestringPossible valuesnone
kr_cardobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
linkobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
mb_wayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
mobilepayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
multibancoobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
naver_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
nz_bank_accountobjectShow 2 child parameters
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
oxxoobjectShow 2 child parameters
expires_after_daysintegersetup_future_usagestringPossible valuesnone
p24objectShow 2 child parameters
setup_future_usagestringPossible valuesnone
tos_shown_and_acceptedboolean
pay_by_bankobjectpaycoobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
paynowobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
paypalobjectShow 5 child parameters
capture_methodstringPossible valuesmanual
preferred_localestringPossible valuescs-CZda-DKde-ATde-DEde-LUel-GRen-GBen-USes-ESfi-FIfr-BEfr-FRfr-LUhu-HUit-ITnl-BE- and 5 more
referencestringrisk_correlation_idstringsetup_future_usagestringPossible valuesnoneoff_session
paytoobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
pixobjectShow 5 child parameters
amount_includes_iofstringPossible valuesalwaysnever
expires_after_secondsintegerexpires_atintegermandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_session
promptpayobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
revolut_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_session
samsung_payobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
satispayobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnoneoff_sessionon_session
scalapayobjectShow 1 child parameter
capture_methodstringPossible valuesmanual
sepa_debitobjectShow 3 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestring
sofortobjectShow 2 child parameters
preferred_languagestringPossible valuesdeenesfritnlpl
setup_future_usagestringPossible valuesnoneoff_session
sunbitobjectShow 2 child parameters
capture_methodstringPossible valuesmanual
setup_future_usagestringPossible valuesnone
swishobjectShow 2 child parameters
referencestringsetup_future_usagestringPossible valuesnone
twintobjectShow 1 child parameter
setup_future_usagestringPossible valuesnoneoff_session
upiobjectShow 2 child parameters
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
us_bank_accountobjectShow 7 child parameters
financial_connectionsobjectChild parameters are listed in the OpenAPI document.
mandate_optionsobjectChild parameters are listed in the OpenAPI document.
networksobjectChild parameters are listed in the OpenAPI document.
setup_future_usagestringPossible valuesnoneoff_sessionon_session
target_datestringtransaction_purposestringPossible valuesgoodsotherservicesunspecified
verification_methodstringPossible valuesautomaticinstantmicrodeposits
wechat_payobjectShow 3 child parameters
app_idstringclientstringPossible valuesandroidiosweb
setup_future_usagestringPossible valuesnone
zipobjectShow 1 child parameter
setup_future_usagestringPossible valuesnone
payment_method_typesarray of stringsThe 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_optionsobjectOptions to configure Radar. Learn more about Radar Sessions.
Show 2 child parameters
referrerstringsessionstring
receipt_emailstringEmail address that the receipt for the resulting payment will be sent to. If
receipt_emailis specified for a payment in live mode, a receipt will be sent regardless of your email settings.return_urlstringThe 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_usagestringIndicates 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_presentand 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 usessetup_future_usageto help you comply with regional legislation and network rules, such as SCA. If you've already setsetup_future_usageand you're performing a request using a publishable key, you can only update the value fromon_sessiontooff_session.Possible valuesoff_sessionon_session
shippingobjectShipping information for this PaymentIntent.
Show 5 child parameters
addressobjectRequiredShow 6 child parameters
citystringcountrystringline1stringline2stringpostal_codestringstatestring
namestringRequiredcarrierstringphonestringtracking_numberstring
use_stripe_sdkbooleanSet to
truewhen confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
Returns
The payment_intent object.
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/confirm \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.confirm('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.confirm("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.confirm('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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
amountintegerRequiredThe updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
amount_detailsobjectProvides industry-specific information about the amount.
Show 5 child parameters
discount_amountintegerenforce_arithmetic_validationbooleanline_itemsarray of objectsShow 8 child parameters
product_namestringRequiredquantityintegerRequiredunit_costintegerRequireddiscount_amountintegerpayment_method_optionsobjectChild parameters are listed in the OpenAPI document.
product_codestringtaxobjectChild parameters are listed in the OpenAPI document.
unit_of_measurestring
shippingobjectShow 3 child parameters
amountintegerfrom_postal_codestringto_postal_codestring
taxobjectShow 1 child parameter
total_tax_amountintegerRequired
application_fee_amountintegerThe 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.
descriptionstringAn arbitrary string attached to the object. Often useful for displaying to users.
expandarray of stringsSpecifies which fields in the response should be expanded.
hooksobjectAutomations to be run during the PaymentIntent lifecycle
Show 1 child parameter
inputsobjectShow 1 child parameter
taxobjectChild parameters are listed in the OpenAPI document.
metadataobjectSet 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_detailsobjectProvides industry-specific information about the charge.
Show 2 child parameters
customer_referencestringorder_referencestring
statement_descriptorstringText 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_dataobjectThe 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.
curl https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/increment_authorization \
-H "Authorization: Bearer $KNOX_SECRET_KEY" \
-d amount=1099const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.incrementAuthorization('pi_1PgafyB7WZ01zgkWSjxsAJo3', {
amount: 1099,
});import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.increment_authorization("pi_1PgafyB7WZ01zgkWSjxsAJo3", params={
"amount": 1099,
})require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.increment_authorization('pi_1PgafyB7WZ01zgkWSjxsAJo3', {
amount: 1099,
}){
"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 integersTwo positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
client_secretstringThe client secret of the PaymentIntent.
descriptor_codestringA six-character code starting with SM present in the microdeposit sent to the bank account.
expandarray of stringsSpecifies which fields in the response should be expanded.
Returns
The payment_intent object.
curl -X POST https://api.knoxapi.com/v1/payment_intents/pi_1PgafyB7WZ01zgkWSjxsAJo3/verify_microdeposits \
-H "Authorization: Bearer $KNOX_SECRET_KEY"const Stripe = require('stripe');
const stripe = new Stripe(process.env.KNOX_SECRET_KEY, {host: 'api.knoxapi.com'});
const paymentIntent = await stripe.paymentIntents.verifyMicrodeposits('pi_1PgafyB7WZ01zgkWSjxsAJo3');import os
import stripe
client = stripe.StripeClient(
os.environ["KNOX_SECRET_KEY"],
base_addresses={"api": "https://api.knoxapi.com"},
)
payment_intent = client.v1.payment_intents.verify_microdeposits("pi_1PgafyB7WZ01zgkWSjxsAJo3")require 'stripe'
Stripe.api_key = ENV['KNOX_SECRET_KEY']
Stripe.api_base = 'https://api.knoxapi.com'
payment_intent = Stripe::PaymentIntent.verify_microdeposits('pi_1PgafyB7WZ01zgkWSjxsAJo3'){
"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.