Stripe: Payment intents schemas (part 1)
31 Stripe schemas with complete fields and constraints.
← Payment intents operations · All schemas
Cancel a Payment Intent — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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](/payments/paymentintents/lifecycle) 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://docs.stripe.com/payments/payment-intents) |
allowed_payment_method_types | JSON | Optional | |
allowed_payment_method_types (anyOf 1) | array | Alternative | The list of payment method types allowed for use with this payment. Stripe automatically returns compatible payment methods from this list in the `payment_method_types` field of the response, based on the other PaymentIntent parameters, such as `currency`, `amount`, and `customer`. |
allowed_payment_method_types (anyOf 1)[] | string | Each item | Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boku_promptpay, boleto, capchase_pay, card, card_present, cashapp, check_scan, click_to_pay, crypto, customer_balance, demo_pay, duitnow, dummy_auth_push, dummy_passthrough_card, edenred, eps, fpx, gcash, getbalance, gift_card, giropay, gopay, grabpay, id_bank_transfer, ideal, interac_present, kakao_pay, klarna, knet, konbini, kr_card, kr_market, kriya, link, mb_way, mobilepay, momo, mondu, multibanco, naver_pay, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nz_bank_account, octopus, oxxo, p24, paper_check, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, shop_pay, shopeepay, sofort, south_korea_market, stripe_balance, sunbit, swish, tamara, test_pay, touch_n_go, truemoney, twint, upi, us_bank_account, us_cash_voucher, vipps, wechat_pay, wero, zip |
allowed_payment_method_types (anyOf 2) | null | Alternative | |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (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](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_capturable | JSON | Optional | |
amount_capturable (anyOf 1) | integer | Alternative | Amount that can be captured from this PaymentIntent. |
amount_capturable (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_details | JSON | Optional | |
amount_details (anyOf 1) | Model | Alternative | Expand Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip |
amount_details (anyOf 2) | Model | Alternative | Expand Cancel a Payment Intent — response body — amount details tip |
amount_received | JSON | Optional | |
amount_received (anyOf 1) | integer | Alternative | Amount that this PaymentIntent collects. |
amount_received (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application | JSON | Optional | |
application (anyOf 1) | JSON | Alternative | ID of the Connect application that created the PaymentIntent. |
application (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
application (anyOf 1) (anyOf 2) | Model | Alternative | Expand PostApplicationFeesIdRefund — response body — application / object: application |
application (anyOf 2) | null | Alternative | |
application_fee_amount | JSON | Optional | |
application_fee_amount (anyOf 1) | JSON | Alternative | |
application_fee_amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). |
application_fee_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application_fee_amount (anyOf 2) | null | Alternative | |
automatic_payment_methods | JSON | Optional | |
automatic_payment_methods (anyOf 1) | JSON | Alternative | Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) |
automatic_payment_methods (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a PaymentIntent — response body — automatic_payment_methods / value / allow_redirects: always, never |
automatic_payment_methods (anyOf 2) | null | Alternative | |
canceled_at | JSON | Optional | |
canceled_at (anyOf 1) | JSON | Alternative | |
canceled_at (anyOf 1) (anyOf 1) | integer | Alternative | Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. Format: unix-time |
canceled_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
canceled_at (anyOf 2) | null | Alternative | |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | string | Alternative | Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`). Known values: abandoned, automatic, duplicate, expired, failed_invoice, fraudulent, requested_by_customer, void_invoice |
cancellation_reason (anyOf 2) | null | Alternative | |
capture_method | string | Optional | Controls when the funds will be captured from the customer's account. Known values: automatic, automatic_async, manual |
client_secret | JSON | Optional | |
client_secret (anyOf 1) | string | Alternative | The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. Maximum length: 5000 |
client_secret (anyOf 2) | null | Alternative | |
confirmation_method | string | Optional | Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. Known values: automatic, manual |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Optional | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. |
customer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a customer — response body |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. Payment methods attached to other Accounts cannot be used with this PaymentIntent. If [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. Maximum length: 5000 |
customer_account (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
excluded_payment_method_types | JSON | Optional | |
excluded_payment_method_types (anyOf 1) | array | Alternative | The list of payment method types to exclude from use with this payment. |
excluded_payment_method_types (anyOf 1)[] | string | Each item | Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip |
excluded_payment_method_types (anyOf 2) | null | Alternative | |
hooks | Model | Optional | Expand Cancel a Payment Intent — response body — hooks |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
last_payment_error | JSON | Optional | |
last_payment_error (anyOf 1) | JSON | Alternative | The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. |
last_payment_error (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error |
last_payment_error (anyOf 2) | null | Alternative | |
latest_charge | JSON | Optional | |
latest_charge (anyOf 1) | JSON | Alternative | ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. |
latest_charge (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
latest_charge (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a charge — response body |
latest_charge (anyOf 2) | null | Alternative | |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
managed_payments | JSON | Optional | |
managed_payments (anyOf 1) | JSON | Alternative | Settings for Managed Payments. |
managed_payments (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — managed payments value enabled |
managed_payments (anyOf 2) | null | Alternative | |
metadata | object | Optional | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
next_action | JSON | Optional | |
next_action (anyOf 1) | JSON | Alternative | If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. |
next_action (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app |
next_action (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: payment_intent |
on_behalf_of | JSON | Optional | |
on_behalf_of (anyOf 1) | JSON | Alternative | You can specify the settlement merchant as the connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details. |
on_behalf_of (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
on_behalf_of (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create an account — response body |
on_behalf_of (anyOf 2) | null | Alternative | |
payment_details | Model | Optional | Expand Cancel a Payment Intent — response body — payment details |
payment_method | JSON | Optional | |
payment_method (anyOf 1) | JSON | Alternative | ID of the payment method used in this PaymentIntent. |
payment_method (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_method (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
payment_method (anyOf 2) | null | Alternative | |
payment_method_configuration_details | JSON | Optional | |
payment_method_configuration_details (anyOf 1) | JSON | Alternative | Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent. |
payment_method_configuration_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — payment method configuration details value id, parent |
payment_method_configuration_details (anyOf 2) | null | Alternative | |
payment_method_options | JSON | Optional | |
payment_method_options (anyOf 1) | JSON | Alternative | Payment-method-specific configuration for this PaymentIntent. |
payment_method_options (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Payment Intent — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay, zip |
payment_method_options (anyOf 2) | null | Alternative | |
payment_method_types | array | Optional | The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). |
payment_method_types[] | string | Each item | Maximum length: 5000 |
payment_record | JSON | Optional | |
payment_record (anyOf 1) | JSON | Alternative | ID of the [Payment Record object](https://docs.stripe.com/api/payment-record) created by this PaymentIntent. |
payment_record (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_record (anyOf 1) (anyOf 2) | Model | Alternative | Expand Report a refund — response body |
payment_record (anyOf 2) | null | Alternative | |
presentment_details | Model | Optional | Expand Cancel a refund — response body — presentment details |
processing | JSON | Optional | |
processing (anyOf 1) | JSON | Alternative | If present, this property tells you about the processing state of the payment. |
processing (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a PaymentIntent — response body — processing / value / type: card |
processing (anyOf 2) | null | Alternative | |
receipt_email | JSON | Optional | |
receipt_email (anyOf 1) | string | Alternative | Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). Maximum length: 5000 |
receipt_email (anyOf 2) | null | Alternative | |
review | JSON | Optional | |
review (anyOf 1) | JSON | Alternative | ID of the review associated with this PaymentIntent, if any. |
review (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
review (anyOf 1) (anyOf 2) | Model | Alternative | Expand Approve a review — response body |
review (anyOf 2) | null | Alternative | |
setup_future_usage | JSON | Optional | |
setup_future_usage (anyOf 1) | string | Alternative | Indicates that you intend to make future payments with this PaymentIntent's payment method. If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) 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](/api/payment_methods/attach) the payment method to a Customer after the transaction completes. If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: off_session, on_session |
setup_future_usage (anyOf 2) | null | Alternative | |
shipping | JSON | Optional | |
shipping (anyOf 1) | JSON | Alternative | Shipping information for this PaymentIntent. |
shipping (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a source — response body — source order shipping |
shipping (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead. Maximum length: 5000 |
statement_descriptor (anyOf 2) | null | Alternative | |
statement_descriptor_suffix | JSON | Optional | |
statement_descriptor_suffix (anyOf 1) | string | Alternative | Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. Maximum length: 5000 |
statement_descriptor_suffix (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses). Known values: canceled, processing, requires_action, requires_capture, requires_confirmation, requires_payment_method, succeeded |
transfer_data | JSON | Optional | |
transfer_data (anyOf 1) | JSON | Alternative | The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). |
transfer_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Payment Intent — response body — transfer data value amount, description, destination, metadata, payment data |
transfer_data (anyOf 2) | null | Alternative | |
transfer_group | JSON | Optional | |
transfer_group (anyOf 1) | string | Alternative | A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). Maximum length: 5000 |
transfer_group (anyOf 2) | null | Alternative |
Referenced models: Create an account — response body, Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error, PostApplicationFeesIdRefund — response body — application / object: application, Create a charge — response body, Create a customer — response body, Delete a customer — response body, Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip, Cancel a Payment Intent — response body — amount details tip, Cancel a PaymentIntent — response body — automatic_payment_methods / value / allow_redirects: always, never, Cancel a Payment Intent — response body — payment details, Cancel a Payment Intent — response body — hooks, Cancel a refund — response body — presentment details, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app, Cancel a Payment Intent — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay, zip, Cancel a PaymentIntent — response body — processing / value / type: card, Create a Payment Method — response body, Cancel a Setup Intent — response body — payment method configuration details value id, parent, Cancel a Setup Intent — response body — managed payments value enabled, Report a refund — response body, Approve a review — response body, Create a source — response body — source order shipping, Cancel a Payment Intent — response body — transfer data value amount, description, destination, metadata, payment data
Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discount_amount | JSON | Optional | |
discount_amount (anyOf 1) | integer | Alternative | The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. |
discount_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
error | Model | Optional | Expand Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip error |
line_items | object | Optional | A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. |
line_items.data | array | Required within parent | Details about each object. |
line_items.data[] | Model | Each item | Expand List all Payment Intent Line Items — response body — data item |
line_items.has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
line_items.object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
line_items.url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
shipping | Model | Optional | Expand Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip shipping |
tax | Model | Optional | Expand Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip tax |
tip | Model | Optional | Expand Cancel a Payment Intent — response body — amount details tip tip |
Referenced models: Cancel a Payment Intent — response body — amount details tip tip, Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip error, Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip shipping, Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip tax, List all Payment Intent Line Items — response body — data item
Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | The code of the error that occurred when validating the current amount details. Known values: amount_details_amount_mismatch, amount_details_tax_shipping_discount_greater_than_amount |
code (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | A message providing more details about the error. Maximum length: 5000 |
message (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip shipping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
from_postal_code | JSON | Optional | |
from_postal_code (anyOf 1) | string | Alternative | If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens and spaces are allowed. Maximum length: 5000 |
from_postal_code (anyOf 2) | null | Alternative | |
to_postal_code | JSON | Optional | |
to_postal_code (anyOf 1) | string | Alternative | If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens and spaces are allowed. Maximum length: 5000 |
to_postal_code (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — amount details discount amount, error, line items, shipping, tax, tip tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
total_tax_amount | JSON | Optional | |
total_tax_amount (anyOf 1) | JSON | Alternative | |
total_tax_amount (anyOf 1) (anyOf 1) | integer | Alternative | The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. |
total_tax_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_tax_amount (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — amount details tip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tip | Model | Optional | Expand Cancel a Payment Intent — response body — amount details tip tip |
Referenced models: Cancel a Payment Intent — response body — amount details tip tip
Cancel a Payment Intent — response body — amount details tip tip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | Portion of the amount that corresponds to a tip. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Cancel a Payment Intent — response body — hooks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | Model | Optional | Expand Cancel a Payment Intent — response body — hooks inputs |
Referenced models: Cancel a Payment Intent — response body — hooks inputs
Cancel a Payment Intent — response body — hooks inputs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tax | Model | Optional | Expand Cancel a Payment Intent — response body — hooks inputs tax |
Referenced models: Cancel a Payment Intent — response body — hooks inputs tax
Cancel a Payment Intent — response body — hooks inputs tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
calculation | string | Required within parent | The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app
Referenced models: Create a Payment Method — response body — zip, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app alipay handle redirect, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app boleto display details, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app card await notification, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits cashapp handle redirect or display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app display bank transfer instructions, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app multibanco display details, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app oxxo display details, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app klarna display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app konbini display details, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app paynow display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app pix display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app promptpay display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app redirect to url, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app swish handle redirect or display qr code, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits verify with microdeposits, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay display qr code, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay redirect to android app, Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay redirect to ios app
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app alipay handle redirect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
native_data | JSON | Optional | |
native_data (anyOf 1) | string | Alternative | The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. Maximum length: 5000 |
native_data (anyOf 2) | null | Alternative | |
native_url | JSON | Optional | |
native_url (anyOf 1) | string | Alternative | The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. Maximum length: 5000 |
native_url (anyOf 2) | null | Alternative | |
return_url | JSON | Optional | |
return_url (anyOf 1) | string | Alternative | If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. Maximum length: 5000 |
return_url (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL you must redirect your customer to in order to authenticate the payment. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app boleto display details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp after which the boleto expires. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
hosted_voucher_url | JSON | Optional | |
hosted_voucher_url (anyOf 1) | string | Alternative | The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. Maximum length: 5000 |
hosted_voucher_url (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | The boleto number. Maximum length: 5000 |
number (anyOf 2) | null | Alternative | |
pdf | JSON | Optional | |
pdf (anyOf 1) | string | Alternative | The URL to the downloadable boleto voucher PDF. Maximum length: 5000 |
pdf (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app card await notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charge_attempt_at | JSON | Optional | |
charge_attempt_at (anyOf 1) | JSON | Alternative | |
charge_attempt_at (anyOf 1) (anyOf 1) | integer | Alternative | The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. Format: unix-time |
charge_attempt_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
charge_attempt_at (anyOf 2) | null | Alternative | |
customer_approval_required | JSON | Optional | |
customer_approval_required (anyOf 1) | boolean | Alternative | For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. |
customer_approval_required (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app display bank transfer instructions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_remaining | JSON | Optional | |
amount_remaining (anyOf 1) | JSON | Alternative | |
amount_remaining (anyOf 1) (anyOf 1) | integer | Alternative | The remaining amount that needs to be transferred to complete the payment. |
amount_remaining (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_remaining (anyOf 2) | null | Alternative | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
currency (anyOf 2) | null | Alternative | |
financial_addresses | array | Optional | A list of financial addresses that can be used to fund the customer balance |
financial_addresses[] | Model | Each item | Expand Create or retrieve funding instructions for a customer cash balance — response body — bank transfer financial addresses item |
hosted_instructions_url | JSON | Optional | |
hosted_instructions_url (anyOf 1) | string | Alternative | A link to a hosted page that guides your customer through completing the transfer. Maximum length: 5000 |
hosted_instructions_url (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative | |
type | string | Required within parent | Type of bank transfer Known values: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, us_bank_transfer |
Referenced models: Create or retrieve funding instructions for a customer cash balance — response body — bank transfer financial addresses item
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app klarna display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The data being used to generate QR code Maximum length: 5000 |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp at which the QR code expires. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
image_url_png | string | Required within parent | The image_url_png string used to render QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render QR code Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app konbini display details
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app konbini display details stores
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app konbini display details stores lawson Lawson instruction details confirmation number, payment code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
confirmation_number | string | Optional | The confirmation number. Maximum length: 5000 |
payment_code | string | Required within parent | The payment code. Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app multibanco display details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
entity | JSON | Optional | |
entity (anyOf 1) | string | Alternative | Entity number associated with this Multibanco payment. Maximum length: 5000 |
entity (anyOf 2) | null | Alternative | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp at which the Multibanco voucher expires. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
hosted_voucher_url | JSON | Optional | |
hosted_voucher_url (anyOf 1) | string | Alternative | The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. Maximum length: 5000 |
hosted_voucher_url (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Reference number associated with this Multibanco payment. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app oxxo display details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_after | JSON | Optional | |
expires_after (anyOf 1) | JSON | Alternative | |
expires_after (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp after which the OXXO voucher expires. Format: unix-time |
expires_after (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_after (anyOf 2) | null | Alternative | |
hosted_voucher_url | JSON | Optional | |
hosted_voucher_url (anyOf 1) | string | Alternative | The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. Maximum length: 5000 |
hosted_voucher_url (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | OXXO reference number. Maximum length: 5000 |
number (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app paynow display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The raw data string used to generate QR code, it should be used together with QR code library. Maximum length: 5000 |
hosted_instructions_url | JSON | Optional | |
hosted_instructions_url (anyOf 1) | string | Alternative | The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. Maximum length: 5000 |
hosted_instructions_url (anyOf 2) | null | Alternative | |
image_url_png | string | Required within parent | The image_url_png string used to render QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render QR code Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app pix display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Optional | The raw data string used to generate QR code, it should be used together with QR code library. Maximum length: 5000 |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | integer | Alternative | The date (unix timestamp) when the PIX expires. |
expires_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hosted_instructions_url | string | Optional | The URL to the hosted pix instructions page, which allows customers to view the pix QR code. Maximum length: 5000 |
image_url_png | string | Optional | The image_url_png string used to render png QR code Maximum length: 5000 |
image_url_svg | string | Optional | The image_url_svg string used to render svg QR code Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app promptpay display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The raw data string used to generate QR code, it should be used together with QR code library. Maximum length: 5000 |
hosted_instructions_url | string | Required within parent | The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code. Maximum length: 5000 |
image_url_png | string | Required within parent | The PNG path used to render the QR code, can be used as the source in an HTML img tag Maximum length: 5000 |
image_url_svg | string | Required within parent | The SVG path used to render the QR code, can be used as the source in an HTML img tag Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app redirect to url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
return_url | JSON | Optional | |
return_url (anyOf 1) | string | Alternative | If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. Maximum length: 5000 |
return_url (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL you must redirect your customer to in order to authenticate the payment. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app swish handle redirect or display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hosted_instructions_url | string | Required within parent | The URL to the hosted Swish instructions page, which allows customers to view the QR code. Maximum length: 5000 |
qr_code | Model | Required within parent | Expand Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app swish handle redirect or display qr code qr code |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app swish handle redirect or display qr code qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The raw data string used to generate QR code, it should be used together with QR code library. Maximum length: 5000 |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | integer | Alternative | The timestamp at which the QR code expires. Format: unix-time |
expires_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
image_url_png | string | Required within parent | The image_url_png string used to render QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render QR code Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The data being used to generate QR code Maximum length: 5000 |
hosted_instructions_url | string | Required within parent | The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code. Maximum length: 5000 |
image_data_url | string | Required within parent | The base64 image data for a pre-generated QR code Maximum length: 5000 |
image_url_png | string | Required within parent | The image_url_png string used to render QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render QR code Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay redirect to android app
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_id | string | Required within parent | app_id is the APP ID registered on WeChat open platform Maximum length: 5000 |
nonce_str | string | Required within parent | nonce_str is a random string Maximum length: 5000 |
package | string | Required within parent | package is static value Maximum length: 5000 |
partner_id | string | Required within parent | an unique merchant ID assigned by WeChat Pay Maximum length: 5000 |
prepay_id | string | Required within parent | an unique trading ID assigned by WeChat Pay Maximum length: 5000 |
sign | string | Required within parent | A signature Maximum length: 5000 |
timestamp | string | Required within parent | Specifies the current time in epoch format Maximum length: 5000 |
Cancel a Payment Intent — response body — next action value alipay handle redirect, blik authorize, boleto display details, card await notification, cashapp handle redirect or display qr code, display bank transfer instructions, klarna display qr code, konbini display details, multibanco display details, oxxo display details, paynow display qr code, pix display qr code, promptpay display qr code, redirect to url, swish handle redirect or display qr code, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, wechat pay display qr code, wechat pay redirect to android app, wechat pay redirect to ios app wechat pay redirect to ios app
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
native_url | string | Required within parent | An universal link that redirect to WeChat Pay app Maximum length: 5000 |
Cancel a Payment Intent — response body — payment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customer_reference | JSON | Optional | |
customer_reference (anyOf 1) | string | Alternative | A unique value to identify the customer. This field is available only for card payments. This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. Maximum length: 5000 |
customer_reference (anyOf 2) | null | Alternative | |
order_reference | JSON | Optional | |
order_reference (anyOf 1) | string | Alternative | A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. Maximum length: 5000 |
order_reference (anyOf 2) | null | Alternative |