diff --git a/openapi/fixtures3.json b/openapi/fixtures3.json
index 985f6ca2..b775b5eb 100644
--- a/openapi/fixtures3.json
+++ b/openapi/fixtures3.json
@@ -147,12 +147,12 @@
"created": 1234567890,
"expires_at": 1234567890,
"object": "account_link",
- "url": "https://coker-manage-mydev.dev.stripe.me/setup/s/acct_1M1fC5CWU96GXUyb/7ddK7UJZmnzY"
+ "url": "https://coker-manage-mydev.dev.stripe.me/setup/s/acct_1M1fC5CWU96GXUyb/Jj9DPLXmTFZW"
},
"apple_pay_domain": {
"created": 1234567890,
"domain_name": "example.com",
- "id": "apwc_1M1fCcCWU96GXUyb8A2Sf6mm",
+ "id": "apwc_1M4EYACWU96GXUybw5yz2XQO",
"livemode": true,
"object": "apple_pay_domain"
},
@@ -160,12 +160,12 @@
"account": "acct_1M1fC5CWU96GXUyb",
"amount": 100,
"amount_refunded": 0,
- "application": "ca_MlBZYtVLbYzRhJeRJ0vIioNCPRmo9pKR",
- "balance_transaction": "txn_1M1fCUCWU96GXUybz4LTpeDL",
- "charge": "ch_1M1fCUCWU96GXUybuwQRv8nG",
+ "application": "ca_MnqEtZiLzYophddcPpJg0Kn8NqvBNHFD",
+ "balance_transaction": "txn_1M4EY3CWU96GXUyb7BkjEab9",
+ "charge": "ch_1M1fCUCWU96GXUyb2X2EDsPr",
"created": 1234567890,
"currency": "usd",
- "id": "fee_1M1fCgCWU96GXUyboRpEohSB",
+ "id": "fee_1M4EYMCWU96GXUybhRGkR2Kc",
"livemode": false,
"object": "application_fee",
"originating_transaction": null,
@@ -176,7 +176,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/application_fees/fee_1M1fCgCWU96GXUyboRpEohSB/refunds"
+ "url": "/v1/application_fees/fee_1M4EYMCWU96GXUybhRGkR2Kc/refunds"
}
},
"apps.secret": {
@@ -229,7 +229,7 @@
"fee_details": [
],
- "id": "txn_1M1fCUCWU96GXUybz4LTpeDL",
+ "id": "txn_1M4EY3CWU96GXUyb7BkjEab9",
"net": 100,
"object": "balance_transaction",
"reporting_category": "charge",
@@ -239,14 +239,14 @@
},
"bank_account": {
"account_holder_name": "Jane Austen",
- "account_holder_type": "individual",
+ "account_holder_type": "company",
"account_type": null,
"bank_name": "STRIPE TEST BANK",
"country": "US",
"currency": "usd",
"customer": null,
- "fingerprint": "1JWtPxqbdX5Gamtz",
- "id": "ba_1M1fCeCWU96GXUybDCwNBUBf",
+ "fingerprint": "vdxhi1lp41ge2nPn",
+ "id": "ba_1M1fClCWU96GXUybDTiyXDj9",
"last4": "6789",
"metadata": {
},
@@ -300,7 +300,7 @@
"proration_behavior": "none"
}
},
- "id": "bpc_1M1fCjCWU96GXUybBxBbeREq",
+ "id": "bpc_1M4EYSCWU96GXUybQSwRhJEK",
"is_default": true,
"livemode": true,
"login_page": {
@@ -312,10 +312,10 @@
"updated": 1234567890
},
"billing_portal.session": {
- "configuration": "bpc_1M1fCjCWU96GXUybuCxRrCUn",
+ "configuration": "bpc_1M4EYSCWU96GXUybDPScjRhf",
"created": 1234567890,
"customer": "cus_MlBZUAFdvQEcCp",
- "id": "bps_1M1fCjCWU96GXUyb6pkk6cY3",
+ "id": "bps_1M4EYSCWU96GXUybwElu7ien",
"livemode": true,
"locale": null,
"object": "billing_portal.session",
@@ -393,11 +393,11 @@
"exp_year": 2023,
"fingerprint": "8OIWN6dO1Fs3Mvk2",
"funding": "credit",
- "id": "card_1M1fCTCWU96GXUybtNHdtDAc",
+ "id": "card_1M1fCTCWU96GXUybAtjV5pTZ",
"last4": "4242",
"metadata": {
},
- "name": null,
+ "name": "Jenny Rosen",
"object": "card",
"tokenization_method": null
},
@@ -419,7 +419,7 @@
"application": null,
"application_fee": null,
"application_fee_amount": null,
- "balance_transaction": "txn_1M1fCUCWU96GXUybz4LTpeDL",
+ "balance_transaction": "txn_1M4EY3CWU96GXUyb7BkjEab9",
"billing_details": {
"address": {
"city": null,
@@ -430,7 +430,7 @@
"state": null
},
"email": null,
- "name": null,
+ "name": "Jenny Rosen",
"phone": null
},
"calculated_statement_descriptor": null,
@@ -445,7 +445,7 @@
"failure_message": null,
"fraud_details": {
},
- "id": "ch_1M1fCUCWU96GXUybuwQRv8nG",
+ "id": "ch_1M1fCUCWU96GXUyb2X2EDsPr",
"invoice": null,
"livemode": false,
"metadata": {
@@ -480,7 +480,7 @@
},
"receipt_email": null,
"receipt_number": null,
- "receipt_url": "https://coker-manage-mydev.dev.stripe.me/receipts/payment/CAcaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKIm3ppsGMgaSJBVbqgs6LCJRcC7ij3XeDu7mmjcGSawrb6AnSYNyhrYstOwO1rIuyMpWpP8jqXT2v4oc",
+ "receipt_url": "https://coker-manage-mydev.dev.stripe.me/receipts/payment/CAcaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKL3oy5sGMgZaxUNk5I46LCJfEZm5jmuBgsNkLrjPcrvJOjKeitun-hx8JIqCsXyahwzmIRWUAfRunO4S",
"refunded": false,
"refunds": {
"data": [
@@ -488,7 +488,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/charges/ch_1M1fCUCWU96GXUybuwQRv8nG/refunds"
+ "url": "/v1/charges/ch_1M1fCUCWU96GXUyb2X2EDsPr/refunds"
},
"review": null,
"shipping": null,
@@ -520,7 +520,7 @@
"customer_details": null,
"customer_email": null,
"expires_at": 1234567890,
- "id": "cs_test_a1BzxGBjlLZcRT9YREbHahq7hBdkUgfCygD6NLGUQl87pFDwc7wmx5ihJT",
+ "id": "cs_test_a1pZ1w93JpA23GFzQu60h9uFEDJL4PQ6iEZNfTRNzO36gFioeRqbkOZY6u",
"livemode": false,
"locale": null,
"metadata": {
@@ -792,8 +792,8 @@
"discount_amounts": [
],
- "id": "cn_1M1fCkCWU96GXUyb6EzNkF9S",
- "invoice": "in_1M1fCjCWU96GXUybwshPTGcB",
+ "id": "cn_1M4EYTCWU96GXUyba77W91bv",
+ "invoice": "in_1M4EYTCWU96GXUybWEq2aoQ1",
"lines": {
"data": [
{
@@ -804,8 +804,8 @@
"discount_amounts": [
],
- "id": "cnli_1M1fCkCWU96GXUybunRJoawi",
- "invoice_line_item": "il_1M1fCjCWU96GXUyb9XeDZnAm",
+ "id": "cnli_1M4EYTCWU96GXUybiFjophPa",
+ "invoice_line_item": "il_1M4EYTCWU96GXUybViihVqK7",
"livemode": false,
"object": "credit_note_line_item",
"quantity": 1,
@@ -813,17 +813,17 @@
{
"amount": 190,
"inclusive": false,
- "tax_rate": "txr_1M1fCjCWU96GXUybI14Yya3D"
+ "tax_rate": "txr_1M4EYTCWU96GXUybkYregZhX"
}
],
"tax_rates": [
{
"active": true,
"country": "DE",
- "created": 1667865493,
+ "created": 1668478037,
"description": "VAT Germany",
"display_name": "VAT",
- "id": "txr_1M1fCjCWU96GXUybI14Yya3D",
+ "id": "txr_1M4EYTCWU96GXUybkYregZhX",
"inclusive": false,
"jurisdiction": "DE",
"livemode": false,
@@ -848,7 +848,7 @@
"discount_amounts": [
],
- "id": "cnli_1M1fCkCWU96GXUyb83ECY4on",
+ "id": "cnli_1M4EYTCWU96GXUybQXKAeBS4",
"livemode": false,
"object": "credit_note_line_item",
"quantity": 1,
@@ -866,7 +866,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/credit_notes/cn_1M1fCkCWU96GXUyb6EzNkF9S/lines"
+ "url": "/v1/credit_notes/cn_1M4EYTCWU96GXUyba77W91bv/lines"
},
"livemode": false,
"memo": null,
@@ -885,7 +885,7 @@
{
"amount": 190,
"inclusive": false,
- "tax_rate": "txr_1M1fCjCWU96GXUybI14Yya3D"
+ "tax_rate": "txr_1M4EYTCWU96GXUybkYregZhX"
}
],
"total": 1690,
@@ -901,8 +901,8 @@
"discount_amounts": [
],
- "id": "cnli_1M1fCkCWU96GXUybvPJN1oud",
- "invoice_line_item": "il_1M1fCkCWU96GXUybfo3Ykrl3",
+ "id": "cnli_1M4EYTCWU96GXUybtCVLI2lw",
+ "invoice_line_item": "il_1M4EYTCWU96GXUybIMfpojqt",
"livemode": false,
"object": "credit_note_line_item",
"quantity": 1,
@@ -927,8 +927,8 @@
"description": null,
"discount": null,
"email": null,
- "id": "cus_MlBZv376Hvbo0b",
- "invoice_prefix": "74F86C8",
+ "id": "cus_MlBZUAFdvQEcCp",
+ "invoice_prefix": "C6AC5AD",
"invoice_settings": {
"custom_fields": null,
"default_payment_method": null,
@@ -957,7 +957,7 @@
"customer": "cus_MlBZUAFdvQEcCp",
"description": null,
"ending_balance": -500,
- "id": "cbtxn_1M1fCdCWU96GXUyb5ltYb53t",
+ "id": "cbtxn_1M4EYHCWU96GXUybBwVJIDTQ",
"invoice": null,
"livemode": false,
"metadata": null,
@@ -980,7 +980,7 @@
"type": "eu_bank_transfer"
}
},
- "id": "ccsbtxn_1M1fCdCWU96GXUybOdKBKacC",
+ "id": "ccsbtxn_1M4EYHCWU96GXUybYB501Wqv",
"livemode": false,
"net_amount": 5000,
"object": "customer_cash_balance_transaction",
@@ -993,7 +993,7 @@
},
"deleted_apple_pay_domain": {
"deleted": true,
- "id": "apwc_1M1fCcCWU96GXUyb8A2Sf6mm",
+ "id": "apwc_1M4EYACWU96GXUybw5yz2XQO",
"object": "apple_pay_domain"
},
"deleted_coupon": {
@@ -1003,7 +1003,7 @@
},
"deleted_customer": {
"deleted": true,
- "id": "cus_MlBZv376Hvbo0b",
+ "id": "cus_MlBZUAFdvQEcCp",
"object": "customer"
},
"deleted_discount": {
@@ -1038,27 +1038,27 @@
},
"deleted_external_account": {
"deleted": true,
- "id": "ba_1M1fCeCWU96GXUybDCwNBUBf",
+ "id": "ba_1M1fClCWU96GXUybDTiyXDj9",
"object": "bank_account"
},
"deleted_invoice": {
"deleted": true,
- "id": "in_1M1fCbCWU96GXUybNckhdi2X",
+ "id": "in_1M4EY6CWU96GXUybLbZ8Swu0",
"object": "invoice"
},
"deleted_invoiceitem": {
"deleted": true,
- "id": "ii_1M1fCeCWU96GXUyb5L6dqlFk",
+ "id": "ii_1M4EYHCWU96GXUybrGy8LIyK",
"object": "invoiceitem"
},
"deleted_payment_source": {
"deleted": true,
- "id": "ba_1M1fCeCWU96GXUybDCwNBUBf",
+ "id": "ba_1M1fClCWU96GXUybDTiyXDj9",
"object": "bank_account"
},
"deleted_person": {
"deleted": true,
- "id": "person_1M1fCjCWU96GXUybZBAP99pn",
+ "id": "person_1M4EYSCWU96GXUyb0JUb1Ibe",
"object": "person"
},
"deleted_plan": {
@@ -1073,27 +1073,27 @@
},
"deleted_radar.value_list": {
"deleted": true,
- "id": "rsl_1M1fCjCWU96GXUybS0H0nJry",
+ "id": "rsl_1M4EYSCWU96GXUybju0R7m5H",
"object": "radar.value_list"
},
"deleted_radar.value_list_item": {
"deleted": true,
- "id": "rsli_1M1fCjCWU96GXUybHDm316OX",
+ "id": "rsli_1M4EYSCWU96GXUybOlgvWjWW",
"object": "radar.value_list_item"
},
"deleted_sku": {
"deleted": true,
- "id": "sku_MlBZ9KDJASsuQ8",
+ "id": "sku_MnqEg6w4dT3CMW",
"object": "sku"
},
"deleted_subscription_item": {
"deleted": true,
- "id": "si_MlBZ7bfTP0uBj6",
+ "id": "si_MnqEsWUTqWJHA7",
"object": "subscription_item"
},
"deleted_tax_id": {
"deleted": true,
- "id": "txi_1M1fCjCWU96GXUybyn6CdodN",
+ "id": "txi_1M4EYTCWU96GXUybyVZuRk41",
"object": "tax_id"
},
"deleted_terminal.configuration": {
@@ -1103,29 +1103,29 @@
},
"deleted_terminal.location": {
"deleted": true,
- "id": "tml_BMwc1qV05RUIPuC5M0H0PrWX",
+ "id": "tml_koN0jJOT4fci7ZK0hnrtrRW5",
"object": "terminal.location"
},
"deleted_terminal.reader": {
"deleted": true,
- "id": "tmr_Zo01nuk2FHahKcD9jqunIB7g",
+ "id": "tmr_edRndN1Xwbnk0Ms9K8cosKjX",
"object": "terminal.reader"
},
"deleted_test_helpers.test_clock": {
"deleted": true,
- "id": "clock_1M1fCeCWU96GXUybdsb24Ggr",
+ "id": "clock_1M4EYKCWU96GXUybcUhiIgbI",
"object": "test_helpers.test_clock"
},
"deleted_webhook_endpoint": {
"deleted": true,
- "id": "we_1M1fCgCWU96GXUybmP13N4tT",
+ "id": "we_1M4EYNCWU96GXUybsTbzbSnD",
"object": "webhook_endpoint"
},
"discount": {
"checkout_session": null,
"coupon": {
"amount_off": null,
- "created": 1667865488,
+ "created": 1668478026,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
@@ -1141,9 +1141,9 @@
"times_redeemed": 0,
"valid": true
},
- "customer": "cus_MlBZv376Hvbo0b",
+ "customer": "cus_MlBZUAFdvQEcCp",
"end": 1234567890,
- "id": "di_1M1fCeCWU96GXUybsCk68ip9",
+ "id": "di_1M4EYKCWU96GXUybvHnGZsdq",
"invoice": null,
"invoice_item": null,
"object": "discount",
@@ -1189,12 +1189,12 @@
"uncategorized_text": null
},
"evidence_details": {
- "due_by": 1669507199,
+ "due_by": 1670198399,
"has_evidence": false,
"past_due": false,
"submission_count": 0
},
- "id": "dp_1M1fCcCWU96GXUyblTAlZKDF",
+ "id": "dp_1M4EYBCWU96GXUybwR3eNUYI",
"is_charge_refundable": true,
"livemode": false,
"metadata": {
@@ -1207,7 +1207,7 @@
"ephemeral_key": {
"created": 1234567890,
"expires": 1234567890,
- "id": "ephkey_1M1fCjCWU96GXUybhMuOUujc",
+ "id": "ephkey_1M4EYSCWU96GXUyb7lwdydJg",
"livemode": false,
"object": "ephemeral_key"
},
@@ -1238,7 +1238,7 @@
"usage_type": "licensed"
}
},
- "id": "evt_1M1fCgCWU96GXUybyuDFXD2t",
+ "id": "evt_1M4EYNCWU96GXUybtnXH9sKX",
"livemode": false,
"object": "event",
"pending_webhooks": 0,
@@ -1256,14 +1256,14 @@
},
"external_account": {
"account_holder_name": "Jane Austen",
- "account_holder_type": "individual",
+ "account_holder_type": "company",
"account_type": null,
"bank_name": "STRIPE TEST BANK",
"country": "US",
"currency": "usd",
"customer": null,
- "fingerprint": "1JWtPxqbdX5Gamtz",
- "id": "ba_1M1fCeCWU96GXUybDCwNBUBf",
+ "fingerprint": "vdxhi1lp41ge2nPn",
+ "id": "ba_1M1fClCWU96GXUybDTiyXDj9",
"last4": "6789",
"metadata": {
},
@@ -1276,8 +1276,8 @@
"balance_transaction": null,
"created": 1234567890,
"currency": "usd",
- "fee": "fee_1M1fCgCWU96GXUyboRpEohSB",
- "id": "fr_1M1fCgCWU96GXUybLPRM4a5b",
+ "fee": "fee_1M4EYMCWU96GXUybhRGkR2Kc",
+ "id": "fr_1M4EYMCWU96GXUybNItzl50R",
"metadata": {
},
"object": "fee_refund"
@@ -1285,34 +1285,81 @@
"file": {
"created": 1234567890,
"expires_at": 1234567890,
- "filename": "file_1M1fCjCWU96GXUybJf5OUBaQ",
- "id": "file_1M1fCjCWU96GXUybJf5OUBaQ",
+ "filename": "file_1M1fCjCWU96GXUybyhgupa8g",
+ "id": "file_1M1fCjCWU96GXUybyhgupa8g",
"links": {
"data": [
-
+ {
+ "created": 1668475944,
+ "expired": false,
+ "expires_at": null,
+ "file": "file_1M1fCjCWU96GXUybyhgupa8g",
+ "id": "link_1M4E0iCWU96GXUyby1LpuRgK",
+ "livemode": false,
+ "metadata": {
+ },
+ "object": "file_link",
+ "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfNWZieVFBckVwSDFhZ1E1cVQzSG54WEw200PUoI4cMf"
+ },
+ {
+ "created": 1668474431,
+ "expired": false,
+ "expires_at": null,
+ "file": "file_1M1fCjCWU96GXUybyhgupa8g",
+ "id": "link_1M4DcJCWU96GXUybo9fqqIIc",
+ "livemode": false,
+ "metadata": {
+ },
+ "object": "file_link",
+ "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfUk9DaHVHRU1HQjNOQXFDSnltUmdqcXpC00bIB4UO5Z"
+ },
+ {
+ "created": 1667941152,
+ "expired": false,
+ "expires_at": null,
+ "file": "file_1M1fCjCWU96GXUybyhgupa8g",
+ "id": "link_1M1yt2CWU96GXUybQvzkh6YZ",
+ "livemode": false,
+ "metadata": {
+ },
+ "object": "file_link",
+ "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfUzJ4U2R0cUpRUzhQdFhsdWRHamJ4VHdL00rI4YqhuD"
+ },
+ {
+ "created": 1667865493,
+ "expired": false,
+ "expires_at": null,
+ "file": "file_1M1fCjCWU96GXUybyhgupa8g",
+ "id": "link_1M1fCjCWU96GXUyb8O9zvZWK",
+ "livemode": false,
+ "metadata": {
+ },
+ "object": "file_link",
+ "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfVTU4ZURhN29HeTFYVnIwQlhRWGdIUU1600UvGrTVTl"
+ }
],
"has_more": false,
"object": "list",
- "url": "/v1/file_links?file=file_1M1fCjCWU96GXUybJf5OUBaQ"
+ "url": "/v1/file_links?file=file_1M1fCjCWU96GXUybyhgupa8g"
},
"object": "file",
"purpose": "dispute_evidence",
"size": 9863,
"title": null,
"type": "png",
- "url": "https://coker-upload-mydev.dev.stripe.me/v1/files/file_1M1fCjCWU96GXUybJf5OUBaQ/contents"
+ "url": "https://coker-upload-mydev.dev.stripe.me/v1/files/file_1M1fCjCWU96GXUybyhgupa8g/contents"
},
"file_link": {
"created": 1234567890,
"expired": false,
"expires_at": 1234567890,
"file": "file_1M1fCjCWU96GXUybyhgupa8g",
- "id": "link_1M1fCjCWU96GXUyb8O9zvZWK",
+ "id": "link_1M4EYSCWU96GXUyb09RyEcVQ",
"livemode": false,
"metadata": {
},
"object": "file_link",
- "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfVTU4ZURhN29HeTFYVnIwQlhRWGdIUU1600UvGrTVTl"
+ "url": "https://coker-upload-mydev.dev.stripe.me/links/MDB8YWNjdF8xTTFmQzVDV1U5NkdYVXlifGZsX3Rlc3RfcHFCWDF5QmJkYmdOc3NmanAyeXFFdldT00AwTSWLrF"
},
"financial_connections.account": {
"account_holder": {
@@ -1324,7 +1371,7 @@
"category": "cash",
"created": 1234567890,
"display_name": "Sample Checking Account",
- "id": "fca_1M1fCkCWU96GXUybSZ9rkBTA",
+ "id": "fca_1M4EYTCWU96GXUybajVQ7E3X",
"institution_name": "StripeBank",
"last4": "6789",
"livemode": false,
@@ -1342,10 +1389,10 @@
},
"financial_connections.account_owner": {
"email": "nobody+janesmith@stripe.com",
- "id": "fcaown_1M1fCkCWU96GXUyb3AybU4lQ",
+ "id": "fcaown_1M4EYTCWU96GXUybzCjZuAhD",
"name": "Jane Smith",
"object": "financial_connections.account_owner",
- "ownership": "fcaowns_1M1fCkCWU96GXUybbfnYURCC",
+ "ownership": "fcaowns_1M4EYTCWU96GXUybDElnMHGG",
"phone": "+1 555-555-5555",
"raw_address": "123 Main Street, Everytown USA",
"refreshed_at": 1234567890
@@ -1364,7 +1411,7 @@
"url": "/v1/financial_connections/accounts"
},
"client_secret": "fcsess_..._secret_...",
- "id": "fcsess_1M1fCkCWU96GXUyb4rRjvsMc",
+ "id": "fcsess_1M4EYTCWU96GXUybgQvaG5FF",
"livemode": false,
"object": "financial_connections.session",
"permissions": [
@@ -1413,8 +1460,8 @@
"year": 2025
},
"files": [
- "file_MlBZApczFxloBmdlYwtmy9nF",
- "file_MlBZYR5Inqt5f1PEwjVP5SZd"
+ "file_MnqE7NASMVDOKGW1ifwWfxqv",
+ "file_MnqEz5Yx3PsgKf0iVYW87YaL"
],
"first_name": "Jenny",
"issued_date": {
@@ -1427,7 +1474,7 @@
"status": "verified",
"type": "driving_license"
},
- "id": "vr_1M1fCkCWU96GXUybpPuSw7ZO",
+ "id": "vr_1M4EYTCWU96GXUybB7RlT4je",
"livemode": false,
"object": "identity.verification_report",
"options": {
@@ -1435,14 +1482,14 @@
}
},
"type": "document",
- "verification_session": "vs_MlBZsW2CbPr2AwmPpyM5Kalx"
+ "verification_session": "vs_MnqEgBtWFmlIX795iDnH8F6A"
},
"identity.verification_session": {
"client_secret": null,
"created": 1234567890,
- "id": "vs_1M1fCkCWU96GXUybqdQDXTbe",
+ "id": "vs_1M4EYTCWU96GXUybgEzrkwUl",
"last_error": null,
- "last_verification_report": "vr_MlBZFD0rH97ksN60GQwaJyns",
+ "last_verification_report": "vr_MnqECmhEZZ5YE9Sl1ztoT9pJ",
"livemode": false,
"metadata": {
},
@@ -1479,7 +1526,7 @@
"created": 1234567890,
"currency": "usd",
"custom_fields": null,
- "customer": "cus_MlBZv376Hvbo0b",
+ "customer": "cus_MlBZUAFdvQEcCp",
"customer_address": null,
"customer_email": null,
"customer_name": null,
@@ -1504,7 +1551,7 @@
"footer": null,
"from_invoice": null,
"hosted_invoice_url": null,
- "id": "in_1M1fCbCWU96GXUybNckhdi2X",
+ "id": "in_1M4EY6CWU96GXUybLbZ8Swu0",
"invoice_pdf": null,
"last_finalization_error": null,
"latest_revision": null,
@@ -1522,15 +1569,15 @@
"discounts": [
],
- "id": "il_1M1fCaCWU96GXUybcyGmHPn3",
- "invoice_item": "ii_1M1fCaCWU96GXUybHmvHkszc",
+ "id": "il_1M4EY5CWU96GXUybzIjX8RM7",
+ "invoice_item": "ii_1M4EY5CWU96GXUybprN4xAGV",
"livemode": false,
"metadata": {
},
"object": "line_item",
"period": {
- "end": 1667865484,
- "start": 1667865484
+ "end": 1668478013,
+ "start": 1668478013
},
"price": {
"active": true,
@@ -1572,7 +1619,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/invoices/in_1M1fCbCWU96GXUybNckhdi2X/lines"
+ "url": "/v1/invoices/in_1M4EY6CWU96GXUybLbZ8Swu0/lines"
},
"livemode": false,
"metadata": {
@@ -1624,22 +1671,22 @@
"invoiceitem": {
"amount": 1000,
"currency": "usd",
- "customer": "cus_MlBZv376Hvbo0b",
+ "customer": "cus_MlBZUAFdvQEcCp",
"date": 1234567890,
"description": "My First Invoice Item (created for API docs)",
"discountable": true,
"discounts": [
],
- "id": "ii_1M1fCeCWU96GXUyb5L6dqlFk",
+ "id": "ii_1M4EYHCWU96GXUybrGy8LIyK",
"invoice": null,
"livemode": false,
"metadata": {
},
"object": "invoiceitem",
"period": {
- "end": 1667865488,
- "start": 1667865488
+ "end": 1668478025,
+ "start": 1668478025
},
"price": {
"active": true,
@@ -1729,11 +1776,11 @@
"status": "active",
"type": "individual"
},
- "created": 1667865492,
+ "created": 1668478035,
"currency": "usd",
"exp_month": 8,
"exp_year": 2023,
- "id": "ic_1M1fCiCWU96GXUybjxHfIjwW",
+ "id": "ic_1M4EYRCWU96GXUybGMar6XHV",
"last4": "4242",
"livemode": false,
"metadata": {
@@ -1768,7 +1815,7 @@
"cardholder": null,
"created": 1234567890,
"currency": "usd",
- "id": "iauth_1M1fCiCWU96GXUybWslYFyyp",
+ "id": "iauth_1M4EYRCWU96GXUybO1CBPbtZ",
"livemode": false,
"merchant_amount": 0,
"merchant_currency": "usd",
@@ -1861,7 +1908,7 @@
"currency": "usd",
"exp_month": 8,
"exp_year": 2023,
- "id": "ic_1M1fCiCWU96GXUybnU1CxJqO",
+ "id": "ic_1M4EYRCWU96GXUybtKQ8M70z",
"last4": "4242",
"livemode": false,
"metadata": {
@@ -1943,24 +1990,24 @@
"evidence": {
"fraudulent": {
"additional_documentation": null,
- "explanation": "Fraud; card reported lost on 11/07/2022"
+ "explanation": "Fraud; card reported lost on 11/15/2022"
},
"reason": "fraudulent"
},
- "id": "idp_1M1fCjCWU96GXUyboqBqwCdN",
+ "id": "idp_1M4EYSCWU96GXUybGX9n7kPk",
"livemode": false,
"metadata": {
},
"object": "issuing.dispute",
"status": "unsubmitted",
- "transaction": "ipi_1M1fCiCWU96GXUybvKcy3a6z"
+ "transaction": "ipi_1M4EYSCWU96GXUybRxu3Gkkf"
},
"issuing.settlement": {
"bin": "424242",
- "clearing_date": 1667865493,
+ "clearing_date": 1668478036,
"created": 1234567890,
"currency": "usd",
- "id": "ise_1M1fCjCWU96GXUybMvQGmxYX",
+ "id": "ise_1M4EYSCWU96GXUybp5zZ4yGZ",
"interchange_fees": 44,
"livemode": false,
"metadata": {
@@ -1979,14 +2026,14 @@
"amount_details": {
"atm_fee": null
},
- "authorization": "iauth_1M1fCiCWU96GXUybmZtVmoMX",
+ "authorization": "iauth_1M4EYRCWU96GXUybFJ5DU7zL",
"balance_transaction": null,
- "card": "ic_1M1fCiCWU96GXUybylE8CBbY",
+ "card": "ic_1M4EYRCWU96GXUybu5XLUTVW",
"cardholder": "ich_1M1fCiCWU96GXUybv8h7uxTg",
"created": 1234567890,
"currency": "usd",
"dispute": null,
- "id": "ipi_1M1fCiCWU96GXUybDpyPlZ4f",
+ "id": "ipi_1M4EYRCWU96GXUybofYW5MRQ",
"livemode": false,
"merchant_amount": -100,
"merchant_currency": "usd",
@@ -2013,7 +2060,7 @@
"amount_total": 0,
"currency": "usd",
"description": "T-shirt",
- "id": "li_1M1fCeCWU96GXUybCkjO5cRE",
+ "id": "li_1M4EYKCWU96GXUyb5dq11ZIV",
"object": "item",
"price": {
"active": true,
@@ -2051,15 +2098,15 @@
"discounts": [
],
- "id": "il_tmp_1M1fCeCWU96GXUyb5L6dqlFk",
- "invoice_item": "ii_1M1fCeCWU96GXUyb5L6dqlFk",
+ "id": "il_tmp_1M4EYHCWU96GXUybrGy8LIyK",
+ "invoice_item": "ii_1M4EYHCWU96GXUybrGy8LIyK",
"livemode": false,
"metadata": {
},
"object": "line_item",
"period": {
- "end": 1667865488,
- "start": 1667865488
+ "end": 1668478025,
+ "start": 1668478025
},
"price": {
"active": true,
@@ -2101,7 +2148,7 @@
"login_link": {
"created": 1234567890,
"object": "login_link",
- "url": "https://coker-manage-mydev.dev.stripe.me/express/6as32j3Wrc1U"
+ "url": "https://coker-manage-mydev.dev.stripe.me/express/mbLG6CB2zIeT"
},
"mandate": {
"customer_acceptance": {
@@ -2112,7 +2159,7 @@
},
"type": "online"
},
- "id": "mandate_1M1fCiCWU96GXUybdyuGnCFI",
+ "id": "mandate_1M4EYRCWU96GXUybjSLoamQN",
"livemode": false,
"multi_use": {
},
@@ -2135,7 +2182,7 @@
"created": 1234567890,
"currency": "usd",
"customer": null,
- "id": "or_1M1fCiCWU96GXUybQa4WMB9b",
+ "id": "or_1M4EYRCWU96GXUybRYrmNurI",
"livemode": false,
"metadata": {
},
@@ -2232,7 +2279,7 @@
"consent_collection": null,
"currency": "usd",
"customer_creation": "always",
- "id": "plink_1M1fCiCWU96GXUybZmykhzLE",
+ "id": "plink_1M4EYRCWU96GXUyb610VwPcU",
"livemode": false,
"metadata": {
},
@@ -2297,7 +2344,7 @@
},
"created": 1234567890,
"customer": null,
- "id": "pm_1M1fCdCWU96GXUybtkmN5vd1",
+ "id": "pm_1M4EYGCWU96GXUyblZfo5YgS",
"livemode": false,
"metadata": {
"order_id": "123456789"
@@ -2452,15 +2499,15 @@
"amount": 1100,
"arrival_date": 1234567890,
"automatic": true,
- "balance_transaction": "txn_1M1fCUCWU96GXUybz4LTpeDL",
+ "balance_transaction": "txn_1M4EY3CWU96GXUyb7BkjEab9",
"created": 1234567890,
"currency": "usd",
"description": "STRIPE PAYOUT",
- "destination": "ba_1M1fCfCWU96GXUybZAaK3VkM",
+ "destination": "ba_1M4EYLCWU96GXUybZsmhP9E6",
"failure_balance_transaction": null,
"failure_code": null,
"failure_message": null,
- "id": "po_1M1fCfCWU96GXUybR2Gn4iMd",
+ "id": "po_1M4EYLCWU96GXUybFLSHBIVJ",
"livemode": false,
"metadata": {
},
@@ -2502,7 +2549,7 @@
]
},
- "id": "person_1M1fCjCWU96GXUybZBAP99pn",
+ "id": "person_1M4EYSCWU96GXUyb0JUb1Ibe",
"id_number_provided": false,
"last_name": null,
"metadata": {
@@ -2631,7 +2678,7 @@
"code": "FALL20",
"coupon": {
"amount_off": null,
- "created": 1667865488,
+ "created": 1668478026,
"currency": "usd",
"duration": "repeating",
"duration_in_months": 3,
@@ -2650,7 +2697,7 @@
"created": 1234567890,
"customer": null,
"expires_at": 1234567890,
- "id": "promo_1M1fCeCWU96GXUyb3rfSUtgp",
+ "id": "promo_1M4EYICWU96GXUybwksAZESW",
"livemode": false,
"max_redemptions": null,
"metadata": {
@@ -2700,7 +2747,7 @@
"footer": null,
"from_quote": null,
"header": null,
- "id": "qt_1M1fCeCWU96GXUybxhps6j8i",
+ "id": "qt_1M4EYKCWU96GXUybt0O0ZXxc",
"invoice": null,
"invoice_settings": {
"days_until_due": null
@@ -2737,7 +2784,7 @@
"charge": "ch_1234",
"created": 1234567890,
"fraud_type": "misc",
- "id": "issfr_1M1fCjCWU96GXUybTHkJtIfh",
+ "id": "issfr_1M4EYSCWU96GXUybjjfwpPq6",
"livemode": false,
"object": "radar.early_fraud_warning"
},
@@ -2745,7 +2792,7 @@
"alias": "custom_ip_blocklist",
"created": 1234567890,
"created_by": "jenny@example.com",
- "id": "rsl_1M1fCjCWU96GXUybS0H0nJry",
+ "id": "rsl_1M4EYSCWU96GXUybju0R7m5H",
"item_type": "ip_address",
"list_items": {
"data": [
@@ -2753,7 +2800,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/radar/value_list_items?value_list=rsl_1M1fCjCWU96GXUybS0H0nJry"
+ "url": "/v1/radar/value_list_items?value_list=rsl_1M4EYSCWU96GXUybju0R7m5H"
},
"livemode": false,
"metadata": {
@@ -2764,19 +2811,19 @@
"radar.value_list_item": {
"created": 1234567890,
"created_by": "jenny@example.com",
- "id": "rsli_1M1fCjCWU96GXUybHDm316OX",
+ "id": "rsli_1M4EYSCWU96GXUybOlgvWjWW",
"livemode": false,
"object": "radar.value_list_item",
"value": "1.2.3.4",
- "value_list": "rsl_1M1fCjCWU96GXUybScYoyJop"
+ "value_list": "rsl_1M4EYSCWU96GXUybtHl6uePa"
},
"refund": {
"amount": 100,
"balance_transaction": null,
- "charge": "ch_1M1fCUCWU96GXUybuwQRv8nG",
+ "charge": "ch_1M1fCUCWU96GXUyb2X2EDsPr",
"created": 1234567890,
"currency": "usd",
- "id": "re_1M1fCcCWU96GXUyb5fJkbPq5",
+ "id": "re_1M4EYBCWU96GXUybdCWdDmxq",
"metadata": {
},
"object": "refund",
@@ -2790,7 +2837,7 @@
"reporting.report_run": {
"created": 1234567890,
"error": null,
- "id": "frr_1M1fCjCWU96GXUybcsST7Eas",
+ "id": "frr_1M4EYSCWU96GXUybnuPUrNb5",
"livemode": true,
"object": "reporting.report_run",
"parameters": {
@@ -2842,7 +2889,7 @@
"charge": "ch_1M1fCUCWU96GXUyb2X2EDsPr",
"closed_reason": null,
"created": 1234567890,
- "id": "prv_1M1fCjCWU96GXUybiclDjqMT",
+ "id": "prv_1M4EYSCWU96GXUybmvOnQroC",
"ip_address": null,
"ip_address_location": null,
"livemode": false,
@@ -2875,7 +2922,7 @@
"type": "csv",
"url": "https://coker-upload-mydev.dev.stripe.me/v1/files/file_1M1fCjCWU96GXUybQUjS0rhI/contents"
},
- "id": "sqr_1M1fCjCWU96GXUybp1pkkfoZ",
+ "id": "sqr_1M4EYSCWU96GXUybDAtJsaZl",
"livemode": false,
"object": "scheduled_query_run",
"result_available_until": 1234567890,
@@ -2941,7 +2988,7 @@
"amount": 500,
"currency": "usd"
},
- "id": "shr_1M1fCiCWU96GXUybJcqSL6uj",
+ "id": "shr_1M4EYRCWU96GXUybQCbaUFpY",
"livemode": false,
"metadata": {
},
@@ -2958,7 +3005,7 @@
},
"created": 1234567890,
"currency": "usd",
- "id": "sku_MlBZ9KDJASsuQ8",
+ "id": "sku_MnqEg6w4dT3CMW",
"image": null,
"inventory": {
"quantity": 50,
@@ -2971,7 +3018,7 @@
"object": "sku",
"package_dimensions": null,
"price": 1500,
- "product": "prod_MlBZTKBs0T0KLb",
+ "product": "prod_MnqEkwF587FKbc",
"updated": 1234567890
},
"source": {
@@ -2983,11 +3030,11 @@
"swift_code": "TSTEZ122"
},
"amount": null,
- "client_secret": "src_client_secret_MIWWnzuI0nH3JI9YaEvGxtHT",
+ "client_secret": "src_client_secret_uoEQg1vlyxSv97tjN452sZDC",
"created": 1234567890,
"currency": "usd",
"flow": "receiver",
- "id": "src_1M1fCeCWU96GXUybgECEwLSn",
+ "id": "src_1M4EYKCWU96GXUybo3FB7mOA",
"livemode": false,
"metadata": {
},
@@ -3018,7 +3065,7 @@
"source_mandate_notification": {
"amount": 2000,
"created": 1234567890,
- "id": "srcmn_1M1fCiCWU96GXUybdK1GZAFU",
+ "id": "srcmn_1M4EYRCWU96GXUybirTh679e",
"livemode": false,
"object": "source_mandate_notification",
"reason": "debit_initiated",
@@ -3036,11 +3083,11 @@
"swift_code": "TSTEZ122"
},
"amount": null,
- "client_secret": "src_client_secret_uGDPE9Y7nhOztclryRXjCDTk",
- "created": 1667865492,
+ "client_secret": "src_client_secret_h2fiesVR77ccdzUtFtJ6n6D8",
+ "created": 1668478035,
"currency": "usd",
"flow": "receiver",
- "id": "src_1M1fCiCWU96GXUybwPeOEuZt",
+ "id": "src_1M4EYRCWU96GXUybaBHmNkVe",
"livemode": false,
"metadata": {
},
@@ -3077,10 +3124,10 @@
"amount": 500,
"created": 1234567890,
"currency": "usd",
- "id": "srctxn_1M1fCiCWU96GXUybLS4wpn8q",
+ "id": "srctxn_1M4EYRCWU96GXUybnIAKd474",
"livemode": false,
"object": "source_transaction",
- "source": "src_1M1fCeCWU96GXUybgECEwLSn",
+ "source": "src_1M4EYKCWU96GXUybo3FB7mOA",
"status": "succeeded",
"type": "ach_credit_transfer"
},
@@ -3110,13 +3157,13 @@
"description": null,
"discount": null,
"ended_at": 1234567890,
- "id": "sub_1M1fCbCWU96GXUybch4npIDG",
+ "id": "sub_1M4EY9CWU96GXUybD0qwHmtX",
"items": {
"data": [
{
"billing_thresholds": null,
- "created": 1667865486,
- "id": "si_MlBZUdx2UdsnYF",
+ "created": 1668478018,
+ "id": "si_MnqEeZG5JCT0qR",
"metadata": {
},
"object": "subscription_item",
@@ -3148,7 +3195,7 @@
"unit_amount_decimal": "2000"
},
"quantity": 1,
- "subscription": "sub_1M1fCbCWU96GXUybch4npIDG",
+ "subscription": "sub_1M4EY9CWU96GXUybD0qwHmtX",
"tax_rates": [
]
@@ -3156,7 +3203,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/subscription_items?subscription=sub_1M1fCbCWU96GXUybch4npIDG"
+ "url": "/v1/subscription_items?subscription=sub_1M4EY9CWU96GXUybD0qwHmtX"
},
"latest_invoice": null,
"livemode": false,
@@ -3184,8 +3231,8 @@
},
"subscription_item": {
"billing_thresholds": null,
- "created": 1667865488,
- "id": "si_MlBZ7bfTP0uBj6",
+ "created": 1668478025,
+ "id": "si_MnqEsWUTqWJHA7",
"metadata": {
},
"object": "subscription_item",
@@ -3217,7 +3264,7 @@
"unit_amount_decimal": "2000"
},
"quantity": 1,
- "subscription": "sub_1M1fCdCWU96GXUyb5TEbcbLU",
+ "subscription": "sub_1M4EYHCWU96GXUybyKlXyhOe",
"tax_rates": [
]
@@ -3228,7 +3275,7 @@
"completed_at": 1234567890,
"created": 1234567890,
"current_phase": null,
- "customer": "cus_MlBZv376Hvbo0b",
+ "customer": "cus_MlBZUAFdvQEcCp",
"default_settings": {
"application_fee_percent": null,
"automatic_tax": {
@@ -3244,7 +3291,7 @@
"transfer_data": null
},
"end_behavior": "release",
- "id": "sub_sched_1M1fCeCWU96GXUybUU48JG0k",
+ "id": "sub_sched_1M4EYHCWU96GXUybLNpUOmqM",
"livemode": false,
"metadata": {
},
@@ -3265,7 +3312,7 @@
],
"description": null,
- "end_date": 1699919888,
+ "end_date": 1700532425,
"invoice_settings": null,
"items": [
{
@@ -3281,7 +3328,7 @@
},
"on_behalf_of": null,
"proration_behavior": "create_prorations",
- "start_date": 1668470288,
+ "start_date": 1669082825,
"transfer_data": null,
"trial_end": null
}
@@ -3302,7 +3349,7 @@
"country": "DE",
"created": 1234567890,
"customer": "cus_MlBZUAFdvQEcCp",
- "id": "txi_1M1fCjCWU96GXUybyn6CdodN",
+ "id": "txi_1M4EYTCWU96GXUybyVZuRk41",
"livemode": false,
"object": "tax_id",
"type": "eu_vat",
@@ -3319,7 +3366,7 @@
"created": 1234567890,
"description": "VAT Germany",
"display_name": "VAT",
- "id": "txr_1M1fCeCWU96GXUybR1UazFX0",
+ "id": "txr_1M4EYHCWU96GXUyb9qF4KAt4",
"inclusive": false,
"jurisdiction": "DE",
"livemode": false,
@@ -3332,7 +3379,7 @@
},
"terminal.configuration": {
"bbpos_wisepos_e": {
- "splashscreen": "file_1M1fCjCWU96GXUyb70ZNrleW"
+ "splashscreen": "file_1M4EYSCWU96GXUybUubMY2iA"
},
"id": "tmc_ElVUAjF8xXG3hj",
"is_account_default": false,
@@ -3341,7 +3388,7 @@
},
"terminal.connection_token": {
"object": "terminal.connection_token",
- "secret": "pst_test_W1ps4kwaK7cXR1Y1z3aKlfJ"
+ "secret": "pst_test_f1MzSt7Zc00KZtVHMaPeLsY"
},
"terminal.location": {
"address": {
@@ -3353,7 +3400,7 @@
"state": "CA"
},
"display_name": "My First Store",
- "id": "tml_BMwc1qV05RUIPuC5M0H0PrWX",
+ "id": "tml_koN0jJOT4fci7ZK0hnrtrRW5",
"livemode": false,
"metadata": {
},
@@ -3363,7 +3410,7 @@
"action": null,
"device_sw_version": null,
"device_type": "bbpos_wisepos_e",
- "id": "tmr_Zo01nuk2FHahKcD9jqunIB7g",
+ "id": "tmr_edRndN1Xwbnk0Ms9K8cosKjX",
"ip_address": "192.168.2.2",
"label": "Blue Rabbit",
"livemode": false,
@@ -3378,7 +3425,7 @@
"created": 1234567890,
"deletes_after": 1234567890,
"frozen_time": 1234567890,
- "id": "clock_1M1fCeCWU96GXUybdsb24Ggr",
+ "id": "clock_1M4EYKCWU96GXUybcUhiIgbI",
"livemode": false,
"name": null,
"object": "test_helpers.test_clock",
@@ -3402,7 +3449,7 @@
"exp_year": 2023,
"fingerprint": "8OIWN6dO1Fs3Mvk2",
"funding": "credit",
- "id": "card_1M1fCeCWU96GXUybsRNjeYPM",
+ "id": "card_1M4EYHCWU96GXUyblxpWGdsj",
"last4": "4242",
"metadata": {
},
@@ -3412,7 +3459,7 @@
},
"client_ip": null,
"created": 1234567890,
- "id": "tok_1M1fCeCWU96GXUybUOCkaZst",
+ "id": "tok_1M4EYHCWU96GXUybpRuMDPa8",
"livemode": false,
"object": "token",
"type": "card",
@@ -3427,7 +3474,7 @@
"expected_availability_date": 123456789,
"failure_code": null,
"failure_message": null,
- "id": "tu_1M1fCgCWU96GXUybd7DYw3CV",
+ "id": "tu_1M4EYMCWU96GXUybKPIWn15g",
"livemode": false,
"metadata": {
"order_id": "12345678"
@@ -3443,11 +3490,11 @@
"type": "individual"
},
"amount": null,
- "client_secret": "src_client_secret_wZgRdBDpGuy23JnUlt0voPDJ",
- "created": 1667865490,
+ "client_secret": "src_client_secret_fpwQoNszb7L240HxJgBo4IGT",
+ "created": 1668478030,
"currency": "usd",
"flow": "code_verification",
- "id": "src_1M1fCgCWU96GXUybptPcp76b",
+ "id": "src_1M4EYMCWU96GXUybmAPIC7Yn",
"livemode": false,
"metadata": {
},
@@ -3474,13 +3521,13 @@
"transfer": {
"amount": 1100,
"amount_reversed": 0,
- "balance_transaction": "txn_1M1fCUCWU96GXUybz4LTpeDL",
+ "balance_transaction": "txn_1M4EY3CWU96GXUyb7BkjEab9",
"created": 1234567890,
"currency": "usd",
"description": null,
"destination": "acct_1M1fC5CWU96GXUyb",
- "destination_payment": "py_MlBZ1uUcC0yzGr",
- "id": "tr_1M1fCfCWU96GXUybzGscv2i9",
+ "destination_payment": "py_MnqESm2dD6SwpN",
+ "id": "tr_1M4EYLCWU96GXUybwJcEkuDk",
"livemode": false,
"metadata": {
},
@@ -3491,7 +3538,7 @@
],
"has_more": false,
"object": "list",
- "url": "/v1/transfers/tr_1M1fCfCWU96GXUybzGscv2i9/reversals"
+ "url": "/v1/transfers/tr_1M4EYLCWU96GXUybwJcEkuDk/reversals"
},
"reversed": false,
"source_transaction": null,
@@ -3504,51 +3551,51 @@
"created": 1234567890,
"currency": "usd",
"destination_payment_refund": null,
- "id": "trr_1M1fCfCWU96GXUybISqMeNhN",
+ "id": "trr_1M4EYLCWU96GXUyb0w2qBQt0",
"metadata": {
},
"object": "transfer_reversal",
"source_refund": null,
- "transfer": "tr_1M1fCfCWU96GXUybzGscv2i9"
+ "transfer": "tr_1M4EYLCWU96GXUybwJcEkuDk"
},
"treasury.credit_reversal": {
"amount": 1000,
"created": 1234567890,
"currency": "usd",
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgZakeok_H86Nv27q3EwvBFmlrGUU8UbVk9JqJr7istQmTdTMxPf6Mk28NKfpgarR9Idml4fOWzqv4Pc32dbwg",
- "id": "credrev_1M1fCmCWU96GXUybKKMAAVmh",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNjoy5sGMgYGW4WLolA6Nv32NgWJgWLVDY1QnXp7zgAXOTnzLGxWrY_NsOGP6Dr5G42fskb-6oH1U061j2F7q8CBP9P_Xg",
+ "id": "credrev_1M4EYWCWU96GXUybvamdH3nj",
"livemode": false,
"metadata": {
},
"network": "ach",
"object": "treasury.credit_reversal",
- "received_credit": "rc_1M1fCmCWU96GXUybET5L6dxu",
+ "received_credit": "rc_1M4EYWCWU96GXUybUVz2szVt",
"status": "processing",
"status_transitions": {
"posted_at": null
},
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.debit_reversal": {
"amount": 1000,
"created": 1234567890,
"currency": "usd",
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgZN3A6LBk46Nv0ZXowe4O3dCKjMeIKZ6a33xjZJ5ErG-5YLxyDQxq-WTGpbE-CYVSmxe39p752NMH1bs-uQgw",
- "id": "debrev_1M1fCmCWU96GXUyb3SefTrfv",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNjoy5sGMgYEAou6W9c6Nv3HoaombKsFPGr59Fv83aOenxelnbLTEQCZGpmZGhKp6hRE4_u6mye0-OPzDC-sMLxai7ZEnw",
+ "id": "debrev_1M4EYWCWU96GXUybP7xVlqKz",
"linked_flows": null,
"livemode": false,
"metadata": {
},
"network": "ach",
"object": "treasury.debit_reversal",
- "received_debit": "rd_1M1fCmCWU96GXUybrVpeEpNU",
+ "received_debit": "rd_1M4EYWCWU96GXUybWTYFR2IK",
"status": "processing",
"status_transitions": {
"completed_at": null
},
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.financial_account": {
"active_features": [
@@ -3584,7 +3631,7 @@
"type": "aba"
}
],
- "id": "fa_1M1fChCWU96GXUybhXvnv4dN",
+ "id": "fa_1M4EYPCWU96GXUybkS0taQTE",
"livemode": true,
"metadata": null,
"object": "treasury.financial_account",
@@ -3683,9 +3730,9 @@
"currency": "usd",
"description": "InboundTransfer from my external bank account",
"failure_details": null,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgZ2GpI1CyA6Nv0EaSWTxBEwizPgcB1Wwd9Fbgpu89NcJWzP147dZ5bQEYjCJVQauVYrtLTDkPsiMYMNm4vDQA",
- "id": "ibt_1M1fCmCWU96GXUybbrLfisYa",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNjoy5sGMgbmI7VunEc6Nv152XtXnzuQ32GpcY5VAQmcTZQZhZ5Ggb2QTmbFH8YOR87HeCkFeM5gLgRhrs3WghEYHeMtjQ",
+ "id": "ibt_1M4EYWCWU96GXUybb8KMkk5i",
"linked_flows": {
"received_debit": null
},
@@ -3693,7 +3740,7 @@
"metadata": {
},
"object": "treasury.inbound_transfer",
- "origin_payment_method": "pm_1M1fClCWU96GXUybSkyrhv7q",
+ "origin_payment_method": "pm_1M4EYTCWU96GXUyb1D0F8IWO",
"origin_payment_method_details": {
"billing_details": {
"address": {
@@ -3725,7 +3772,7 @@
"failed_at": null,
"succeeded_at": null
},
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.outbound_payment": {
"amount": 10000,
@@ -3736,7 +3783,7 @@
"description": "OutboundPayment to a 3rd party",
"destination_payment_method": null,
"destination_payment_method_details": {
- "destination": "ba_1M1fCeCWU96GXUybDCwNBUBf",
+ "destination": "ba_1M1fClCWU96GXUybDTiyXDj9",
"type": "us_bank_account"
},
"end_user_details": {
@@ -3744,9 +3791,9 @@
"present": false
},
"expected_arrival_date": 1234567890,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgatjgo_-Ms6Nf1fPE7eLhaWnobganoqHdFdeDO_jW9LfjvDo_XlH41LooXDlkf0wq1WkFhsWcNHnjUx9ZuR",
- "id": "obp_1M1fClCWU96GXUybd0TmPmlr",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNfoy5sGMgb9LjwvOhw6Nf1ElpaZRsIvl-VlfKqg7IU7U-QqKyxtcktZS4TfS5zTaqZ37M173SXzg3GlGvOjLlnzfDQo",
+ "id": "obp_1M4EYVCWU96GXUybC4NylKqJ",
"livemode": false,
"metadata": {
},
@@ -3760,7 +3807,7 @@
"posted_at": null,
"returned_at": null
},
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.outbound_transfer": {
"amount": 10000,
@@ -3768,7 +3815,7 @@
"created": 1234567890,
"currency": "usd",
"description": "OutboundTransfer to my external bank account",
- "destination_payment_method": "pm_1M1fClCWU96GXUybSkyrhv7q",
+ "destination_payment_method": "pm_1M4EYTCWU96GXUyb1D0F8IWO",
"destination_payment_method_details": {
"billing_details": {
"address": {
@@ -3794,9 +3841,9 @@
}
},
"expected_arrival_date": 1234567890,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgbVjCrYxBQ6Nv3OZd801kWNy5xFoMek2nab_GWjZTn720yx6Pih8bak69y_R8azCPCRh4g4uJxHNxCRWhaA0g",
- "id": "obt_1M1fClCWU96GXUybyzP90Erb",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNfoy5sGMgakeFjhWfk6Nv2c__WHkNLMowZHGKx6EupaMyA28QKyl3yvx79CON4Wmo6Gi85uJPYqHGbaDFz3zptm7tmy6A",
+ "id": "obt_1M4EYVCWU96GXUyboD3Wqlzw",
"livemode": false,
"metadata": {
},
@@ -3810,7 +3857,7 @@
"posted_at": null,
"returned_at": null
},
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.received_credit": {
"amount": 1234,
@@ -3818,9 +3865,9 @@
"currency": "usd",
"description": "Stripe Test",
"failure_code": null,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgbY3ZIgb_06Nv3qLJ843F7Wpq7Oho7uyJ13Z-zZSr8uJ4L8zB9CkOLiFQ9uNa8aF-jPELJdl7MgzdCYgTCTCQ",
- "id": "rc_1M1fCmCWU96GXUybET5L6dxu",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNjoy5sGMgYmCawCtW46Nv1Uhp8CI7VVfSQ97R7M4Ih_hrAbYEiemEFqXvEXcrNPpSW4OW1XDBDZ2gfFijPgSerbuu-XcQ",
+ "id": "rc_1M4EYWCWU96GXUybUVz2szVt",
"initiating_payment_method_details": {
"billing_details": {
"address": {
@@ -3852,11 +3899,11 @@
"network": "ach",
"object": "treasury.received_credit",
"reversal_details": {
- "deadline": 1667952000,
+ "deadline": 1668643200,
"restricted_reason": null
},
"status": "succeeded",
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.received_debit": {
"amount": 54321,
@@ -3864,9 +3911,9 @@
"currency": "usd",
"description": "Stripe Test",
"failure_code": null,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKJi3ppsGMgYbBmY3sQw6Nv0TGh7BLu5YNao-UDpedcvbUXwy9MHLzCjfa9z5PPeQYvMjGjU-WKjF1BdNEYU9CMwNVRcr9w",
- "id": "rd_1M1fCmCWU96GXUybjvMe4ptM",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "hosted_regulatory_receipt_url": "https://coker-agrippa-mydev.dev.stripe.me/regulatory-receipt/CBQaFwoVYWNjdF8xTTFmQzVDV1U5NkdYVXliKNjoy5sGMgbiPSfe7jA6Nv2ZXT4Rxyj5m51qzWE3aezoshRkZE2QaviXyLlwN5VQWQtn7lmJ13zyLy8pXJ5LRgpFexxEeg",
+ "id": "rd_1M4EYWCWU96GXUybDdvuv4dH",
"initiating_payment_method_details": {
"billing_details": {
"address": {
@@ -3897,11 +3944,11 @@
"network": "ach",
"object": "treasury.received_debit",
"reversal_details": {
- "deadline": 1667952000,
+ "deadline": 1668643200,
"restricted_reason": null
},
"status": "succeeded",
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS"
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17"
},
"treasury.transaction": {
"amount": -100,
@@ -3913,10 +3960,10 @@
"created": 1234567890,
"currency": "usd",
"description": "Jane Austen (6789) | Outbound transfer | transfer",
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "flow": "obt_1M1fClCWU96GXUybyzP90Erb",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "flow": "obt_1M4EYVCWU96GXUyboD3Wqlzw",
"flow_type": "outbound_transfer",
- "id": "trxn_1M1fChCWU96GXUybbS6pExkS",
+ "id": "trxn_1M4EYPCWU96GXUybGlMXPO17",
"livemode": false,
"object": "treasury.transaction",
"status": "open",
@@ -3934,33 +3981,33 @@
"created": 1234567890,
"currency": "usd",
"effective_at": 1234567890,
- "financial_account": "fa_1M1fChCWU96GXUybhXvnv4dN",
- "flow": "obt_1M1fClCWU96GXUybyzP90Erb",
+ "financial_account": "fa_1M4EYPCWU96GXUybkS0taQTE",
+ "flow": "obt_1M4EYVCWU96GXUyboD3Wqlzw",
"flow_type": "outbound_transfer",
- "id": "trxne_1M1fClCWU96GXUybbr60uSwb",
+ "id": "trxne_1M4EYVCWU96GXUyb7qt6LMCl",
"livemode": false,
"object": "treasury.transaction_entry",
- "transaction": "trxn_1M1fChCWU96GXUybbS6pExkS",
+ "transaction": "trxn_1M4EYPCWU96GXUybGlMXPO17",
"type": "outbound_transfer"
},
"usage_record": {
- "id": "mbur_1M1fCeCWU96GXUybEsGiKFv0",
+ "id": "mbur_1M4EYICWU96GXUybYbONm7dO",
"livemode": false,
"object": "usage_record",
"quantity": 100,
- "subscription_item": "si_MlBZbkcSlkEO46",
+ "subscription_item": "si_MnqEaKg3lee0QE",
"timestamp": 1234567890
},
"usage_record_summary": {
- "id": "sis_1M1fCeCWU96GXUybjE3NabRy",
- "invoice": "in_1M1fCeCWU96GXUybNeXrYM4B",
+ "id": "sis_1M4EYICWU96GXUyb7yqAfe1A",
+ "invoice": "in_1M4EYHCWU96GXUybVBbNIkKf",
"livemode": false,
"object": "usage_record_summary",
"period": {
- "end": 1667865488,
- "start": 1665273488
+ "end": 1668478026,
+ "start": 1665886026
},
- "subscription_item": "si_MlBZg6EkAJKY01",
+ "subscription_item": "si_MnqEUTYcyMHLcR",
"total_usage": 123
},
"webhook_endpoint": {
@@ -3972,7 +4019,7 @@
"charge.failed",
"charge.succeeded"
],
- "id": "we_1M1fCgCWU96GXUybmP13N4tT",
+ "id": "we_1M4EYNCWU96GXUybsTbzbSnD",
"livemode": false,
"metadata": {
},
diff --git a/openapi/spec3.json b/openapi/spec3.json
index 13d151fa..0841adb6 100644
--- a/openapi/spec3.json
+++ b/openapi/spec3.json
@@ -3654,6 +3654,7 @@
},
"refunds": {
"description": "A list of refunds that have been applied to the charge.",
+ "nullable": true,
"properties": {
"data": {
"description": "Details about each object.",
@@ -7609,41 +7610,6 @@
],
"x-resourceId": "deleted_radar.value_list_item"
},
- "deleted_sku": {
- "description": "",
- "properties": {
- "deleted": {
- "description": "Always true for a deleted object",
- "enum": [
- true
- ],
- "type": "boolean"
- },
- "id": {
- "description": "Unique identifier for the object.",
- "maxLength": 5000,
- "type": "string"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value.",
- "enum": [
- "sku"
- ],
- "type": "string"
- }
- },
- "required": [
- "deleted",
- "id",
- "object"
- ],
- "title": "DeletedSku",
- "type": "object",
- "x-expandableFields": [
-
- ],
- "x-resourceId": "deleted_sku"
- },
"deleted_subscription_item": {
"description": "",
"properties": {
@@ -17093,31 +17059,6 @@
"description": "The price used to generate the line item.",
"nullable": true
},
- "product": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/product"
- },
- {
- "$ref": "#/components/schemas/deleted_product"
- }
- ],
- "description": "The ID of the product for this line item.\n\nThis will always be the same as `price.product`.",
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/product"
- },
- {
- "$ref": "#/components/schemas/deleted_product"
- }
- ]
- }
- },
"quantity": {
"description": "The quantity of products being purchased.",
"nullable": true,
@@ -17146,7 +17087,6 @@
"x-expandableFields": [
"discounts",
"price",
- "product",
"taxes"
],
"x-resourceId": "item"
@@ -18336,15 +18276,393 @@
]
},
- "order": {
- "description": "An Order describes a purchase being made by a customer, including the\nproducts & quantities being purchased, the order status, the payment information,\nand the billing/shipping details.\n\nRelated guide: [Orders overview](https://stripe.com/docs/orders)",
+ "outbound_payments_payment_method_details": {
+ "description": "",
"properties": {
- "amount_subtotal": {
- "description": "Order cost before any discounts or taxes are applied. A positive integer representing the subtotal of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).",
+ "billing_details": {
+ "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
+ },
+ "financial_account": {
+ "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account"
+ },
+ "type": {
+ "description": "The type of the payment method used in the OutboundPayment.",
+ "enum": [
+ "financial_account",
+ "us_bank_account"
+ ],
+ "type": "string"
+ },
+ "us_bank_account": {
+ "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"
+ }
+ },
+ "required": [
+ "billing_details",
+ "type"
+ ],
+ "title": "OutboundPaymentsPaymentMethodDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "billing_details",
+ "financial_account",
+ "us_bank_account"
+ ]
+ },
+ "outbound_payments_payment_method_details_financial_account": {
+ "description": "",
+ "properties": {
+ "id": {
+ "description": "Token of the FinancialAccount.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "network": {
+ "description": "The rails used to send funds.",
+ "enum": [
+ "stripe"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "network"
+ ],
+ "title": "outbound_payments_payment_method_details_financial_account",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "outbound_payments_payment_method_details_us_bank_account": {
+ "description": "",
+ "properties": {
+ "account_holder_type": {
+ "description": "Account holder type: individual or company.",
+ "enum": [
+ "company",
+ "individual"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "account_type": {
+ "description": "Account type: checkings or savings. Defaults to checking if omitted.",
+ "enum": [
+ "checking",
+ "savings"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "network": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "routing_number": {
+ "description": "Routing number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "network"
+ ],
+ "title": "outbound_payments_payment_method_details_us_bank_account",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "outbound_transfers_payment_method_details": {
+ "description": "",
+ "properties": {
+ "billing_details": {
+ "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
+ },
+ "type": {
+ "description": "The type of the payment method used in the OutboundTransfer.",
+ "enum": [
+ "us_bank_account"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "us_bank_account": {
+ "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"
+ }
+ },
+ "required": [
+ "billing_details",
+ "type"
+ ],
+ "title": "OutboundTransfersPaymentMethodDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "billing_details",
+ "us_bank_account"
+ ]
+ },
+ "outbound_transfers_payment_method_details_us_bank_account": {
+ "description": "",
+ "properties": {
+ "account_holder_type": {
+ "description": "Account holder type: individual or company.",
+ "enum": [
+ "company",
+ "individual"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "account_type": {
+ "description": "Account type: checkings or savings. Defaults to checking if omitted.",
+ "enum": [
+ "checking",
+ "savings"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "network": {
+ "description": "The US bank account network used to send funds.",
+ "enum": [
+ "ach",
+ "us_domestic_wire"
+ ],
+ "type": "string"
+ },
+ "routing_number": {
+ "description": "Routing number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "network"
+ ],
+ "title": "outbound_transfers_payment_method_details_us_bank_account",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "package_dimensions": {
+ "description": "",
+ "properties": {
+ "height": {
+ "description": "Height, in inches.",
+ "type": "number"
+ },
+ "length": {
+ "description": "Length, in inches.",
+ "type": "number"
+ },
+ "weight": {
+ "description": "Weight, in ounces.",
+ "type": "number"
+ },
+ "width": {
+ "description": "Width, in inches.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "height",
+ "length",
+ "weight",
+ "width"
+ ],
+ "title": "PackageDimensions",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_flows_amount_details": {
+ "description": "",
+ "properties": {
+ "tip": {
+ "$ref": "#/components/schemas/payment_flows_amount_details_resource_tip"
+ }
+ },
+ "title": "PaymentFlowsAmountDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "tip"
+ ]
+ },
+ "payment_flows_amount_details_resource_tip": {
+ "description": "",
+ "properties": {
+ "amount": {
+ "description": "Portion of the amount that corresponds to a tip.",
"type": "integer"
+ }
+ },
+ "title": "PaymentFlowsAmountDetailsResourceTip",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_flows_automatic_payment_methods_payment_intent": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Automatically calculates compatible payment methods",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_flows_installment_options": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
},
- "amount_total": {
- "description": "Total order cost after discounts and taxes are applied. A positive integer representing the cost of the order in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).",
+ "plan": {
+ "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "PaymentFlowsInstallmentOptions",
+ "type": "object",
+ "x-expandableFields": [
+ "plan"
+ ]
+ },
+ "payment_flows_private_payment_methods_alipay": {
+ "description": "",
+ "properties": {
+ },
+ "title": "PaymentFlowsPrivatePaymentMethodsAlipay",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_flows_private_payment_methods_alipay_details": {
+ "description": "",
+ "properties": {
+ "buyer_id": {
+ "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "Transaction ID of this particular Alipay transaction.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_flows_private_payment_methods_klarna_dob": {
+ "description": "",
+ "properties": {
+ "day": {
+ "description": "The day of birth, between 1 and 31.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "month": {
+ "description": "The month of birth, between 1 and 12.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "year": {
+ "description": "The four-digit year of birth.",
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_intent": {
+ "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).",
+ "properties": {
+ "amount": {
+ "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/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://stripe.com/docs/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).",
+ "type": "integer"
+ },
+ "amount_capturable": {
+ "description": "Amount that can be captured from this PaymentIntent.",
+ "type": "integer"
+ },
+ "amount_details": {
+ "$ref": "#/components/schemas/payment_flows_amount_details"
+ },
+ "amount_received": {
+ "description": "Amount that was collected by this PaymentIntent.",
"type": "integer"
},
"application": {
@@ -18357,7 +18675,7 @@
"$ref": "#/components/schemas/application"
}
],
- "description": "ID of the Connect application that created the Order, if any.",
+ "description": "ID of the Connect application that created the PaymentIntent.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -18367,33 +18685,61 @@
]
}
},
- "automatic_tax": {
- "$ref": "#/components/schemas/orders_v2_resource_automatic_tax"
+ "application_fee_amount": {
+ "description": "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 payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "nullable": true,
+ "type": "integer"
},
- "billing_details": {
+ "automatic_payment_methods": {
"anyOf": [
{
- "$ref": "#/components/schemas/orders_v2_resource_billing_details"
+ "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"
}
],
- "description": "Customer billing details associated with the order.",
+ "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)",
"nullable": true
},
- "client_permissions": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/orders_v2_resource_client_permissions"
- }
+ "canceled_at": {
+ "description": "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",
+ "nullable": true,
+ "type": "integer"
+ },
+ "cancellation_reason": {
+ "description": "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`, or `automatic`).",
+ "enum": [
+ "abandoned",
+ "automatic",
+ "duplicate",
+ "failed_invoice",
+ "fraudulent",
+ "requested_by_customer",
+ "void_invoice"
],
- "description": "The fields on the Order that can be updated from the client",
- "nullable": true
+ "nullable": true,
+ "type": "string"
+ },
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "type": "string"
},
"client_secret": {
- "description": "The client secret of this Order. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment for an Order from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. \n\nRefer to our docs for [creating and processing an order](https://stripe.com/docs/orders-beta/create-and-process) to learn about how client_secret should be handled.",
+ "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe 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.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
+ "confirmation_method": {
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "type": "string"
+ },
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
@@ -18416,7 +18762,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "The customer which this orders belongs to.",
+ "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -18435,78 +18781,59 @@
"nullable": true,
"type": "string"
},
- "discounts": {
- "description": "The discounts applied to the order. Use `expand[]=discounts` to expand each discount.",
- "items": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/discount"
- }
- ],
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/discount"
- }
- ]
- }
- },
- "nullable": true,
- "type": "array"
- },
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
- "ip_address": {
- "description": "A recent IP address of the purchaser used for tax reporting and tax location inference.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "line_items": {
- "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost. There is a maximum of 100 line items.",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/item"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
+ "invoice": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
"type": "string"
},
- "url": {
- "description": "The URL where this list can be accessed.",
+ {
+ "$ref": "#/components/schemas/invoice"
+ }
+ ],
+ "description": "ID of the invoice that created this PaymentIntent, if it exists.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/invoice"
+ }
+ ]
+ }
+ },
+ "last_payment_error": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/api_errors"
+ }
+ ],
+ "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.",
+ "nullable": true
+ },
+ "latest_charge": {
+ "anyOf": [
+ {
"maxLength": 5000,
"type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/charge"
}
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
],
- "title": "OrdersV2ResourceLineItemList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
+ "description": "The latest charge created by this payment intent.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/charge"
+ }
+ ]
+ }
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
@@ -18517,2558 +18844,2622 @@
"maxLength": 500,
"type": "string"
},
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "nullable": true,
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
"type": "object"
},
+ "next_action": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_next_action"
+ }
+ ],
+ "description": "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.",
+ "nullable": true
+ },
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
- "order"
+ "payment_intent"
],
"type": "string"
},
- "payment": {
- "$ref": "#/components/schemas/orders_v2_resource_payment"
+ "on_behalf_of": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/account"
+ }
+ ],
+ "description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/account"
+ }
+ ]
+ }
+ },
+ "payment_method": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ ],
+ "description": "ID of the payment method used in this PaymentIntent.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ ]
+ }
},
- "shipping_cost": {
+ "payment_method_options": {
"anyOf": [
{
- "$ref": "#/components/schemas/orders_v2_resource_shipping_cost"
+ "$ref": "#/components/schemas/payment_intent_payment_method_options"
}
],
- "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate.",
+ "description": "Payment-method-specific configuration for this PaymentIntent.",
"nullable": true
},
- "shipping_details": {
+ "payment_method_types": {
+ "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "processing": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_processing"
+ }
+ ],
+ "description": "If present, this property tells you about the processing state of the payment.",
+ "nullable": true
+ },
+ "receipt_email": {
+ "description": "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).",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "review": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/review"
+ }
+ ],
+ "description": "ID of the review associated with this PaymentIntent, if any.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/review"
+ }
+ ]
+ }
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "off_session",
+ "on_session"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "shipping": {
"anyOf": [
{
- "$ref": "#/components/schemas/orders_v2_resource_shipping_details"
+ "$ref": "#/components/schemas/shipping"
}
],
- "description": "Customer shipping information associated with the order.",
+ "description": "Shipping information for this PaymentIntent.",
"nullable": true
},
+ "statement_descriptor": {
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "statement_descriptor_suffix": {
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"status": {
- "description": "The overall status of the order.",
+ "description": "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://stripe.com/docs/payments/intents#intent-statuses).",
"enum": [
"canceled",
- "complete",
- "open",
"processing",
- "submitted"
+ "requires_action",
+ "requires_capture",
+ "requires_confirmation",
+ "requires_payment_method",
+ "succeeded"
],
"type": "string"
},
- "tax_details": {
- "$ref": "#/components/schemas/orders_v2_resource_tax_details"
+ "transfer_data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/transfer_data"
+ }
+ ],
+ "description": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
+ "nullable": true
},
- "total_details": {
- "$ref": "#/components/schemas/orders_v2_resource_total_details"
+ "transfer_group": {
+ "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
- "amount_subtotal",
- "amount_total",
+ "amount",
+ "capture_method",
+ "confirmation_method",
"created",
"currency",
"id",
"livemode",
"object",
- "payment",
- "status",
- "total_details"
+ "payment_method_types",
+ "status"
],
- "title": "OrdersV2ResourceOrder",
+ "title": "PaymentIntent",
"type": "object",
"x-expandableFields": [
+ "amount_details",
"application",
- "automatic_tax",
- "billing_details",
- "client_permissions",
+ "automatic_payment_methods",
"customer",
- "discounts",
- "line_items",
- "payment",
- "shipping_cost",
- "shipping_details",
- "tax_details",
- "total_details"
+ "invoice",
+ "last_payment_error",
+ "latest_charge",
+ "next_action",
+ "on_behalf_of",
+ "payment_method",
+ "payment_method_options",
+ "processing",
+ "review",
+ "shipping",
+ "transfer_data"
],
- "x-resourceId": "order"
+ "x-resourceId": "payment_intent"
},
- "orders_payment_method_options_afterpay_clearpay": {
+ "payment_intent_card_processing": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "reference": {
- "description": "Order identifier shown to the user in Afterpay's online portal. We recommend using a value that helps you answer any questions a customer might have about the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
- "enum": [
- "none"
- ],
- "type": "string"
+ "customer_notification": {
+ "$ref": "#/components/schemas/payment_intent_processing_customer_notification"
}
},
- "title": "orders_payment_method_options_afterpay_clearpay",
+ "title": "PaymentIntentCardProcessing",
"type": "object",
"x-expandableFields": [
-
+ "customer_notification"
]
},
- "orders_v2_resource_automatic_payment_methods": {
+ "payment_intent_next_action": {
"description": "",
"properties": {
- "enabled": {
- "description": "Whether this Order has been opted into managing payment method types via the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
- "type": "boolean"
+ "alipay_handle_redirect": {
+ "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"
+ },
+ "boleto_display_details": {
+ "$ref": "#/components/schemas/payment_intent_next_action_boleto"
+ },
+ "card_await_notification": {
+ "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification"
+ },
+ "display_bank_transfer_instructions": {
+ "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"
+ },
+ "konbini_display_details": {
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini"
+ },
+ "oxxo_display_details": {
+ "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details"
+ },
+ "paynow_display_qr_code": {
+ "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"
+ },
+ "pix_display_qr_code": {
+ "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code"
+ },
+ "promptpay_display_qr_code": {
+ "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"
+ },
+ "redirect_to_url": {
+ "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
+ },
+ "type": {
+ "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "use_stripe_sdk": {
+ "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.",
+ "type": "object"
+ },
+ "verify_with_microdeposits": {
+ "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"
+ },
+ "wechat_pay_display_qr_code": {
+ "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"
+ },
+ "wechat_pay_redirect_to_android_app": {
+ "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"
+ },
+ "wechat_pay_redirect_to_ios_app": {
+ "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"
}
},
"required": [
- "enabled"
+ "type"
],
- "title": "OrdersV2ResourceAutomaticPaymentMethods",
+ "title": "PaymentIntentNextAction",
"type": "object",
"x-expandableFields": [
-
+ "alipay_handle_redirect",
+ "boleto_display_details",
+ "card_await_notification",
+ "display_bank_transfer_instructions",
+ "konbini_display_details",
+ "oxxo_display_details",
+ "paynow_display_qr_code",
+ "pix_display_qr_code",
+ "promptpay_display_qr_code",
+ "redirect_to_url",
+ "verify_with_microdeposits",
+ "wechat_pay_display_qr_code",
+ "wechat_pay_redirect_to_android_app",
+ "wechat_pay_redirect_to_ios_app"
]
},
- "orders_v2_resource_automatic_tax": {
+ "payment_intent_next_action_alipay_handle_redirect": {
"description": "",
"properties": {
- "enabled": {
- "description": "Whether Stripe automatically computes tax on this Order.",
- "type": "boolean"
+ "native_data": {
+ "description": "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.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "status": {
- "description": "The status of the most recent automated tax calculation for this Order.",
- "enum": [
- "complete",
- "failed",
- "requires_location_inputs"
- ],
+ "native_url": {
+ "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "return_url": {
+ "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL you must redirect your customer to in order to authenticate the payment.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "required": [
- "enabled"
- ],
- "title": "OrdersV2ResourceAutomaticTax",
+ "title": "PaymentIntentNextActionAlipayHandleRedirect",
"type": "object",
"x-expandableFields": [
]
},
- "orders_v2_resource_billing_details": {
+ "payment_intent_next_action_boleto": {
"description": "",
"properties": {
- "address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Billing address for the order.",
- "nullable": true
+ "expires_at": {
+ "description": "The timestamp after which the boleto expires.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
},
- "email": {
- "description": "Email address for the order.",
+ "hosted_voucher_url": {
+ "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "name": {
- "description": "Full name for the order.",
+ "number": {
+ "description": "The boleto number.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "phone": {
- "description": "Billing phone number for the order (including extension).",
+ "pdf": {
+ "description": "The URL to the downloadable boleto voucher PDF.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "OrdersV2ResourceBillingDetails",
+ "title": "payment_intent_next_action_boleto",
"type": "object",
"x-expandableFields": [
- "address"
+
]
},
- "orders_v2_resource_card_payment_method_options": {
+ "payment_intent_next_action_card_await_notification": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
+ "charge_attempt_at": {
+ "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with the payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the order's Customer, if present, after the order's PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
+ "customer_approval_required": {
+ "description": "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.",
+ "nullable": true,
+ "type": "boolean"
}
},
- "required": [
- "capture_method"
- ],
- "title": "OrdersV2ResourceCardPaymentMethodOptions",
+ "title": "PaymentIntentNextActionCardAwaitNotification",
"type": "object",
"x-expandableFields": [
]
},
- "orders_v2_resource_client_permissions": {
+ "payment_intent_next_action_display_bank_transfer_instructions": {
"description": "",
"properties": {
- "billing_details": {
- "description": "Allows or disallows billing details to be set on an Order with a publishable key and Order client_secret",
- "enum": [
- "allow",
- "disallow"
- ],
+ "amount_remaining": {
+ "description": "The remaining amount that needs to be transferred to complete the payment.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "currency": {
+ "description": "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).",
"nullable": true,
"type": "string"
},
- "promotion_codes": {
- "description": "Allows or disallows promotion codes to be set on an Order with a publishable key and Order client_secret",
- "enum": [
- "allow",
- "disallow"
- ],
+ "financial_addresses": {
+ "description": "A list of financial addresses that can be used to fund the customer balance",
+ "items": {
+ "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
+ },
+ "type": "array"
+ },
+ "hosted_instructions_url": {
+ "description": "A link to a hosted page that guides your customer through completing the transfer.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "shipping_details": {
- "description": "Allows or disallows shipping details to be set on an Order with a publishable key and Order client_secret",
- "enum": [
- "allow",
- "disallow"
- ],
+ "reference": {
+ "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "type": {
+ "description": "Type of bank transfer",
+ "enum": [
+ "eu_bank_transfer",
+ "gb_bank_transfer",
+ "jp_bank_transfer",
+ "mx_bank_transfer"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "OrdersV2ResourceClientPermissions",
+ "required": [
+ "type"
+ ],
+ "title": "PaymentIntentNextActionDisplayBankTransferInstructions",
"type": "object",
"x-expandableFields": [
-
+ "financial_addresses"
]
},
- "orders_v2_resource_payment": {
+ "payment_intent_next_action_display_oxxo_details": {
"description": "",
"properties": {
- "payment_intent": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/payment_intent"
- }
- ],
- "description": "ID of the payment intent associated with this order. Null when the order is `open`.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/payment_intent"
- }
- ]
- }
- },
- "settings": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/orders_v2_resource_payment_settings"
- }
- ],
- "description": "Settings describing how the order should configure generated PaymentIntents.",
- "nullable": true
- },
- "status": {
- "description": "The status of the underlying payment associated with this order, if any. Null when the order is `open`.",
- "enum": [
- "canceled",
- "complete",
- "not_required",
- "processing",
- "requires_action",
- "requires_capture",
- "requires_confirmation",
- "requires_payment_method"
- ],
- "nullable": true,
- "type": "string"
- }
- },
- "title": "OrdersV2ResourcePayment",
- "type": "object",
- "x-expandableFields": [
- "payment_intent",
- "settings"
- ]
- },
- "orders_v2_resource_payment_method_options": {
- "description": "",
- "properties": {
- "acss_debit": {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
- },
- "afterpay_clearpay": {
- "$ref": "#/components/schemas/orders_payment_method_options_afterpay_clearpay"
- },
- "alipay": {
- "$ref": "#/components/schemas/payment_method_options_alipay"
- },
- "bancontact": {
- "$ref": "#/components/schemas/payment_method_options_bancontact"
- },
- "card": {
- "$ref": "#/components/schemas/orders_v2_resource_card_payment_method_options"
- },
- "customer_balance": {
- "$ref": "#/components/schemas/payment_method_options_customer_balance"
- },
- "ideal": {
- "$ref": "#/components/schemas/payment_method_options_ideal"
- },
- "klarna": {
- "$ref": "#/components/schemas/payment_method_options_klarna"
- },
- "link": {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
- },
- "oxxo": {
- "$ref": "#/components/schemas/payment_method_options_oxxo"
- },
- "p24": {
- "$ref": "#/components/schemas/payment_method_options_p24"
- },
- "paypal": {
- "$ref": "#/components/schemas/payment_method_options_paypal"
- },
- "sepa_debit": {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
- },
- "sofort": {
- "$ref": "#/components/schemas/payment_method_options_sofort"
- },
- "wechat_pay": {
- "$ref": "#/components/schemas/payment_method_options_wechat_pay"
- }
- },
- "title": "OrdersV2ResourcePaymentMethodOptions",
- "type": "object",
- "x-expandableFields": [
- "acss_debit",
- "afterpay_clearpay",
- "alipay",
- "bancontact",
- "card",
- "customer_balance",
- "ideal",
- "klarna",
- "link",
- "oxxo",
- "p24",
- "paypal",
- "sepa_debit",
- "sofort",
- "wechat_pay"
- ]
- },
- "orders_v2_resource_payment_settings": {
- "description": "",
- "properties": {
- "application_fee_amount": {
- "description": "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.",
+ "expires_after": {
+ "description": "The timestamp after which the OXXO voucher expires.",
+ "format": "unix-time",
"nullable": true,
"type": "integer"
},
- "automatic_payment_methods": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/orders_v2_resource_automatic_payment_methods"
- }
- ],
- "description": "Indicates whether order has been opted into using [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) to manage payment method types.",
- "nullable": true
- },
- "payment_method_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/orders_v2_resource_payment_method_options"
- }
- ],
- "description": "PaymentMethod-specific configuration to provide to the order's PaymentIntent.",
- "nullable": true
- },
- "payment_method_types": {
- "description": "The list of [payment method types](https://stripe.com/docs/payments/payment-methods/overview) to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
- "items": {
- "enum": [
- "acss_debit",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "card",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "klarna",
- "link",
- "oxxo",
- "p24",
- "sepa_debit",
- "sofort",
- "wechat_pay"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "nullable": true,
- "type": "array"
- },
- "return_url": {
- "description": "The URL to redirect the customer to after they authenticate their payment.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "statement_descriptor": {
- "description": "For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.",
+ "hosted_voucher_url": {
+ "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "statement_descriptor_suffix": {
- "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
+ "number": {
+ "description": "OXXO reference number.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- },
- "transfer_data": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/orders_v2_resource_transfer_data"
- }
- ],
- "description": "Provides configuration for completing a transfer for the order after it is paid.",
- "nullable": true
}
},
- "title": "OrdersV2ResourcePaymentSettings",
+ "title": "PaymentIntentNextActionDisplayOxxoDetails",
"type": "object",
"x-expandableFields": [
- "automatic_payment_methods",
- "payment_method_options",
- "transfer_data"
+
]
},
- "orders_v2_resource_shipping_cost": {
+ "payment_intent_next_action_konbini": {
"description": "",
"properties": {
- "amount_subtotal": {
- "description": "Total shipping cost before any discounts or taxes are applied.",
- "type": "integer"
- },
- "amount_tax": {
- "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.",
- "type": "integer"
- },
- "amount_total": {
- "description": "Total shipping cost after discounts and taxes are applied.",
+ "expires_at": {
+ "description": "The timestamp at which the pending Konbini payment expires.",
+ "format": "unix-time",
"type": "integer"
},
- "shipping_rate": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/shipping_rate"
- }
- ],
- "description": "The ID of the ShippingRate for this order.",
+ "hosted_voucher_url": {
+ "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.",
+ "maxLength": 5000,
"nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/shipping_rate"
- }
- ]
- }
+ "type": "string"
},
- "taxes": {
- "description": "The taxes applied to the shipping rate.",
- "items": {
- "$ref": "#/components/schemas/line_items_tax_amount"
- },
- "type": "array"
+ "stores": {
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores"
}
},
"required": [
- "amount_subtotal",
- "amount_tax",
- "amount_total"
+ "expires_at",
+ "stores"
],
- "title": "OrdersV2ResourceShippingCost",
+ "title": "payment_intent_next_action_konbini",
"type": "object",
"x-expandableFields": [
- "shipping_rate",
- "taxes"
+ "stores"
]
},
- "orders_v2_resource_shipping_details": {
+ "payment_intent_next_action_konbini_familymart": {
"description": "",
"properties": {
- "address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Recipient shipping address. Required if the order includes products that are shippable.",
- "nullable": true
- },
- "name": {
- "description": "Recipient name.",
+ "confirmation_number": {
+ "description": "The confirmation number.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "phone": {
- "description": "Recipient phone (including extension).",
+ "payment_code": {
+ "description": "The payment code.",
"maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "title": "OrdersV2ResourceShippingDetails",
- "type": "object",
- "x-expandableFields": [
- "address"
- ]
- },
- "orders_v2_resource_tax_details": {
- "description": "",
- "properties": {
- "tax_exempt": {
- "description": "Describes the purchaser's tax exemption status. One of `none`, `exempt`, or `reverse`.",
- "enum": [
- "exempt",
- "none",
- "reverse"
- ],
"type": "string"
- },
- "tax_ids": {
- "description": "The purchaser's tax IDs to be used in calculation of tax for this Order.",
- "items": {
- "$ref": "#/components/schemas/orders_v2_resource_tax_details_resource_tax_id"
- },
- "type": "array"
}
},
"required": [
- "tax_exempt",
- "tax_ids"
+ "payment_code"
],
- "title": "OrdersV2ResourceTaxDetails",
+ "title": "payment_intent_next_action_konbini_familymart",
"type": "object",
"x-expandableFields": [
- "tax_ids"
+
]
},
- "orders_v2_resource_tax_details_resource_tax_id": {
+ "payment_intent_next_action_konbini_lawson": {
"description": "",
"properties": {
- "type": {
- "description": "The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `eu_oss_vat`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, or `unknown`",
- "enum": [
- "ae_trn",
- "au_abn",
- "au_arn",
- "bg_uic",
- "br_cnpj",
- "br_cpf",
- "ca_bn",
- "ca_gst_hst",
- "ca_pst_bc",
- "ca_pst_mb",
- "ca_pst_sk",
- "ca_qst",
- "ch_vat",
- "cl_tin",
- "eg_tin",
- "es_cif",
- "eu_oss_vat",
- "eu_vat",
- "gb_vat",
- "ge_vat",
- "hk_br",
- "hu_tin",
- "id_npwp",
- "il_vat",
- "in_gst",
- "is_vat",
- "jp_cn",
- "jp_rn",
- "jp_trn",
- "ke_pin",
- "kr_brn",
- "li_uid",
- "mx_rfc",
- "my_frp",
- "my_itn",
- "my_sst",
- "no_vat",
- "nz_gst",
- "ph_tin",
- "ru_inn",
- "ru_kpp",
- "sa_vat",
- "sg_gst",
- "sg_uen",
- "si_tin",
- "th_vat",
- "tr_tin",
- "tw_vat",
- "ua_vat",
- "unknown",
- "us_ein",
- "za_vat"
- ],
+ "confirmation_number": {
+ "description": "The confirmation number.",
+ "maxLength": 5000,
"type": "string"
},
- "value": {
- "description": "The value of the tax ID.",
+ "payment_code": {
+ "description": "The payment code.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
"required": [
- "type"
+ "payment_code"
],
- "title": "OrdersV2ResourceTaxDetailsResourceTaxID",
+ "title": "payment_intent_next_action_konbini_lawson",
"type": "object",
"x-expandableFields": [
]
},
- "orders_v2_resource_total_details": {
+ "payment_intent_next_action_konbini_ministop": {
"description": "",
"properties": {
- "amount_discount": {
- "description": "This is the sum of all the discounts.",
- "type": "integer"
- },
- "amount_shipping": {
- "description": "This is the sum of all the shipping amounts.",
- "nullable": true,
- "type": "integer"
- },
- "amount_tax": {
- "description": "This is the sum of all the tax amounts.",
- "type": "integer"
+ "confirmation_number": {
+ "description": "The confirmation number.",
+ "maxLength": 5000,
+ "type": "string"
},
- "breakdown": {
- "$ref": "#/components/schemas/orders_v2_resource_total_details_api_resource_breakdown"
+ "payment_code": {
+ "description": "The payment code.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
- "amount_discount",
- "amount_tax"
+ "payment_code"
],
- "title": "OrdersV2ResourceTotalDetails",
+ "title": "payment_intent_next_action_konbini_ministop",
"type": "object",
"x-expandableFields": [
- "breakdown"
+
]
},
- "orders_v2_resource_total_details_api_resource_breakdown": {
+ "payment_intent_next_action_konbini_seicomart": {
"description": "",
"properties": {
- "discounts": {
- "description": "The aggregated discounts.",
- "items": {
- "$ref": "#/components/schemas/line_items_discount_amount"
- },
- "type": "array"
+ "confirmation_number": {
+ "description": "The confirmation number.",
+ "maxLength": 5000,
+ "type": "string"
},
- "taxes": {
- "description": "The aggregated tax amounts by rate.",
- "items": {
- "$ref": "#/components/schemas/line_items_tax_amount"
- },
- "type": "array"
+ "payment_code": {
+ "description": "The payment code.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
- "discounts",
- "taxes"
+ "payment_code"
],
- "title": "OrdersV2ResourceTotalDetailsAPIResourceBreakdown",
+ "title": "payment_intent_next_action_konbini_seicomart",
"type": "object",
"x-expandableFields": [
- "discounts",
- "taxes"
+
]
},
- "orders_v2_resource_transfer_data": {
+ "payment_intent_next_action_konbini_stores": {
"description": "",
"properties": {
- "amount": {
- "description": "The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.",
- "nullable": true,
- "type": "integer"
+ "familymart": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart"
+ }
+ ],
+ "description": "FamilyMart instruction details.",
+ "nullable": true
},
- "destination": {
+ "lawson": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
- },
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson"
+ }
+ ],
+ "description": "Lawson instruction details.",
+ "nullable": true
+ },
+ "ministop": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/account"
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop"
}
],
- "description": "ID of the Connected account receiving the transfer.",
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/account"
- }
- ]
- }
+ "description": "Ministop instruction details.",
+ "nullable": true
+ },
+ "seicomart": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart"
+ }
+ ],
+ "description": "Seicomart instruction details.",
+ "nullable": true
}
},
- "required": [
- "destination"
- ],
- "title": "OrdersV2ResourceTransferData",
+ "title": "payment_intent_next_action_konbini_stores",
"type": "object",
"x-expandableFields": [
- "destination"
+ "familymart",
+ "lawson",
+ "ministop",
+ "seicomart"
]
},
- "outbound_payments_payment_method_details": {
+ "payment_intent_next_action_paynow_display_qr_code": {
"description": "",
"properties": {
- "billing_details": {
- "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
- },
- "financial_account": {
- "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account"
+ "data": {
+ "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
+ "maxLength": 5000,
+ "type": "string"
},
- "type": {
- "description": "The type of the payment method used in the OutboundPayment.",
- "enum": [
- "financial_account",
- "us_bank_account"
- ],
+ "image_url_png": {
+ "description": "The image_url_png string used to render QR code",
+ "maxLength": 5000,
"type": "string"
},
- "us_bank_account": {
- "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"
+ "image_url_svg": {
+ "description": "The image_url_svg string used to render QR code",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
- "billing_details",
- "type"
+ "data",
+ "image_url_png",
+ "image_url_svg"
],
- "title": "OutboundPaymentsPaymentMethodDetails",
+ "title": "PaymentIntentNextActionPaynowDisplayQrCode",
"type": "object",
"x-expandableFields": [
- "billing_details",
- "financial_account",
- "us_bank_account"
+
]
},
- "outbound_payments_payment_method_details_financial_account": {
+ "payment_intent_next_action_pix_display_qr_code": {
"description": "",
"properties": {
- "id": {
- "description": "Token of the FinancialAccount.",
+ "data": {
+ "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
"maxLength": 5000,
"type": "string"
},
- "network": {
- "description": "The rails used to send funds.",
- "enum": [
- "stripe"
- ],
+ "expires_at": {
+ "description": "The date (unix timestamp) when the PIX expires.",
+ "type": "integer"
+ },
+ "hosted_instructions_url": {
+ "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "image_url_png": {
+ "description": "The image_url_png string used to render png QR code",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "image_url_svg": {
+ "description": "The image_url_svg string used to render svg QR code",
+ "maxLength": 5000,
"type": "string"
}
},
- "required": [
- "id",
- "network"
- ],
- "title": "outbound_payments_payment_method_details_financial_account",
+ "title": "PaymentIntentNextActionPixDisplayQrCode",
"type": "object",
"x-expandableFields": [
]
},
- "outbound_payments_payment_method_details_us_bank_account": {
+ "payment_intent_next_action_promptpay_display_qr_code": {
"description": "",
"properties": {
- "account_holder_type": {
- "description": "Account holder type: individual or company.",
- "enum": [
- "company",
- "individual"
- ],
- "nullable": true,
- "type": "string"
- },
- "account_type": {
- "description": "Account type: checkings or savings. Defaults to checking if omitted.",
- "enum": [
- "checking",
- "savings"
- ],
- "nullable": true,
- "type": "string"
- },
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
+ "data": {
+ "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "hosted_instructions_url": {
+ "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "image_url_png": {
+ "description": "The image_url_png string used to render QR code, can be used as ![](\"…\")
",
"maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "network": {
- "description": "The US bank account network used to send funds.",
- "enum": [
- "ach",
- "us_domestic_wire"
- ],
"type": "string"
},
- "routing_number": {
- "description": "Routing number of the bank account.",
+ "image_url_svg": {
+ "description": "The image_url_svg string used to render QR code, can be used as ",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
"required": [
- "network"
+ "data",
+ "hosted_instructions_url",
+ "image_url_png",
+ "image_url_svg"
],
- "title": "outbound_payments_payment_method_details_us_bank_account",
+ "title": "PaymentIntentNextActionPromptpayDisplayQrCode",
"type": "object",
"x-expandableFields": [
]
},
- "outbound_transfers_payment_method_details": {
+ "payment_intent_next_action_redirect_to_url": {
"description": "",
"properties": {
- "billing_details": {
- "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
- },
- "type": {
- "description": "The type of the payment method used in the OutboundTransfer.",
- "enum": [
- "us_bank_account"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
+ "return_url": {
+ "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "us_bank_account": {
- "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"
+ "url": {
+ "description": "The URL you must redirect your customer to in order to authenticate the payment.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "required": [
- "billing_details",
- "type"
- ],
- "title": "OutboundTransfersPaymentMethodDetails",
+ "title": "PaymentIntentNextActionRedirectToUrl",
"type": "object",
"x-expandableFields": [
- "billing_details",
- "us_bank_account"
+
]
},
- "outbound_transfers_payment_method_details_us_bank_account": {
+ "payment_intent_next_action_verify_with_microdeposits": {
"description": "",
"properties": {
- "account_holder_type": {
- "description": "Account holder type: individual or company.",
- "enum": [
- "company",
- "individual"
- ],
- "nullable": true,
- "type": "string"
- },
- "account_type": {
- "description": "Account type: checkings or savings. Defaults to checking if omitted.",
- "enum": [
- "checking",
- "savings"
- ],
- "nullable": true,
- "type": "string"
- },
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "arrival_date": {
+ "description": "The timestamp when the microdeposits are expected to land.",
+ "format": "unix-time",
+ "type": "integer"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "hosted_verification_url": {
+ "description": "The URL for the hosted verification page, which allows customers to verify their bank account.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "network": {
- "description": "The US bank account network used to send funds.",
+ "microdeposit_type": {
+ "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.",
"enum": [
- "ach",
- "us_domestic_wire"
+ "amounts",
+ "descriptor_code"
],
- "type": "string"
- },
- "routing_number": {
- "description": "Routing number of the bank account.",
- "maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"required": [
- "network"
+ "arrival_date",
+ "hosted_verification_url"
],
- "title": "outbound_transfers_payment_method_details_us_bank_account",
+ "title": "PaymentIntentNextActionVerifyWithMicrodeposits",
"type": "object",
"x-expandableFields": [
]
},
- "package_dimensions": {
+ "payment_intent_next_action_wechat_pay_display_qr_code": {
"description": "",
"properties": {
- "height": {
- "description": "Height, in inches.",
- "type": "number"
+ "data": {
+ "description": "The data being used to generate QR code",
+ "maxLength": 5000,
+ "type": "string"
},
- "length": {
- "description": "Length, in inches.",
- "type": "number"
+ "image_data_url": {
+ "description": "The base64 image data for a pre-generated QR code",
+ "maxLength": 5000,
+ "type": "string"
},
- "weight": {
- "description": "Weight, in ounces.",
- "type": "number"
+ "image_url_png": {
+ "description": "The image_url_png string used to render QR code",
+ "maxLength": 5000,
+ "type": "string"
},
- "width": {
- "description": "Width, in inches.",
- "type": "number"
- }
- },
- "required": [
- "height",
- "length",
- "weight",
- "width"
- ],
- "title": "PackageDimensions",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_flows_amount_details": {
- "description": "",
- "properties": {
- "tip": {
- "$ref": "#/components/schemas/payment_flows_amount_details_resource_tip"
- }
- },
- "title": "PaymentFlowsAmountDetails",
- "type": "object",
- "x-expandableFields": [
- "tip"
- ]
- },
- "payment_flows_amount_details_resource_tip": {
- "description": "",
- "properties": {
- "amount": {
- "description": "Portion of the amount that corresponds to a tip.",
- "type": "integer"
- }
- },
- "title": "PaymentFlowsAmountDetailsResourceTip",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_flows_automatic_payment_methods_payment_intent": {
- "description": "",
- "properties": {
- "enabled": {
- "description": "Automatically calculates compatible payment methods",
- "type": "boolean"
+ "image_url_svg": {
+ "description": "The image_url_svg string used to render QR code",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
- "enabled"
+ "data",
+ "image_data_url",
+ "image_url_png",
+ "image_url_svg"
],
- "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
+ "title": "PaymentIntentNextActionWechatPayDisplayQrCode",
"type": "object",
"x-expandableFields": [
]
},
- "payment_flows_installment_options": {
+ "payment_intent_next_action_wechat_pay_redirect_to_android_app": {
"description": "",
"properties": {
- "enabled": {
- "type": "boolean"
+ "app_id": {
+ "description": "app_id is the APP ID registered on WeChat open platform",
+ "maxLength": 5000,
+ "type": "string"
},
- "plan": {
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
- }
- },
- "required": [
- "enabled"
- ],
- "title": "PaymentFlowsInstallmentOptions",
- "type": "object",
- "x-expandableFields": [
- "plan"
- ]
- },
- "payment_flows_private_payment_methods_alipay": {
- "description": "",
- "properties": {
- },
- "title": "PaymentFlowsPrivatePaymentMethodsAlipay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_flows_private_payment_methods_alipay_details": {
- "description": "",
- "properties": {
- "buyer_id": {
- "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
+ "nonce_str": {
+ "description": "nonce_str is a random string",
"maxLength": 5000,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.",
+ "package": {
+ "description": "package is static value",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "transaction_id": {
- "description": "Transaction ID of this particular Alipay transaction.",
+ "partner_id": {
+ "description": "an unique merchant ID assigned by WeChat Pay",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "prepay_id": {
+ "description": "an unique trading ID assigned by WeChat Pay",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "sign": {
+ "description": "A signature",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Specifies the current time in epoch format",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
- "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
+ "required": [
+ "app_id",
+ "nonce_str",
+ "package",
+ "partner_id",
+ "prepay_id",
+ "sign",
+ "timestamp"
+ ],
+ "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
"type": "object",
"x-expandableFields": [
]
},
- "payment_flows_private_payment_methods_klarna_dob": {
+ "payment_intent_next_action_wechat_pay_redirect_to_ios_app": {
"description": "",
"properties": {
- "day": {
- "description": "The day of birth, between 1 and 31.",
- "nullable": true,
- "type": "integer"
- },
- "month": {
- "description": "The month of birth, between 1 and 12.",
- "nullable": true,
- "type": "integer"
- },
- "year": {
- "description": "The four-digit year of birth.",
- "nullable": true,
- "type": "integer"
+ "native_url": {
+ "description": "An universal link that redirect to WeChat Pay app",
+ "maxLength": 5000,
+ "type": "string"
}
},
- "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
+ "required": [
+ "native_url"
+ ],
+ "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent": {
- "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).",
+ "payment_intent_payment_method_options": {
+ "description": "",
"properties": {
- "amount": {
- "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/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://stripe.com/docs/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).",
- "type": "integer"
- },
- "amount_capturable": {
- "description": "Amount that can be captured from this PaymentIntent.",
- "type": "integer"
- },
- "amount_details": {
- "$ref": "#/components/schemas/payment_flows_amount_details"
- },
- "amount_received": {
- "description": "Amount that was collected by this PaymentIntent.",
- "type": "integer"
- },
- "application": {
+ "acss_debit": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
},
{
- "$ref": "#/components/schemas/application"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "ID of the Connect application that created the PaymentIntent.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/application"
- }
- ]
- }
- },
- "application_fee_amount": {
- "description": "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 payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
- "nullable": true,
- "type": "integer"
+ ]
},
- "automatic_payment_methods": {
+ "affirm": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"
+ "$ref": "#/components/schemas/payment_method_options_affirm"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)",
- "nullable": true
- },
- "canceled_at": {
- "description": "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",
- "nullable": true,
- "type": "integer"
- },
- "cancellation_reason": {
- "description": "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`, or `automatic`).",
- "enum": [
- "abandoned",
- "automatic",
- "duplicate",
- "failed_invoice",
- "fraudulent",
- "requested_by_customer",
- "void_invoice"
- ],
- "nullable": true,
- "type": "string"
- },
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
+ ]
},
- "charges": {
- "description": "Charges that were created by this PaymentIntent, if any.",
- "properties": {
- "data": {
- "description": "This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent).",
- "items": {
- "$ref": "#/components/schemas/charge"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
+ "afterpay_clearpay": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
},
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "PaymentFlowsPaymentIntentResourceChargeList",
- "type": "object",
- "x-expandableFields": [
- "data"
]
},
- "client_secret": {
- "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe 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.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "confirmation_method": {
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "created": {
- "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
- "format": "unix-time",
- "type": "integer"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "customer": {
+ "alipay": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_method_options_alipay"
},
{
- "$ref": "#/components/schemas/customer"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "au_becs_debit": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
},
{
- "$ref": "#/components/schemas/deleted_customer"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/customer"
- },
- {
- "$ref": "#/components/schemas/deleted_customer"
- }
- ]
- }
- },
- "description": {
- "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the object.",
- "maxLength": 5000,
- "type": "string"
+ ]
},
- "invoice": {
+ "bacs_debit": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_method_options_bacs_debit"
},
{
- "$ref": "#/components/schemas/invoice"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "ID of the invoice that created this PaymentIntent, if it exists.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/invoice"
- }
- ]
- }
+ ]
},
- "last_payment_error": {
+ "bancontact": {
"anyOf": [
{
- "$ref": "#/components/schemas/api_errors"
+ "$ref": "#/components/schemas/payment_method_options_bancontact"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.",
- "nullable": true
+ ]
},
- "livemode": {
- "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
- "type": "boolean"
+ "blik": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "metadata": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
- "type": "object"
+ "boleto": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_boleto"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "next_action": {
+ "card": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_intent_next_action"
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "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.",
- "nullable": true
+ ]
},
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value.",
- "enum": [
- "payment_intent"
- ],
- "type": "string"
+ "card_present": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_card_present"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "on_behalf_of": {
+ "customer_balance": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_method_options_customer_balance"
},
{
- "$ref": "#/components/schemas/account"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/account"
- }
- ]
- }
+ ]
},
- "payment_method": {
+ "eps": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
},
{
- "$ref": "#/components/schemas/payment_method"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "ID of the payment method used in this PaymentIntent.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/payment_method"
- }
- ]
- }
+ ]
},
- "payment_method_options": {
+ "fpx": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_intent_payment_method_options"
+ "$ref": "#/components/schemas/payment_method_options_fpx"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "Payment-method-specific configuration for this PaymentIntent.",
- "nullable": true
+ ]
},
- "payment_method_types": {
- "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
+ "giropay": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_giropay"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "processing": {
+ "grabpay": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_intent_processing"
+ "$ref": "#/components/schemas/payment_method_options_grabpay"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "If present, this property tells you about the processing state of the payment.",
- "nullable": true
+ ]
},
- "receipt_email": {
- "description": "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).",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "ideal": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_ideal"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "review": {
+ "interac_present": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
+ "$ref": "#/components/schemas/payment_method_options_interac_present"
},
{
- "$ref": "#/components/schemas/review"
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "ID of the review associated with this PaymentIntent, if any.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/review"
- }
- ]
- }
+ ]
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "off_session",
- "on_session"
- ],
- "nullable": true,
- "type": "string"
+ "klarna": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_klarna"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "shipping": {
+ "konbini": {
"anyOf": [
{
- "$ref": "#/components/schemas/shipping"
+ "$ref": "#/components/schemas/payment_method_options_konbini"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "Shipping information for this PaymentIntent.",
- "nullable": true
+ ]
},
- "statement_descriptor": {
- "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "link": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "statement_descriptor_suffix": {
- "description": "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "oxxo": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_oxxo"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "status": {
- "description": "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://stripe.com/docs/payments/intents#intent-statuses).",
- "enum": [
- "canceled",
- "processing",
- "requires_action",
- "requires_capture",
- "requires_confirmation",
- "requires_payment_method",
- "succeeded"
- ],
- "type": "string"
+ "p24": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_p24"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
},
- "transfer_data": {
+ "paynow": {
"anyOf": [
{
- "$ref": "#/components/schemas/transfer_data"
+ "$ref": "#/components/schemas/payment_method_options_paynow"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
- ],
- "description": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
- "nullable": true
+ ]
},
- "transfer_group": {
- "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "pix": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_pix"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "promptpay": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_promptpay"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "sepa_debit": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "sofort": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_sofort"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "us_bank_account": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
+ },
+ "wechat_pay": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_wechat_pay"
+ },
+ {
+ "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ }
+ ]
}
},
- "required": [
- "amount",
- "capture_method",
- "confirmation_method",
- "created",
- "currency",
- "id",
- "livemode",
- "object",
- "payment_method_types",
- "status"
- ],
- "title": "PaymentIntent",
+ "title": "PaymentIntentPaymentMethodOptions",
"type": "object",
"x-expandableFields": [
- "amount_details",
- "application",
- "automatic_payment_methods",
- "charges",
- "customer",
- "invoice",
- "last_payment_error",
- "next_action",
- "on_behalf_of",
- "payment_method",
- "payment_method_options",
- "processing",
- "review",
- "shipping",
- "transfer_data"
- ],
- "x-resourceId": "payment_intent"
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "card_present",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "interac_present",
+ "klarna",
+ "konbini",
+ "link",
+ "oxxo",
+ "p24",
+ "paynow",
+ "pix",
+ "promptpay",
+ "sepa_debit",
+ "sofort",
+ "us_bank_account",
+ "wechat_pay"
+ ]
},
- "payment_intent_card_processing": {
+ "payment_intent_payment_method_options_acss_debit": {
"description": "",
"properties": {
- "customer_notification": {
- "$ref": "#/components/schemas/payment_intent_processing_customer_notification"
+ "mandate_options": {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
+ "type": "string"
+ },
+ "verification_method": {
+ "description": "Bank account verification method.",
+ "enum": [
+ "automatic",
+ "instant",
+ "microdeposits"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "PaymentIntentCardProcessing",
+ "title": "payment_intent_payment_method_options_acss_debit",
"type": "object",
"x-expandableFields": [
- "customer_notification"
+ "mandate_options"
]
},
- "payment_intent_next_action": {
+ "payment_intent_payment_method_options_au_becs_debit": {
"description": "",
"properties": {
- "alipay_handle_redirect": {
- "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"
- },
- "boleto_display_details": {
- "$ref": "#/components/schemas/payment_intent_next_action_boleto"
- },
- "card_await_notification": {
- "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification"
- },
- "display_bank_transfer_instructions": {
- "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"
- },
- "konbini_display_details": {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini"
- },
- "oxxo_display_details": {
- "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details"
- },
- "paynow_display_qr_code": {
- "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"
- },
- "pix_display_qr_code": {
- "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code"
- },
- "promptpay_display_qr_code": {
- "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"
- },
- "redirect_to_url": {
- "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
- },
- "type": {
- "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.",
- "maxLength": 5000,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
"type": "string"
- },
- "use_stripe_sdk": {
- "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.",
- "type": "object"
- },
- "verify_with_microdeposits": {
- "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"
- },
- "wechat_pay_display_qr_code": {
- "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"
- },
- "wechat_pay_redirect_to_android_app": {
- "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"
- },
- "wechat_pay_redirect_to_ios_app": {
- "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"
}
},
- "required": [
- "type"
- ],
- "title": "PaymentIntentNextAction",
+ "title": "payment_intent_payment_method_options_au_becs_debit",
"type": "object",
"x-expandableFields": [
- "alipay_handle_redirect",
- "boleto_display_details",
- "card_await_notification",
- "display_bank_transfer_instructions",
- "konbini_display_details",
- "oxxo_display_details",
- "paynow_display_qr_code",
- "pix_display_qr_code",
- "promptpay_display_qr_code",
- "redirect_to_url",
- "verify_with_microdeposits",
- "wechat_pay_display_qr_code",
- "wechat_pay_redirect_to_android_app",
- "wechat_pay_redirect_to_ios_app"
+
]
},
- "payment_intent_next_action_alipay_handle_redirect": {
+ "payment_intent_payment_method_options_blik": {
"description": "",
"properties": {
- "native_data": {
- "description": "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.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "native_url": {
- "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "return_url": {
- "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "url": {
- "description": "The URL you must redirect your customer to in order to authenticate the payment.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
},
- "title": "PaymentIntentNextActionAlipayHandleRedirect",
+ "title": "payment_intent_payment_method_options_blik",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_boleto": {
+ "payment_intent_payment_method_options_card": {
"description": "",
"properties": {
- "expires_at": {
- "description": "The timestamp after which the boleto expires.",
- "format": "unix-time",
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
+ ],
+ "type": "string"
+ },
+ "installments": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_card_installments"
+ }
+ ],
+ "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
+ "nullable": true
+ },
+ "mandate_options": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_options_card_mandate_options"
+ }
+ ],
+ "description": "Configuration options for setting up an eMandate for cards issued in India.",
+ "nullable": true
+ },
+ "network": {
+ "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.",
+ "enum": [
+ "amex",
+ "cartes_bancaires",
+ "diners",
+ "discover",
+ "interac",
+ "jcb",
+ "mastercard",
+ "unionpay",
+ "unknown",
+ "visa"
+ ],
"nullable": true,
- "type": "integer"
+ "type": "string"
},
- "hosted_voucher_url": {
- "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.",
- "maxLength": 5000,
+ "request_three_d_secure": {
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
+ "enum": [
+ "any",
+ "automatic",
+ "challenge_only"
+ ],
"nullable": true,
"type": "string"
},
- "number": {
- "description": "The boleto number.",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
+ "type": "string"
+ },
+ "statement_descriptor_suffix_kana": {
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
},
- "pdf": {
- "description": "The URL to the downloadable boleto voucher PDF.",
+ "statement_descriptor_suffix_kanji": {
+ "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
- "title": "payment_intent_next_action_boleto",
+ "title": "payment_intent_payment_method_options_card",
"type": "object",
"x-expandableFields": [
-
+ "installments",
+ "mandate_options"
]
},
- "payment_intent_next_action_card_await_notification": {
+ "payment_intent_payment_method_options_eps": {
"description": "",
"properties": {
- "charge_attempt_at": {
- "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "customer_approval_required": {
- "description": "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.",
- "nullable": true,
- "type": "boolean"
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
+ "type": "string"
}
},
- "title": "PaymentIntentNextActionCardAwaitNotification",
+ "title": "payment_intent_payment_method_options_eps",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_display_bank_transfer_instructions": {
+ "payment_intent_payment_method_options_link": {
"description": "",
"properties": {
- "amount_remaining": {
- "description": "The remaining amount that needs to be transferred to complete the payment.",
- "nullable": true,
- "type": "integer"
- },
- "currency": {
- "description": "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).",
- "nullable": true,
- "type": "string"
- },
- "financial_addresses": {
- "description": "A list of financial addresses that can be used to fund the customer balance",
- "items": {
- "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
- },
- "type": "array"
- },
- "hosted_instructions_url": {
- "description": "A link to a hosted page that guides your customer through completing the transfer.",
- "maxLength": 5000,
- "nullable": true,
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
+ ],
"type": "string"
},
- "reference": {
- "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.",
+ "persistent_token": {
+ "description": "Token used for persistent Link logins.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "type": {
- "description": "Type of bank transfer",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "eu_bank_transfer",
- "gb_bank_transfer",
- "jp_bank_transfer",
- "mx_bank_transfer"
+ "none",
+ "off_session"
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
}
},
- "required": [
- "type"
- ],
- "title": "PaymentIntentNextActionDisplayBankTransferInstructions",
+ "title": "payment_intent_payment_method_options_link",
"type": "object",
"x-expandableFields": [
- "financial_addresses"
+
]
},
- "payment_intent_next_action_display_oxxo_details": {
+ "payment_intent_payment_method_options_mandate_options_acss_debit": {
"description": "",
"properties": {
- "expires_after": {
- "description": "The timestamp after which the OXXO voucher expires.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
+ "custom_mandate_url": {
+ "description": "A URL for custom mandate text",
+ "maxLength": 5000,
+ "type": "string"
},
- "hosted_voucher_url": {
- "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.",
+ "interval_description": {
+ "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "number": {
- "description": "OXXO reference number.",
- "maxLength": 5000,
+ "payment_schedule": {
+ "description": "Payment schedule for the mandate.",
+ "enum": [
+ "combined",
+ "interval",
+ "sporadic"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "transaction_type": {
+ "description": "Transaction type of the mandate.",
+ "enum": [
+ "business",
+ "personal"
+ ],
"nullable": true,
"type": "string"
}
},
- "title": "PaymentIntentNextActionDisplayOxxoDetails",
+ "title": "payment_intent_payment_method_options_mandate_options_acss_debit",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_konbini": {
+ "payment_intent_payment_method_options_mandate_options_sepa_debit": {
"description": "",
"properties": {
- "expires_at": {
- "description": "The timestamp at which the pending Konbini payment expires.",
- "format": "unix-time",
- "type": "integer"
- },
- "hosted_voucher_url": {
- "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "stores": {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores"
- }
},
- "required": [
- "expires_at",
- "stores"
- ],
- "title": "payment_intent_next_action_konbini",
+ "title": "payment_intent_payment_method_options_mandate_options_sepa_debit",
"type": "object",
"x-expandableFields": [
- "stores"
+
]
},
- "payment_intent_next_action_konbini_familymart": {
+ "payment_intent_payment_method_options_sepa_debit": {
"description": "",
"properties": {
- "confirmation_number": {
- "description": "The confirmation number.",
- "maxLength": 5000,
- "type": "string"
+ "mandate_options": {
+ "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"
},
- "payment_code": {
- "description": "The payment code.",
- "maxLength": 5000,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
"type": "string"
}
},
- "required": [
- "payment_code"
- ],
- "title": "payment_intent_next_action_konbini_familymart",
+ "title": "payment_intent_payment_method_options_sepa_debit",
"type": "object",
"x-expandableFields": [
-
+ "mandate_options"
]
},
- "payment_intent_next_action_konbini_lawson": {
+ "payment_intent_payment_method_options_us_bank_account": {
"description": "",
"properties": {
- "confirmation_number": {
- "description": "The confirmation number.",
- "maxLength": 5000,
- "type": "string"
+ "financial_connections": {
+ "$ref": "#/components/schemas/linked_account_options_us_bank_account"
},
- "payment_code": {
- "description": "The payment code.",
- "maxLength": 5000,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
"type": "string"
+ },
+ "verification_method": {
+ "description": "Bank account verification method.",
+ "enum": [
+ "automatic",
+ "instant",
+ "microdeposits"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "required": [
- "payment_code"
- ],
- "title": "payment_intent_next_action_konbini_lawson",
+ "title": "payment_intent_payment_method_options_us_bank_account",
"type": "object",
"x-expandableFields": [
-
+ "financial_connections"
]
},
- "payment_intent_next_action_konbini_ministop": {
+ "payment_intent_processing": {
"description": "",
"properties": {
- "confirmation_number": {
- "description": "The confirmation number.",
- "maxLength": 5000,
- "type": "string"
+ "card": {
+ "$ref": "#/components/schemas/payment_intent_card_processing"
},
- "payment_code": {
- "description": "The payment code.",
- "maxLength": 5000,
+ "type": {
+ "description": "Type of the payment method for which payment is in `processing` state, one of `card`.",
+ "enum": [
+ "card"
+ ],
"type": "string"
}
},
"required": [
- "payment_code"
+ "type"
],
- "title": "payment_intent_next_action_konbini_ministop",
+ "title": "PaymentIntentProcessing",
"type": "object",
"x-expandableFields": [
-
+ "card"
]
},
- "payment_intent_next_action_konbini_seicomart": {
+ "payment_intent_processing_customer_notification": {
"description": "",
"properties": {
- "confirmation_number": {
- "description": "The confirmation number.",
- "maxLength": 5000,
- "type": "string"
+ "approval_requested": {
+ "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.",
+ "nullable": true,
+ "type": "boolean"
},
- "payment_code": {
- "description": "The payment code.",
- "maxLength": 5000,
- "type": "string"
+ "completes_at": {
+ "description": "If customer approval is required, they need to provide approval before this time.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
}
},
- "required": [
- "payment_code"
- ],
- "title": "payment_intent_next_action_konbini_seicomart",
+ "title": "PaymentIntentProcessingCustomerNotification",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_konbini_stores": {
+ "payment_intent_type_specific_payment_method_options_client": {
"description": "",
"properties": {
- "familymart": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart"
- }
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
],
- "description": "FamilyMart instruction details.",
- "nullable": true
+ "type": "string"
},
- "lawson": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson"
- }
- ],
- "description": "Lawson instruction details.",
- "nullable": true
+ "installments": {
+ "$ref": "#/components/schemas/payment_flows_installment_options"
},
- "ministop": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop"
- }
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
],
- "description": "Ministop instruction details.",
- "nullable": true
+ "type": "string"
},
- "seicomart": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart"
- }
+ "verification_method": {
+ "description": "Bank account verification method.",
+ "enum": [
+ "automatic",
+ "instant",
+ "microdeposits"
],
- "description": "Seicomart instruction details.",
- "nullable": true
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "payment_intent_next_action_konbini_stores",
+ "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
"type": "object",
"x-expandableFields": [
- "familymart",
- "lawson",
- "ministop",
- "seicomart"
+ "installments"
]
},
- "payment_intent_next_action_paynow_display_qr_code": {
- "description": "",
+ "payment_link": {
+ "description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payments/payment-links/api)",
"properties": {
- "data": {
- "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
- "maxLength": 5000,
- "type": "string"
+ "active": {
+ "description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.",
+ "type": "boolean"
},
- "image_url_png": {
- "description": "The image_url_png string used to render QR code",
- "maxLength": 5000,
- "type": "string"
+ "after_completion": {
+ "$ref": "#/components/schemas/payment_links_resource_after_completion"
},
- "image_url_svg": {
- "description": "The image_url_svg string used to render QR code",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "data",
- "image_url_png",
- "image_url_svg"
- ],
- "title": "PaymentIntentNextActionPaynowDisplayQrCode",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_intent_next_action_pix_display_qr_code": {
- "description": "",
- "properties": {
- "data": {
- "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
- "maxLength": 5000,
- "type": "string"
+ "allow_promotion_codes": {
+ "description": "Whether user redeemable promotion codes are enabled.",
+ "type": "boolean"
},
- "expires_at": {
- "description": "The date (unix timestamp) when the PIX expires.",
+ "application_fee_amount": {
+ "description": "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.",
+ "nullable": true,
"type": "integer"
},
- "hosted_instructions_url": {
- "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code.",
- "maxLength": 5000,
- "type": "string"
+ "application_fee_percent": {
+ "description": "This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.",
+ "nullable": true,
+ "type": "number"
},
- "image_url_png": {
- "description": "The image_url_png string used to render png QR code",
- "maxLength": 5000,
- "type": "string"
+ "automatic_tax": {
+ "$ref": "#/components/schemas/payment_links_resource_automatic_tax"
},
- "image_url_svg": {
- "description": "The image_url_svg string used to render svg QR code",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "PaymentIntentNextActionPixDisplayQrCode",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_intent_next_action_promptpay_display_qr_code": {
- "description": "",
- "properties": {
- "data": {
- "description": "The raw data string used to generate QR code, it should be used together with QR code library.",
- "maxLength": 5000,
+ "billing_address_collection": {
+ "description": "Configuration for collecting the customer's billing address.",
+ "enum": [
+ "auto",
+ "required"
+ ],
"type": "string"
},
- "hosted_instructions_url": {
- "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.",
- "maxLength": 5000,
+ "consent_collection": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_consent_collection"
+ }
+ ],
+ "description": "When set, provides configuration to gather active consent from customers.",
+ "nullable": true
+ },
+ "currency": {
+ "description": "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).",
"type": "string"
},
- "image_url_png": {
- "description": "The image_url_png string used to render QR code, can be used as ",
- "maxLength": 5000,
+ "customer_creation": {
+ "description": "Configuration for Customer creation during checkout.",
+ "enum": [
+ "always",
+ "if_required"
+ ],
"type": "string"
},
- "image_url_svg": {
- "description": "The image_url_svg string used to render QR code, can be used as ",
+ "id": {
+ "description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
- }
- },
- "required": [
- "data",
- "hosted_instructions_url",
- "image_url_png",
- "image_url_svg"
- ],
- "title": "PaymentIntentNextActionPromptpayDisplayQrCode",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_intent_next_action_redirect_to_url": {
- "description": "",
- "properties": {
- "return_url": {
- "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.",
- "maxLength": 5000,
+ },
+ "line_items": {
+ "description": "The line items representing what is being sold.",
+ "properties": {
+ "data": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/item"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "PaymentLinksResourceListLineItems",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
+ "type": "object"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "payment_link"
+ ],
+ "type": "string"
+ },
+ "on_behalf_of": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/account"
+ }
+ ],
+ "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/account"
+ }
+ ]
+ }
+ },
+ "payment_intent_data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_payment_intent_data"
+ }
+ ],
+ "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout.",
+ "nullable": true
+ },
+ "payment_method_collection": {
+ "description": "Configuration for collecting a payment method during checkout.",
+ "enum": [
+ "always",
+ "if_required"
+ ],
+ "type": "string"
+ },
+ "payment_method_types": {
+ "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
+ "items": {
+ "enum": [
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "klarna",
+ "konbini",
+ "oxxo",
+ "p24",
+ "paynow",
+ "pix",
+ "promptpay",
+ "sepa_debit",
+ "sofort",
+ "us_bank_account",
+ "wechat_pay"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
"nullable": true,
+ "type": "array"
+ },
+ "phone_number_collection": {
+ "$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
+ },
+ "shipping_address_collection": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection"
+ }
+ ],
+ "description": "Configuration for collecting the customer's shipping address.",
+ "nullable": true
+ },
+ "shipping_options": {
+ "description": "The shipping rate options applied to the session.",
+ "items": {
+ "$ref": "#/components/schemas/payment_links_resource_shipping_option"
+ },
+ "type": "array"
+ },
+ "submit_type": {
+ "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.",
+ "enum": [
+ "auto",
+ "book",
+ "donate",
+ "pay"
+ ],
"type": "string"
},
+ "subscription_data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_subscription_data"
+ }
+ ],
+ "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.",
+ "nullable": true
+ },
+ "tax_id_collection": {
+ "$ref": "#/components/schemas/payment_links_resource_tax_id_collection"
+ },
+ "transfer_data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_transfer_data"
+ }
+ ],
+ "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.",
+ "nullable": true
+ },
"url": {
- "description": "The URL you must redirect your customer to in order to authenticate the payment.",
+ "description": "The public URL that can be shared with customers.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
- "title": "PaymentIntentNextActionRedirectToUrl",
+ "required": [
+ "active",
+ "after_completion",
+ "allow_promotion_codes",
+ "automatic_tax",
+ "billing_address_collection",
+ "currency",
+ "customer_creation",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "payment_method_collection",
+ "phone_number_collection",
+ "shipping_options",
+ "submit_type",
+ "tax_id_collection",
+ "url"
+ ],
+ "title": "PaymentLink",
"type": "object",
"x-expandableFields": [
-
- ]
+ "after_completion",
+ "automatic_tax",
+ "consent_collection",
+ "line_items",
+ "on_behalf_of",
+ "payment_intent_data",
+ "phone_number_collection",
+ "shipping_address_collection",
+ "shipping_options",
+ "subscription_data",
+ "tax_id_collection",
+ "transfer_data"
+ ],
+ "x-resourceId": "payment_link"
},
- "payment_intent_next_action_verify_with_microdeposits": {
+ "payment_links_resource_after_completion": {
"description": "",
"properties": {
- "arrival_date": {
- "description": "The timestamp when the microdeposits are expected to land.",
- "format": "unix-time",
- "type": "integer"
+ "hosted_confirmation": {
+ "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"
},
- "hosted_verification_url": {
- "description": "The URL for the hosted verification page, which allows customers to verify their bank account.",
- "maxLength": 5000,
- "type": "string"
+ "redirect": {
+ "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect"
},
- "microdeposit_type": {
- "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.",
+ "type": {
+ "description": "The specified behavior after the purchase is complete.",
"enum": [
- "amounts",
- "descriptor_code"
+ "hosted_confirmation",
+ "redirect"
],
- "nullable": true,
"type": "string"
}
},
"required": [
- "arrival_date",
- "hosted_verification_url"
+ "type"
],
- "title": "PaymentIntentNextActionVerifyWithMicrodeposits",
+ "title": "PaymentLinksResourceAfterCompletion",
+ "type": "object",
+ "x-expandableFields": [
+ "hosted_confirmation",
+ "redirect"
+ ]
+ },
+ "payment_links_resource_automatic_tax": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "If `true`, tax will be calculated automatically using the customer's location.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "PaymentLinksResourceAutomaticTax",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_wechat_pay_display_qr_code": {
+ "payment_links_resource_completion_behavior_confirmation_page": {
"description": "",
"properties": {
- "data": {
- "description": "The data being used to generate QR code",
- "maxLength": 5000,
- "type": "string"
- },
- "image_data_url": {
- "description": "The base64 image data for a pre-generated QR code",
- "maxLength": 5000,
- "type": "string"
- },
- "image_url_png": {
- "description": "The image_url_png string used to render QR code",
+ "custom_message": {
+ "description": "The custom message that is displayed to the customer after the purchase is complete.",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
- },
- "image_url_svg": {
- "description": "The image_url_svg string used to render QR code",
+ }
+ },
+ "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_links_resource_completion_behavior_redirect": {
+ "description": "",
+ "properties": {
+ "url": {
+ "description": "The URL the customer will be redirected to after the purchase is complete.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
- "data",
- "image_data_url",
- "image_url_png",
- "image_url_svg"
+ "url"
],
- "title": "PaymentIntentNextActionWechatPayDisplayQrCode",
+ "title": "PaymentLinksResourceCompletionBehaviorRedirect",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_wechat_pay_redirect_to_android_app": {
+ "payment_links_resource_consent_collection": {
"description": "",
"properties": {
- "app_id": {
- "description": "app_id is the APP ID registered on WeChat open platform",
- "maxLength": 5000,
- "type": "string"
- },
- "nonce_str": {
- "description": "nonce_str is a random string",
- "maxLength": 5000,
- "type": "string"
- },
- "package": {
- "description": "package is static value",
- "maxLength": 5000,
- "type": "string"
- },
- "partner_id": {
- "description": "an unique merchant ID assigned by WeChat Pay",
- "maxLength": 5000,
+ "promotions": {
+ "description": "If set to `auto`, enables the collection of customer consent for promotional communications.",
+ "enum": [
+ "auto",
+ "none"
+ ],
+ "nullable": true,
"type": "string"
},
- "prepay_id": {
- "description": "an unique trading ID assigned by WeChat Pay",
- "maxLength": 5000,
+ "terms_of_service": {
+ "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.",
+ "enum": [
+ "none",
+ "required"
+ ],
+ "nullable": true,
"type": "string"
- },
- "sign": {
- "description": "A signature",
- "maxLength": 5000,
+ }
+ },
+ "title": "PaymentLinksResourceConsentCollection",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_links_resource_payment_intent_data": {
+ "description": "",
+ "properties": {
+ "capture_method": {
+ "description": "Indicates when the funds will be captured from the customer's account.",
+ "enum": [
+ "automatic",
+ "manual"
+ ],
+ "nullable": true,
"type": "string"
},
- "timestamp": {
- "description": "Specifies the current time in epoch format",
- "maxLength": 5000,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with the payment method collected during checkout.",
+ "enum": [
+ "off_session",
+ "on_session"
+ ],
+ "nullable": true,
"type": "string"
}
},
- "required": [
- "app_id",
- "nonce_str",
- "package",
- "partner_id",
- "prepay_id",
- "sign",
- "timestamp"
- ],
- "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
+ "title": "PaymentLinksResourcePaymentIntentData",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_next_action_wechat_pay_redirect_to_ios_app": {
+ "payment_links_resource_phone_number_collection": {
"description": "",
"properties": {
- "native_url": {
- "description": "An universal link that redirect to WeChat Pay app",
- "maxLength": 5000,
- "type": "string"
+ "enabled": {
+ "description": "If `true`, a phone number will be collected during checkout.",
+ "type": "boolean"
}
},
"required": [
- "native_url"
+ "enabled"
],
- "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
+ "title": "PaymentLinksResourcePhoneNumberCollection",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_payment_method_options": {
+ "payment_links_resource_shipping_address_collection": {
"description": "",
"properties": {
- "acss_debit": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "affirm": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_affirm"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "afterpay_clearpay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "alipay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_alipay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "au_becs_debit": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "bacs_debit": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_bacs_debit"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "bancontact": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_bancontact"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "blik": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "boleto": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_boleto"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
- },
- "card": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "allowed_countries": {
+ "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.",
+ "items": {
+ "enum": [
+ "AC",
+ "AD",
+ "AE",
+ "AF",
+ "AG",
+ "AI",
+ "AL",
+ "AM",
+ "AO",
+ "AQ",
+ "AR",
+ "AT",
+ "AU",
+ "AW",
+ "AX",
+ "AZ",
+ "BA",
+ "BB",
+ "BD",
+ "BE",
+ "BF",
+ "BG",
+ "BH",
+ "BI",
+ "BJ",
+ "BL",
+ "BM",
+ "BN",
+ "BO",
+ "BQ",
+ "BR",
+ "BS",
+ "BT",
+ "BV",
+ "BW",
+ "BY",
+ "BZ",
+ "CA",
+ "CD",
+ "CF",
+ "CG",
+ "CH",
+ "CI",
+ "CK",
+ "CL",
+ "CM",
+ "CN",
+ "CO",
+ "CR",
+ "CV",
+ "CW",
+ "CY",
+ "CZ",
+ "DE",
+ "DJ",
+ "DK",
+ "DM",
+ "DO",
+ "DZ",
+ "EC",
+ "EE",
+ "EG",
+ "EH",
+ "ER",
+ "ES",
+ "ET",
+ "FI",
+ "FJ",
+ "FK",
+ "FO",
+ "FR",
+ "GA",
+ "GB",
+ "GD",
+ "GE",
+ "GF",
+ "GG",
+ "GH",
+ "GI",
+ "GL",
+ "GM",
+ "GN",
+ "GP",
+ "GQ",
+ "GR",
+ "GS",
+ "GT",
+ "GU",
+ "GW",
+ "GY",
+ "HK",
+ "HN",
+ "HR",
+ "HT",
+ "HU",
+ "ID",
+ "IE",
+ "IL",
+ "IM",
+ "IN",
+ "IO",
+ "IQ",
+ "IS",
+ "IT",
+ "JE",
+ "JM",
+ "JO",
+ "JP",
+ "KE",
+ "KG",
+ "KH",
+ "KI",
+ "KM",
+ "KN",
+ "KR",
+ "KW",
+ "KY",
+ "KZ",
+ "LA",
+ "LB",
+ "LC",
+ "LI",
+ "LK",
+ "LR",
+ "LS",
+ "LT",
+ "LU",
+ "LV",
+ "LY",
+ "MA",
+ "MC",
+ "MD",
+ "ME",
+ "MF",
+ "MG",
+ "MK",
+ "ML",
+ "MM",
+ "MN",
+ "MO",
+ "MQ",
+ "MR",
+ "MS",
+ "MT",
+ "MU",
+ "MV",
+ "MW",
+ "MX",
+ "MY",
+ "MZ",
+ "NA",
+ "NC",
+ "NE",
+ "NG",
+ "NI",
+ "NL",
+ "NO",
+ "NP",
+ "NR",
+ "NU",
+ "NZ",
+ "OM",
+ "PA",
+ "PE",
+ "PF",
+ "PG",
+ "PH",
+ "PK",
+ "PL",
+ "PM",
+ "PN",
+ "PR",
+ "PS",
+ "PT",
+ "PY",
+ "QA",
+ "RE",
+ "RO",
+ "RS",
+ "RU",
+ "RW",
+ "SA",
+ "SB",
+ "SC",
+ "SE",
+ "SG",
+ "SH",
+ "SI",
+ "SJ",
+ "SK",
+ "SL",
+ "SM",
+ "SN",
+ "SO",
+ "SR",
+ "SS",
+ "ST",
+ "SV",
+ "SX",
+ "SZ",
+ "TA",
+ "TC",
+ "TD",
+ "TF",
+ "TG",
+ "TH",
+ "TJ",
+ "TK",
+ "TL",
+ "TM",
+ "TN",
+ "TO",
+ "TR",
+ "TT",
+ "TV",
+ "TW",
+ "TZ",
+ "UA",
+ "UG",
+ "US",
+ "UY",
+ "UZ",
+ "VA",
+ "VC",
+ "VE",
+ "VG",
+ "VN",
+ "VU",
+ "WF",
+ "WS",
+ "XK",
+ "YE",
+ "YT",
+ "ZA",
+ "ZM",
+ "ZW",
+ "ZZ"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "allowed_countries"
+ ],
+ "title": "PaymentLinksResourceShippingAddressCollection",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_links_resource_shipping_option": {
+ "description": "",
+ "properties": {
+ "shipping_amount": {
+ "description": "A non-negative integer in cents representing how much to charge.",
+ "type": "integer"
},
- "card_present": {
+ "shipping_rate": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_options_card_present"
+ "maxLength": 5000,
+ "type": "string"
},
{
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ "$ref": "#/components/schemas/shipping_rate"
}
- ]
+ ],
+ "description": "The ID of the Shipping Rate to use for this shipping option.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/shipping_rate"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "shipping_amount",
+ "shipping_rate"
+ ],
+ "title": "PaymentLinksResourceShippingOption",
+ "type": "object",
+ "x-expandableFields": [
+ "shipping_rate"
+ ]
+ },
+ "payment_links_resource_subscription_data": {
+ "description": "",
+ "properties": {
+ "description": {
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "customer_balance": {
+ "trial_period_days": {
+ "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "title": "PaymentLinksResourceSubscriptionData",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_links_resource_tax_id_collection": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Indicates whether tax ID collection is enabled for the session.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "PaymentLinksResourceTaxIdCollection",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_links_resource_transfer_data": {
+ "description": "",
+ "properties": {
+ "amount": {
+ "description": "The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "destination": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_options_customer_balance"
+ "maxLength": 5000,
+ "type": "string"
},
{
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ "$ref": "#/components/schemas/account"
}
- ]
+ ],
+ "description": "The connected account receiving the transfer.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/account"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "destination"
+ ],
+ "title": "PaymentLinksResourceTransferData",
+ "type": "object",
+ "x-expandableFields": [
+ "destination"
+ ]
+ },
+ "payment_method": {
+ "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).",
+ "properties": {
+ "acss_debit": {
+ "$ref": "#/components/schemas/payment_method_acss_debit"
},
- "eps": {
+ "affirm": {
+ "$ref": "#/components/schemas/payment_method_affirm"
+ },
+ "afterpay_clearpay": {
+ "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
+ },
+ "alipay": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
+ },
+ "au_becs_debit": {
+ "$ref": "#/components/schemas/payment_method_au_becs_debit"
+ },
+ "bacs_debit": {
+ "$ref": "#/components/schemas/payment_method_bacs_debit"
+ },
+ "bancontact": {
+ "$ref": "#/components/schemas/payment_method_bancontact"
+ },
+ "billing_details": {
+ "$ref": "#/components/schemas/billing_details"
+ },
+ "blik": {
+ "$ref": "#/components/schemas/payment_method_blik"
+ },
+ "boleto": {
+ "$ref": "#/components/schemas/payment_method_boleto"
+ },
+ "card": {
+ "$ref": "#/components/schemas/payment_method_card"
+ },
+ "card_present": {
+ "$ref": "#/components/schemas/payment_method_card_present"
+ },
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "customer": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
+ "maxLength": 5000,
+ "type": "string"
},
{
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
+ "$ref": "#/components/schemas/customer"
}
- ]
+ ],
+ "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/customer"
+ }
+ ]
+ }
+ },
+ "customer_balance": {
+ "$ref": "#/components/schemas/payment_method_customer_balance"
+ },
+ "eps": {
+ "$ref": "#/components/schemas/payment_method_eps"
},
"fpx": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_fpx"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_fpx"
},
"giropay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_giropay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_giropay"
},
"grabpay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_grabpay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_grabpay"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
},
"ideal": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_ideal"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_ideal"
},
"interac_present": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_interac_present"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_interac_present"
},
"klarna": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_klarna"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_klarna"
},
"konbini": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_konbini"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_konbini"
},
"link": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_link"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
+ "nullable": true,
+ "type": "object"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "payment_method"
+ ],
+ "type": "string"
},
"oxxo": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_oxxo"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_oxxo"
},
"p24": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_p24"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_p24"
},
"paynow": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_paynow"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_paynow"
},
"pix": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_pix"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_pix"
},
"promptpay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_promptpay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_promptpay"
+ },
+ "radar_options": {
+ "$ref": "#/components/schemas/radar_radar_options"
},
"sepa_debit": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_sepa_debit"
},
"sofort": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_sofort"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_sofort"
+ },
+ "type": {
+ "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
+ "enum": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "card_present",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "interac_present",
+ "klarna",
+ "konbini",
+ "link",
+ "oxxo",
+ "p24",
+ "paynow",
+ "pix",
+ "promptpay",
+ "sepa_debit",
+ "sofort",
+ "us_bank_account",
+ "wechat_pay"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"us_bank_account": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_us_bank_account"
},
"wechat_pay": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_wechat_pay"
- },
- {
- "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
- }
- ]
+ "$ref": "#/components/schemas/payment_method_wechat_pay"
}
},
- "title": "PaymentIntentPaymentMethodOptions",
+ "required": [
+ "billing_details",
+ "created",
+ "id",
+ "livemode",
+ "object",
+ "type"
+ ],
+ "title": "PaymentMethod",
"type": "object",
"x-expandableFields": [
"acss_debit",
@@ -21078,10 +21469,12 @@
"au_becs_debit",
"bacs_debit",
"bancontact",
+ "billing_details",
"blik",
"boleto",
"card",
"card_present",
+ "customer",
"customer_balance",
"eps",
"fpx",
@@ -21097,2304 +21490,2250 @@
"paynow",
"pix",
"promptpay",
+ "radar_options",
"sepa_debit",
"sofort",
"us_bank_account",
"wechat_pay"
- ]
+ ],
+ "x-resourceId": "payment_method"
},
- "payment_intent_payment_method_options_acss_debit": {
+ "payment_method_acss_debit": {
"description": "",
"properties": {
- "mandate_options": {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "verification_method": {
- "description": "Bank account verification method.",
- "enum": [
- "automatic",
- "instant",
- "microdeposits"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
+ "institution_number": {
+ "description": "Institution number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "transit_number": {
+ "description": "Transit number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "title": "payment_intent_payment_method_options_acss_debit",
+ "title": "payment_method_acss_debit",
"type": "object",
"x-expandableFields": [
- "mandate_options"
+
]
},
- "payment_intent_payment_method_options_au_becs_debit": {
+ "payment_method_affirm": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- }
},
- "title": "payment_intent_payment_method_options_au_becs_debit",
+ "title": "payment_method_affirm",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_payment_method_options_blik": {
+ "payment_method_afterpay_clearpay": {
"description": "",
"properties": {
},
- "title": "payment_intent_payment_method_options_blik",
+ "title": "payment_method_afterpay_clearpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_payment_method_options_card": {
+ "payment_method_au_becs_debit": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
+ "bsb_number": {
+ "description": "Six-digit number identifying bank and branch associated with this bank account.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "installments": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_card_installments"
- }
- ],
- "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
- "nullable": true
- },
- "mandate_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_options_card_mandate_options"
- }
- ],
- "description": "Configuration options for setting up an eMandate for cards issued in India.",
- "nullable": true
- },
- "network": {
- "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.",
- "enum": [
- "amex",
- "cartes_bancaires",
- "diners",
- "discover",
- "interac",
- "jcb",
- "mastercard",
- "unionpay",
- "unknown",
- "visa"
- ],
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "request_three_d_secure": {
- "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
- "enum": [
- "any",
- "automatic",
- "challenge_only"
- ],
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
+ }
+ },
+ "title": "payment_method_au_becs_debit",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_bacs_debit": {
+ "description": "",
+ "properties": {
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "statement_descriptor_suffix_kana": {
- "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.",
+ "last4": {
+ "description": "Last four digits of the bank account number.",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "statement_descriptor_suffix_kanji": {
- "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.",
+ "sort_code": {
+ "description": "Sort code of the bank account. (e.g., `10-20-30`)",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_intent_payment_method_options_card",
+ "title": "payment_method_bacs_debit",
"type": "object",
"x-expandableFields": [
- "installments",
- "mandate_options"
+
]
},
- "payment_intent_payment_method_options_eps": {
+ "payment_method_bancontact": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
- }
},
- "title": "payment_intent_payment_method_options_eps",
+ "title": "payment_method_bancontact",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_payment_method_options_link": {
+ "payment_method_blik": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
- "type": "string"
- },
- "persistent_token": {
- "description": "Token used for persistent Link logins.",
+ },
+ "title": "payment_method_blik",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_boleto": {
+ "description": "",
+ "properties": {
+ "tax_id": {
+ "description": "Uniquely identifies the customer tax id (CNPJ or CPF)",
"maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session"
- ],
"type": "string"
}
},
- "title": "payment_intent_payment_method_options_link",
+ "required": [
+ "tax_id"
+ ],
+ "title": "payment_method_boleto",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_payment_method_options_mandate_options_acss_debit": {
+ "payment_method_card": {
"description": "",
"properties": {
- "custom_mandate_url": {
- "description": "A URL for custom mandate text",
+ "brand": {
+ "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
"maxLength": 5000,
"type": "string"
},
- "interval_description": {
- "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.",
+ "checks": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_card_checks"
+ }
+ ],
+ "description": "Checks on Card address and CVC if provided.",
+ "nullable": true
+ },
+ "country": {
+ "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "payment_schedule": {
- "description": "Payment schedule for the mandate.",
- "enum": [
- "combined",
- "interval",
- "sporadic"
- ],
+ "exp_month": {
+ "description": "Two-digit number representing the card's expiration month.",
+ "type": "integer"
+ },
+ "exp_year": {
+ "description": "Four-digit number representing the card's expiration year.",
+ "type": "integer"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "transaction_type": {
- "description": "Transaction type of the mandate.",
- "enum": [
- "business",
- "personal"
+ "funding": {
+ "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "generated_from": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_card_generated_card"
+ }
],
- "nullable": true,
+ "description": "Details of the original PaymentMethod that created this object.",
+ "nullable": true
+ },
+ "last4": {
+ "description": "The last four digits of the card.",
+ "maxLength": 5000,
"type": "string"
+ },
+ "networks": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/networks"
+ }
+ ],
+ "description": "Contains information about card networks that can be used to process the payment.",
+ "nullable": true
+ },
+ "three_d_secure_usage": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/three_d_secure_usage"
+ }
+ ],
+ "description": "Contains details on how this Card maybe be used for 3D Secure authentication.",
+ "nullable": true
+ },
+ "wallet": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_card_wallet"
+ }
+ ],
+ "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
+ "nullable": true
}
},
- "title": "payment_intent_payment_method_options_mandate_options_acss_debit",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_intent_payment_method_options_mandate_options_sepa_debit": {
- "description": "",
- "properties": {
- },
- "title": "payment_intent_payment_method_options_mandate_options_sepa_debit",
+ "required": [
+ "brand",
+ "exp_month",
+ "exp_year",
+ "funding",
+ "last4"
+ ],
+ "title": "payment_method_card",
"type": "object",
"x-expandableFields": [
-
+ "checks",
+ "generated_from",
+ "networks",
+ "three_d_secure_usage",
+ "wallet"
]
},
- "payment_intent_payment_method_options_sepa_debit": {
+ "payment_method_card_checks": {
"description": "",
"properties": {
- "mandate_options": {
- "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"
+ "address_line1_check": {
+ "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
+ "address_postal_code_check": {
+ "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "cvc_check": {
+ "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_intent_payment_method_options_sepa_debit",
+ "title": "payment_method_card_checks",
"type": "object",
"x-expandableFields": [
- "mandate_options"
+
]
},
- "payment_intent_payment_method_options_us_bank_account": {
+ "payment_method_card_generated_card": {
"description": "",
"properties": {
- "financial_connections": {
- "$ref": "#/components/schemas/linked_account_options_us_bank_account"
+ "charge": {
+ "description": "The charge that created this object.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
+ "payment_method_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/card_generated_from_payment_method_details"
+ }
],
- "type": "string"
+ "description": "Transaction-specific details of the payment method used in the payment.",
+ "nullable": true
},
- "verification_method": {
- "description": "Bank account verification method.",
- "enum": [
- "automatic",
- "instant",
- "microdeposits"
+ "setup_attempt": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/setup_attempt"
+ }
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/setup_attempt"
+ }
+ ]
+ }
}
},
- "title": "payment_intent_payment_method_options_us_bank_account",
+ "title": "payment_method_card_generated_card",
"type": "object",
"x-expandableFields": [
- "financial_connections"
+ "payment_method_details",
+ "setup_attempt"
]
},
- "payment_intent_processing": {
+ "payment_method_card_present": {
"description": "",
"properties": {
- "card": {
- "$ref": "#/components/schemas/payment_intent_card_processing"
+ },
+ "title": "payment_method_card_present",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_card_wallet": {
+ "description": "",
+ "properties": {
+ "amex_express_checkout": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
+ },
+ "apple_pay": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
+ },
+ "dynamic_last4": {
+ "description": "(For tokenized numbers only.) The last four digits of the device account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "google_pay": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
+ },
+ "masterpass": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
+ },
+ "samsung_pay": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
},
"type": {
- "description": "Type of the payment method for which payment is in `processing` state, one of `card`.",
+ "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
"enum": [
- "card"
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
],
"type": "string"
+ },
+ "visa_checkout": {
+ "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
}
},
"required": [
"type"
],
- "title": "PaymentIntentProcessing",
+ "title": "payment_method_card_wallet",
"type": "object",
"x-expandableFields": [
- "card"
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
]
},
- "payment_intent_processing_customer_notification": {
+ "payment_method_card_wallet_amex_express_checkout": {
"description": "",
"properties": {
- "approval_requested": {
- "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.",
- "nullable": true,
- "type": "boolean"
- },
- "completes_at": {
- "description": "If customer approval is required, they need to provide approval before this time.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- }
},
- "title": "PaymentIntentProcessingCustomerNotification",
+ "title": "payment_method_card_wallet_amex_express_checkout",
"type": "object",
"x-expandableFields": [
]
},
- "payment_intent_type_specific_payment_method_options_client": {
+ "payment_method_card_wallet_apple_pay": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
- "type": "string"
- },
- "installments": {
- "$ref": "#/components/schemas/payment_flows_installment_options"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- },
- "verification_method": {
- "description": "Bank account verification method.",
- "enum": [
- "automatic",
- "instant",
- "microdeposits"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- }
},
- "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
+ "title": "payment_method_card_wallet_apple_pay",
"type": "object",
"x-expandableFields": [
- "installments"
+
]
},
- "payment_link": {
- "description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payments/payment-links/api)",
+ "payment_method_card_wallet_google_pay": {
+ "description": "",
"properties": {
- "active": {
- "description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.",
- "type": "boolean"
- },
- "after_completion": {
- "$ref": "#/components/schemas/payment_links_resource_after_completion"
- },
- "allow_promotion_codes": {
- "description": "Whether user redeemable promotion codes are enabled.",
- "type": "boolean"
- },
- "application_fee_amount": {
- "description": "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.",
- "nullable": true,
- "type": "integer"
- },
- "application_fee_percent": {
- "description": "This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.",
- "nullable": true,
- "type": "number"
- },
- "automatic_tax": {
- "$ref": "#/components/schemas/payment_links_resource_automatic_tax"
- },
- "billing_address_collection": {
- "description": "Configuration for collecting the customer's billing address.",
- "enum": [
- "auto",
- "required"
- ],
- "type": "string"
- },
- "consent_collection": {
+ },
+ "title": "payment_method_card_wallet_google_pay",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_card_wallet_masterpass": {
+ "description": "",
+ "properties": {
+ "billing_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_links_resource_consent_collection"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "When set, provides configuration to gather active consent from customers.",
+ "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
},
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "customer_creation": {
- "description": "Configuration for Customer creation during checkout.",
- "enum": [
- "always",
- "if_required"
- ],
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the object.",
+ "email": {
+ "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "line_items": {
- "description": "The line items representing what is being sold.",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/item"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "PaymentLinksResourceListLineItems",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
- },
- "livemode": {
- "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
- "type": "boolean"
- },
- "metadata": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "type": "object"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value.",
- "enum": [
- "payment_link"
- ],
+ "name": {
+ "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "on_behalf_of": {
+ "shipping_address": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/account"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/account"
- }
- ]
- }
- },
- "payment_intent_data": {
+ "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "nullable": true
+ }
+ },
+ "title": "payment_method_card_wallet_masterpass",
+ "type": "object",
+ "x-expandableFields": [
+ "billing_address",
+ "shipping_address"
+ ]
+ },
+ "payment_method_card_wallet_samsung_pay": {
+ "description": "",
+ "properties": {
+ },
+ "title": "payment_method_card_wallet_samsung_pay",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_card_wallet_visa_checkout": {
+ "description": "",
+ "properties": {
+ "billing_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_links_resource_payment_intent_data"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout.",
+ "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
},
- "payment_method_collection": {
- "description": "Configuration for collecting a payment method during checkout.",
- "enum": [
- "always",
- "if_required"
- ],
+ "email": {
+ "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "payment_method_types": {
- "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).",
- "items": {
- "enum": [
- "affirm",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "blik",
- "boleto",
- "card",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "klarna",
- "konbini",
- "oxxo",
- "p24",
- "paynow",
- "pix",
- "promptpay",
- "sepa_debit",
- "sofort",
- "us_bank_account",
- "wechat_pay"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
+ "name": {
+ "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
"nullable": true,
- "type": "array"
- },
- "phone_number_collection": {
- "$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
- },
- "shipping_address_collection": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection"
- }
- ],
- "description": "Configuration for collecting the customer's shipping address.",
- "nullable": true
- },
- "shipping_options": {
- "description": "The shipping rate options applied to the session.",
- "items": {
- "$ref": "#/components/schemas/payment_links_resource_shipping_option"
- },
- "type": "array"
- },
- "submit_type": {
- "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.",
- "enum": [
- "auto",
- "book",
- "donate",
- "pay"
- ],
"type": "string"
},
- "subscription_data": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_links_resource_subscription_data"
- }
- ],
- "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.",
- "nullable": true
- },
- "tax_id_collection": {
- "$ref": "#/components/schemas/payment_links_resource_tax_id_collection"
- },
- "transfer_data": {
+ "shipping_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_links_resource_transfer_data"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.",
+ "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
- },
- "url": {
- "description": "The public URL that can be shared with customers.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "active",
- "after_completion",
- "allow_promotion_codes",
- "automatic_tax",
- "billing_address_collection",
- "currency",
- "customer_creation",
- "id",
- "livemode",
- "metadata",
- "object",
- "payment_method_collection",
- "phone_number_collection",
- "shipping_options",
- "submit_type",
- "tax_id_collection",
- "url"
- ],
- "title": "PaymentLink",
- "type": "object",
- "x-expandableFields": [
- "after_completion",
- "automatic_tax",
- "consent_collection",
- "line_items",
- "on_behalf_of",
- "payment_intent_data",
- "phone_number_collection",
- "shipping_address_collection",
- "shipping_options",
- "subscription_data",
- "tax_id_collection",
- "transfer_data"
- ],
- "x-resourceId": "payment_link"
- },
- "payment_links_resource_after_completion": {
- "description": "",
- "properties": {
- "hosted_confirmation": {
- "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"
- },
- "redirect": {
- "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect"
- },
- "type": {
- "description": "The specified behavior after the purchase is complete.",
- "enum": [
- "hosted_confirmation",
- "redirect"
- ],
- "type": "string"
}
},
- "required": [
- "type"
- ],
- "title": "PaymentLinksResourceAfterCompletion",
+ "title": "payment_method_card_wallet_visa_checkout",
"type": "object",
"x-expandableFields": [
- "hosted_confirmation",
- "redirect"
+ "billing_address",
+ "shipping_address"
]
},
- "payment_links_resource_automatic_tax": {
+ "payment_method_customer_balance": {
"description": "",
"properties": {
- "enabled": {
- "description": "If `true`, tax will be calculated automatically using the customer's location.",
- "type": "boolean"
- }
},
- "required": [
- "enabled"
- ],
- "title": "PaymentLinksResourceAutomaticTax",
+ "title": "payment_method_customer_balance",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_completion_behavior_confirmation_page": {
+ "payment_method_details": {
"description": "",
"properties": {
- "custom_message": {
- "description": "The custom message that is displayed to the customer after the purchase is complete.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "ach_credit_transfer": {
+ "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
+ },
+ "ach_debit": {
+ "$ref": "#/components/schemas/payment_method_details_ach_debit"
+ },
+ "acss_debit": {
+ "$ref": "#/components/schemas/payment_method_details_acss_debit"
+ },
+ "affirm": {
+ "$ref": "#/components/schemas/payment_method_details_affirm"
+ },
+ "afterpay_clearpay": {
+ "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay"
+ },
+ "alipay": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
+ },
+ "au_becs_debit": {
+ "$ref": "#/components/schemas/payment_method_details_au_becs_debit"
+ },
+ "bacs_debit": {
+ "$ref": "#/components/schemas/payment_method_details_bacs_debit"
+ },
+ "bancontact": {
+ "$ref": "#/components/schemas/payment_method_details_bancontact"
+ },
+ "blik": {
+ "$ref": "#/components/schemas/payment_method_details_blik"
+ },
+ "boleto": {
+ "$ref": "#/components/schemas/payment_method_details_boleto"
+ },
+ "card": {
+ "$ref": "#/components/schemas/payment_method_details_card"
+ },
+ "card_present": {
+ "$ref": "#/components/schemas/payment_method_details_card_present"
+ },
+ "customer_balance": {
+ "$ref": "#/components/schemas/payment_method_details_customer_balance"
+ },
+ "eps": {
+ "$ref": "#/components/schemas/payment_method_details_eps"
+ },
+ "fpx": {
+ "$ref": "#/components/schemas/payment_method_details_fpx"
+ },
+ "giropay": {
+ "$ref": "#/components/schemas/payment_method_details_giropay"
+ },
+ "grabpay": {
+ "$ref": "#/components/schemas/payment_method_details_grabpay"
+ },
+ "ideal": {
+ "$ref": "#/components/schemas/payment_method_details_ideal"
+ },
+ "interac_present": {
+ "$ref": "#/components/schemas/payment_method_details_interac_present"
+ },
+ "klarna": {
+ "$ref": "#/components/schemas/payment_method_details_klarna"
+ },
+ "konbini": {
+ "$ref": "#/components/schemas/payment_method_details_konbini"
+ },
+ "link": {
+ "$ref": "#/components/schemas/payment_method_details_link"
+ },
+ "multibanco": {
+ "$ref": "#/components/schemas/payment_method_details_multibanco"
+ },
+ "oxxo": {
+ "$ref": "#/components/schemas/payment_method_details_oxxo"
+ },
+ "p24": {
+ "$ref": "#/components/schemas/payment_method_details_p24"
+ },
+ "paynow": {
+ "$ref": "#/components/schemas/payment_method_details_paynow"
+ },
+ "pix": {
+ "$ref": "#/components/schemas/payment_method_details_pix"
+ },
+ "promptpay": {
+ "$ref": "#/components/schemas/payment_method_details_promptpay"
+ },
+ "sepa_debit": {
+ "$ref": "#/components/schemas/payment_method_details_sepa_debit"
+ },
+ "sofort": {
+ "$ref": "#/components/schemas/payment_method_details_sofort"
+ },
+ "stripe_account": {
+ "$ref": "#/components/schemas/payment_method_details_stripe_account"
+ },
+ "type": {
+ "description": "The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "us_bank_account": {
+ "$ref": "#/components/schemas/payment_method_details_us_bank_account"
+ },
+ "wechat": {
+ "$ref": "#/components/schemas/payment_method_details_wechat"
+ },
+ "wechat_pay": {
+ "$ref": "#/components/schemas/payment_method_details_wechat_pay"
}
},
- "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
+ "required": [
+ "type"
+ ],
+ "title": "payment_method_details",
"type": "object",
"x-expandableFields": [
-
+ "ach_credit_transfer",
+ "ach_debit",
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "card_present",
+ "customer_balance",
+ "eps",
+ "fpx",
+ "giropay",
+ "grabpay",
+ "ideal",
+ "interac_present",
+ "klarna",
+ "konbini",
+ "link",
+ "multibanco",
+ "oxxo",
+ "p24",
+ "paynow",
+ "pix",
+ "promptpay",
+ "sepa_debit",
+ "sofort",
+ "stripe_account",
+ "us_bank_account",
+ "wechat",
+ "wechat_pay"
]
},
- "payment_links_resource_completion_behavior_redirect": {
+ "payment_method_details_ach_credit_transfer": {
"description": "",
"properties": {
- "url": {
- "description": "The URL the customer will be redirected to after the purchase is complete.",
+ "account_number": {
+ "description": "Account number to transfer funds to.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "Name of the bank associated with the routing number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "routing_number": {
+ "description": "Routing transit number for the bank account to transfer funds to.",
"maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "swift_code": {
+ "description": "SWIFT code of the bank associated with the routing number.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "required": [
- "url"
- ],
- "title": "PaymentLinksResourceCompletionBehaviorRedirect",
+ "title": "payment_method_details_ach_credit_transfer",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_consent_collection": {
+ "payment_method_details_ach_debit": {
"description": "",
"properties": {
- "promotions": {
- "description": "If set to `auto`, enables the collection of customer consent for promotional communications.",
+ "account_holder_type": {
+ "description": "Type of entity that holds the account. This can be either `individual` or `company`.",
"enum": [
- "auto",
- "none"
+ "company",
+ "individual"
],
"nullable": true,
"type": "string"
},
- "terms_of_service": {
- "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.",
- "enum": [
- "none",
- "required"
- ],
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "routing_number": {
+ "description": "Routing transit number of the bank account.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "PaymentLinksResourceConsentCollection",
+ "title": "payment_method_details_ach_debit",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_payment_intent_data": {
+ "payment_method_details_acss_debit": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Indicates when the funds will be captured from the customer's account.",
- "enum": [
- "automatic",
- "manual"
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "institution_number": {
+ "description": "Institution number of the bank account",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "mandate": {
+ "description": "ID of the mandate used to make this payment.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "transit_number": {
+ "description": "Transit number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_acss_debit",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_affirm": {
+ "description": "",
+ "properties": {
+ },
+ "title": "payment_method_details_affirm",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_afterpay_clearpay": {
+ "description": "",
+ "properties": {
+ "reference": {
+ "description": "Order identifier shown to the merchant in Afterpay’s online portal.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_afterpay_clearpay",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_au_becs_debit": {
+ "description": "",
+ "properties": {
+ "bsb_number": {
+ "description": "Bank-State-Branch number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "mandate": {
+ "description": "ID of the mandate used to make this payment.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_au_becs_debit",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_bacs_debit": {
+ "description": "",
+ "properties": {
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "mandate": {
+ "description": "ID of the mandate used to make this payment.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "sort_code": {
+ "description": "Sort code of the bank account. (e.g., `10-20-30`)",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_bacs_debit",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_bancontact": {
+ "description": "",
+ "properties": {
+ "bank_code": {
+ "description": "Bank code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "bic": {
+ "description": "Bank Identifier Code of the bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "generated_sepa_debit": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ ],
+ "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ ]
+ }
+ },
+ "generated_sepa_debit_mandate": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/mandate"
+ }
],
+ "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/mandate"
+ }
+ ]
+ }
+ },
+ "iban_last4": {
+ "description": "Last four characters of the IBAN.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with the payment method collected during checkout.",
+ "preferred_language": {
+ "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`",
"enum": [
- "off_session",
- "on_session"
+ "de",
+ "en",
+ "fr",
+ "nl"
],
"nullable": true,
"type": "string"
+ },
+ "verified_name": {
+ "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "title": "PaymentLinksResourcePaymentIntentData",
+ "title": "payment_method_details_bancontact",
+ "type": "object",
+ "x-expandableFields": [
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate"
+ ]
+ },
+ "payment_method_details_blik": {
+ "description": "",
+ "properties": {
+ },
+ "title": "payment_method_details_blik",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_phone_number_collection": {
+ "payment_method_details_boleto": {
"description": "",
"properties": {
- "enabled": {
- "description": "If `true`, a phone number will be collected during checkout.",
- "type": "boolean"
+ "tax_id": {
+ "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
- "enabled"
+ "tax_id"
],
- "title": "PaymentLinksResourcePhoneNumberCollection",
+ "title": "payment_method_details_boleto",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_shipping_address_collection": {
+ "payment_method_details_card": {
"description": "",
"properties": {
- "allowed_countries": {
- "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.",
- "items": {
- "enum": [
- "AC",
- "AD",
- "AE",
- "AF",
- "AG",
- "AI",
- "AL",
- "AM",
- "AO",
- "AQ",
- "AR",
- "AT",
- "AU",
- "AW",
- "AX",
- "AZ",
- "BA",
- "BB",
- "BD",
- "BE",
- "BF",
- "BG",
- "BH",
- "BI",
- "BJ",
- "BL",
- "BM",
- "BN",
- "BO",
- "BQ",
- "BR",
- "BS",
- "BT",
- "BV",
- "BW",
- "BY",
- "BZ",
- "CA",
- "CD",
- "CF",
- "CG",
- "CH",
- "CI",
- "CK",
- "CL",
- "CM",
- "CN",
- "CO",
- "CR",
- "CV",
- "CW",
- "CY",
- "CZ",
- "DE",
- "DJ",
- "DK",
- "DM",
- "DO",
- "DZ",
- "EC",
- "EE",
- "EG",
- "EH",
- "ER",
- "ES",
- "ET",
- "FI",
- "FJ",
- "FK",
- "FO",
- "FR",
- "GA",
- "GB",
- "GD",
- "GE",
- "GF",
- "GG",
- "GH",
- "GI",
- "GL",
- "GM",
- "GN",
- "GP",
- "GQ",
- "GR",
- "GS",
- "GT",
- "GU",
- "GW",
- "GY",
- "HK",
- "HN",
- "HR",
- "HT",
- "HU",
- "ID",
- "IE",
- "IL",
- "IM",
- "IN",
- "IO",
- "IQ",
- "IS",
- "IT",
- "JE",
- "JM",
- "JO",
- "JP",
- "KE",
- "KG",
- "KH",
- "KI",
- "KM",
- "KN",
- "KR",
- "KW",
- "KY",
- "KZ",
- "LA",
- "LB",
- "LC",
- "LI",
- "LK",
- "LR",
- "LS",
- "LT",
- "LU",
- "LV",
- "LY",
- "MA",
- "MC",
- "MD",
- "ME",
- "MF",
- "MG",
- "MK",
- "ML",
- "MM",
- "MN",
- "MO",
- "MQ",
- "MR",
- "MS",
- "MT",
- "MU",
- "MV",
- "MW",
- "MX",
- "MY",
- "MZ",
- "NA",
- "NC",
- "NE",
- "NG",
- "NI",
- "NL",
- "NO",
- "NP",
- "NR",
- "NU",
- "NZ",
- "OM",
- "PA",
- "PE",
- "PF",
- "PG",
- "PH",
- "PK",
- "PL",
- "PM",
- "PN",
- "PR",
- "PS",
- "PT",
- "PY",
- "QA",
- "RE",
- "RO",
- "RS",
- "RU",
- "RW",
- "SA",
- "SB",
- "SC",
- "SE",
- "SG",
- "SH",
- "SI",
- "SJ",
- "SK",
- "SL",
- "SM",
- "SN",
- "SO",
- "SR",
- "SS",
- "ST",
- "SV",
- "SX",
- "SZ",
- "TA",
- "TC",
- "TD",
- "TF",
- "TG",
- "TH",
- "TJ",
- "TK",
- "TL",
- "TM",
- "TN",
- "TO",
- "TR",
- "TT",
- "TV",
- "TW",
- "TZ",
- "UA",
- "UG",
- "US",
- "UY",
- "UZ",
- "VA",
- "VC",
- "VE",
- "VG",
- "VN",
- "VU",
- "WF",
- "WS",
- "XK",
- "YE",
- "YT",
- "ZA",
- "ZM",
- "ZW",
- "ZZ"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "allowed_countries"
- ],
- "title": "PaymentLinksResourceShippingAddressCollection",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_links_resource_shipping_option": {
- "description": "",
- "properties": {
- "shipping_amount": {
- "description": "A non-negative integer in cents representing how much to charge.",
+ "brand": {
+ "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "checks": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_checks"
+ }
+ ],
+ "description": "Check results by Card networks on Card address and CVC at time of payment.",
+ "nullable": true
+ },
+ "country": {
+ "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "exp_month": {
+ "description": "Two-digit number representing the card's expiration month.",
"type": "integer"
},
- "shipping_rate": {
+ "exp_year": {
+ "description": "Four-digit number representing the card's expiration year.",
+ "type": "integer"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "funding": {
+ "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "installments": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
- },
+ "$ref": "#/components/schemas/payment_method_details_card_installments"
+ }
+ ],
+ "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
+ "nullable": true
+ },
+ "last4": {
+ "description": "The last four digits of the card.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "mandate": {
+ "description": "ID of the mandate used to make this payment or created by it.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "network": {
+ "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "three_d_secure": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/shipping_rate"
+ "$ref": "#/components/schemas/three_d_secure_details"
}
],
- "description": "The ID of the Shipping Rate to use for this shipping option.",
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/shipping_rate"
- }
- ]
- }
+ "description": "Populated if this transaction used 3D Secure authentication.",
+ "nullable": true
+ },
+ "wallet": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet"
+ }
+ ],
+ "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
+ "nullable": true
}
},
"required": [
- "shipping_amount",
- "shipping_rate"
+ "exp_month",
+ "exp_year"
],
- "title": "PaymentLinksResourceShippingOption",
+ "title": "payment_method_details_card",
"type": "object",
"x-expandableFields": [
- "shipping_rate"
+ "checks",
+ "installments",
+ "three_d_secure",
+ "wallet"
]
},
- "payment_links_resource_subscription_data": {
+ "payment_method_details_card_checks": {
"description": "",
"properties": {
- "description": {
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
+ "address_line1_check": {
+ "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "trial_period_days": {
- "description": "Integer representing the number of trial period days before the customer is charged for the first time.",
+ "address_postal_code_check": {
+ "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
"nullable": true,
- "type": "integer"
+ "type": "string"
+ },
+ "cvc_check": {
+ "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "title": "PaymentLinksResourceSubscriptionData",
+ "title": "payment_method_details_card_checks",
"type": "object",
"x-expandableFields": [
]
},
- "payment_links_resource_tax_id_collection": {
+ "payment_method_details_card_installments": {
"description": "",
"properties": {
- "enabled": {
- "description": "Indicates whether tax ID collection is enabled for the session.",
- "type": "boolean"
+ "plan": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
+ }
+ ],
+ "description": "Installment plan selected for the payment.",
+ "nullable": true
}
},
- "required": [
- "enabled"
- ],
- "title": "PaymentLinksResourceTaxIdCollection",
+ "title": "payment_method_details_card_installments",
"type": "object",
"x-expandableFields": [
-
+ "plan"
]
},
- "payment_links_resource_transfer_data": {
+ "payment_method_details_card_installments_plan": {
"description": "",
"properties": {
- "amount": {
- "description": "The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "count": {
+ "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
"nullable": true,
"type": "integer"
},
- "destination": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/account"
- }
+ "interval": {
+ "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
+ "enum": [
+ "month"
],
- "description": "The connected account receiving the transfer.",
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/account"
- }
- ]
- }
+ "nullable": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of installment plan, one of `fixed_count`.",
+ "enum": [
+ "fixed_count"
+ ],
+ "type": "string"
}
},
"required": [
- "destination"
+ "type"
],
- "title": "PaymentLinksResourceTransferData",
+ "title": "payment_method_details_card_installments_plan",
"type": "object",
"x-expandableFields": [
- "destination"
+
]
},
- "payment_method": {
- "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).",
+ "payment_method_details_card_present": {
+ "description": "",
"properties": {
- "acss_debit": {
- "$ref": "#/components/schemas/payment_method_acss_debit"
+ "amount_authorized": {
+ "description": "The authorized amount",
+ "nullable": true,
+ "type": "integer"
},
- "affirm": {
- "$ref": "#/components/schemas/payment_method_affirm"
+ "brand": {
+ "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "afterpay_clearpay": {
- "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
+ "capture_before": {
+ "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.",
+ "format": "unix-time",
+ "type": "integer"
},
- "alipay": {
- "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
+ "cardholder_name": {
+ "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "au_becs_debit": {
- "$ref": "#/components/schemas/payment_method_au_becs_debit"
+ "country": {
+ "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "bacs_debit": {
- "$ref": "#/components/schemas/payment_method_bacs_debit"
+ "emv_auth_data": {
+ "description": "Authorization response cryptogram.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "bancontact": {
- "$ref": "#/components/schemas/payment_method_bancontact"
+ "exp_month": {
+ "description": "Two-digit number representing the card's expiration month.",
+ "type": "integer"
},
- "billing_details": {
- "$ref": "#/components/schemas/billing_details"
+ "exp_year": {
+ "description": "Four-digit number representing the card's expiration year.",
+ "type": "integer"
},
- "blik": {
- "$ref": "#/components/schemas/payment_method_blik"
+ "fingerprint": {
+ "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "boleto": {
- "$ref": "#/components/schemas/payment_method_boleto"
+ "funding": {
+ "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "card": {
- "$ref": "#/components/schemas/payment_method_card"
+ "generated_card": {
+ "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "card_present": {
- "$ref": "#/components/schemas/payment_method_card_present"
+ "incremental_authorization_supported": {
+ "description": "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).",
+ "type": "boolean"
},
- "created": {
- "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
- "format": "unix-time",
- "type": "integer"
+ "last4": {
+ "description": "The last four digits of the card.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "customer": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/customer"
- }
- ],
- "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
+ "network": {
+ "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "maxLength": 5000,
"nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/customer"
- }
- ]
- }
- },
- "customer_balance": {
- "$ref": "#/components/schemas/payment_method_customer_balance"
- },
- "eps": {
- "$ref": "#/components/schemas/payment_method_eps"
- },
- "fpx": {
- "$ref": "#/components/schemas/payment_method_fpx"
- },
- "giropay": {
- "$ref": "#/components/schemas/payment_method_giropay"
- },
- "grabpay": {
- "$ref": "#/components/schemas/payment_method_grabpay"
- },
- "id": {
- "description": "Unique identifier for the object.",
- "maxLength": 5000,
"type": "string"
},
- "ideal": {
- "$ref": "#/components/schemas/payment_method_ideal"
- },
- "interac_present": {
- "$ref": "#/components/schemas/payment_method_interac_present"
- },
- "klarna": {
- "$ref": "#/components/schemas/payment_method_klarna"
- },
- "konbini": {
- "$ref": "#/components/schemas/payment_method_konbini"
- },
- "link": {
- "$ref": "#/components/schemas/payment_method_link"
- },
- "livemode": {
- "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "overcapture_supported": {
+ "description": "Defines whether the authorized amount can be over-captured or not",
"type": "boolean"
},
- "metadata": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "nullable": true,
- "type": "object"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value.",
+ "read_method": {
+ "description": "How card details were read in this transaction.",
"enum": [
- "payment_method"
+ "contact_emv",
+ "contactless_emv",
+ "contactless_magstripe_mode",
+ "magnetic_stripe_fallback",
+ "magnetic_stripe_track2"
],
+ "nullable": true,
"type": "string"
},
- "oxxo": {
- "$ref": "#/components/schemas/payment_method_oxxo"
- },
- "p24": {
- "$ref": "#/components/schemas/payment_method_p24"
- },
- "paynow": {
- "$ref": "#/components/schemas/payment_method_paynow"
- },
- "pix": {
- "$ref": "#/components/schemas/payment_method_pix"
- },
- "promptpay": {
- "$ref": "#/components/schemas/payment_method_promptpay"
- },
- "radar_options": {
- "$ref": "#/components/schemas/radar_radar_options"
- },
- "sepa_debit": {
- "$ref": "#/components/schemas/payment_method_sepa_debit"
- },
- "sofort": {
- "$ref": "#/components/schemas/payment_method_sofort"
- },
- "type": {
- "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
- "enum": [
- "acss_debit",
- "affirm",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "blik",
- "boleto",
- "card",
- "card_present",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "interac_present",
- "klarna",
- "konbini",
- "link",
- "oxxo",
- "p24",
- "paynow",
- "pix",
- "promptpay",
- "sepa_debit",
- "sofort",
- "us_bank_account",
- "wechat_pay"
+ "receipt": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_present_receipt"
+ }
],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "us_bank_account": {
- "$ref": "#/components/schemas/payment_method_us_bank_account"
- },
- "wechat_pay": {
- "$ref": "#/components/schemas/payment_method_wechat_pay"
+ "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
+ "nullable": true
}
},
"required": [
- "billing_details",
- "created",
- "id",
- "livemode",
- "object",
- "type"
+ "exp_month",
+ "exp_year",
+ "incremental_authorization_supported",
+ "overcapture_supported"
],
- "title": "PaymentMethod",
+ "title": "payment_method_details_card_present",
"type": "object",
"x-expandableFields": [
- "acss_debit",
- "affirm",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "billing_details",
- "blik",
- "boleto",
- "card",
- "card_present",
- "customer",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "interac_present",
- "klarna",
- "konbini",
- "link",
- "oxxo",
- "p24",
- "paynow",
- "pix",
- "promptpay",
- "radar_options",
- "sepa_debit",
- "sofort",
- "us_bank_account",
- "wechat_pay"
- ],
- "x-resourceId": "payment_method"
+ "receipt"
+ ]
},
- "payment_method_acss_debit": {
+ "payment_method_details_card_present_receipt": {
"description": "",
"properties": {
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
+ "account_type": {
+ "description": "The type of account being debited or credited",
+ "enum": [
+ "checking",
+ "credit",
+ "prepaid",
+ "unknown"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "application_cryptogram": {
+ "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "application_preferred_name": {
+ "description": "Mnenomic of the Application Identifier.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "institution_number": {
- "description": "Institution number of the bank account.",
+ "authorization_code": {
+ "description": "Identifier for this transaction.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "authorization_response_code": {
+ "description": "EMV tag 8A. A code returned by the card issuer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "transit_number": {
- "description": "Transit number of the bank account.",
+ "cardholder_verification_method": {
+ "description": "How the cardholder verified ownership of the card.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_acss_debit",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_affirm": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_affirm",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_afterpay_clearpay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_afterpay_clearpay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_au_becs_debit": {
- "description": "",
- "properties": {
- "bsb_number": {
- "description": "Six-digit number identifying bank and branch associated with this bank account.",
+ },
+ "dedicated_file_name": {
+ "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "terminal_verification_results": {
+ "description": "The outcome of a series of EMV functions performed by the card reader.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "transaction_status_information": {
+ "description": "An indication of various EMV functions performed during the transaction.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "payment_method_au_becs_debit",
+ "title": "payment_method_details_card_present_receipt",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_bacs_debit": {
+ "payment_method_details_card_wallet": {
"description": "",
"properties": {
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "amex_express_checkout": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "apple_pay": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
+ },
+ "dynamic_last4": {
+ "description": "(For tokenized numbers only.) The last four digits of the device account number.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "sort_code": {
- "description": "Sort code of the bank account. (e.g., `10-20-30`)",
- "maxLength": 5000,
- "nullable": true,
+ "google_pay": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
+ },
+ "masterpass": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
+ },
+ "samsung_pay": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
+ },
+ "type": {
+ "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
+ "enum": [
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
+ ],
"type": "string"
+ },
+ "visa_checkout": {
+ "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
}
},
- "title": "payment_method_bacs_debit",
+ "required": [
+ "type"
+ ],
+ "title": "payment_method_details_card_wallet",
"type": "object",
"x-expandableFields": [
-
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
]
},
- "payment_method_bancontact": {
+ "payment_method_details_card_wallet_amex_express_checkout": {
"description": "",
"properties": {
},
- "title": "payment_method_bancontact",
+ "title": "payment_method_details_card_wallet_amex_express_checkout",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_blik": {
+ "payment_method_details_card_wallet_apple_pay": {
"description": "",
"properties": {
},
- "title": "payment_method_blik",
+ "title": "payment_method_details_card_wallet_apple_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_boleto": {
+ "payment_method_details_card_wallet_google_pay": {
"description": "",
"properties": {
- "tax_id": {
- "description": "Uniquely identifies the customer tax id (CNPJ or CPF)",
- "maxLength": 5000,
- "type": "string"
- }
},
- "required": [
- "tax_id"
- ],
- "title": "payment_method_boleto",
+ "title": "payment_method_details_card_wallet_google_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card": {
+ "payment_method_details_card_wallet_masterpass": {
"description": "",
"properties": {
- "brand": {
- "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
- "maxLength": 5000,
- "type": "string"
- },
- "checks": {
+ "billing_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_card_checks"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "Checks on Card address and CVC if provided.",
+ "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
},
- "country": {
- "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
+ "email": {
+ "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "exp_month": {
- "description": "Two-digit number representing the card's expiration month.",
- "type": "integer"
- },
- "exp_year": {
- "description": "Four-digit number representing the card's expiration year.",
- "type": "integer"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "name": {
+ "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "funding": {
- "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
- "maxLength": 5000,
- "type": "string"
- },
- "generated_from": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_card_generated_card"
- }
- ],
- "description": "Details of the original PaymentMethod that created this object.",
- "nullable": true
- },
- "last4": {
- "description": "The last four digits of the card.",
- "maxLength": 5000,
- "type": "string"
- },
- "networks": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/networks"
- }
- ],
- "description": "Contains information about card networks that can be used to process the payment.",
- "nullable": true
- },
- "three_d_secure_usage": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/three_d_secure_usage"
- }
- ],
- "description": "Contains details on how this Card maybe be used for 3D Secure authentication.",
- "nullable": true
- },
- "wallet": {
+ "shipping_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_card_wallet"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
+ "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
}
},
- "required": [
- "brand",
- "exp_month",
- "exp_year",
- "funding",
- "last4"
- ],
- "title": "payment_method_card",
+ "title": "payment_method_details_card_wallet_masterpass",
"type": "object",
"x-expandableFields": [
- "checks",
- "generated_from",
- "networks",
- "three_d_secure_usage",
- "wallet"
+ "billing_address",
+ "shipping_address"
]
},
- "payment_method_card_checks": {
+ "payment_method_details_card_wallet_samsung_pay": {
"description": "",
"properties": {
- "address_line1_check": {
- "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "address_postal_code_check": {
- "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "cvc_check": {
- "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
},
- "title": "payment_method_card_checks",
+ "title": "payment_method_details_card_wallet_samsung_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card_generated_card": {
+ "payment_method_details_card_wallet_visa_checkout": {
"description": "",
"properties": {
- "charge": {
- "description": "The charge that created this object.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "payment_method_details": {
+ "billing_address": {
"anyOf": [
{
- "$ref": "#/components/schemas/card_generated_from_payment_method_details"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "Transaction-specific details of the payment method used in the payment.",
+ "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"nullable": true
},
- "setup_attempt": {
+ "email": {
+ "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "shipping_address": {
"anyOf": [
{
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/setup_attempt"
+ "$ref": "#/components/schemas/address"
}
],
- "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/setup_attempt"
- }
- ]
- }
+ "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "nullable": true
}
},
- "title": "payment_method_card_generated_card",
+ "title": "payment_method_details_card_wallet_visa_checkout",
"type": "object",
"x-expandableFields": [
- "payment_method_details",
- "setup_attempt"
+ "billing_address",
+ "shipping_address"
]
},
- "payment_method_card_present": {
+ "payment_method_details_customer_balance": {
"description": "",
"properties": {
},
- "title": "payment_method_card_present",
+ "title": "payment_method_details_customer_balance",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card_wallet": {
+ "payment_method_details_eps": {
"description": "",
"properties": {
- "amex_express_checkout": {
- "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
- },
- "apple_pay": {
- "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
- },
- "dynamic_last4": {
- "description": "(For tokenized numbers only.) The last four digits of the device account number.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "google_pay": {
- "$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
- },
- "masterpass": {
- "$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
- },
- "samsung_pay": {
- "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
- },
- "type": {
- "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
+ "bank": {
+ "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.",
"enum": [
- "amex_express_checkout",
- "apple_pay",
- "google_pay",
- "masterpass",
- "samsung_pay",
- "visa_checkout"
+ "arzte_und_apotheker_bank",
+ "austrian_anadi_bank_ag",
+ "bank_austria",
+ "bankhaus_carl_spangler",
+ "bankhaus_schelhammer_und_schattera_ag",
+ "bawag_psk_ag",
+ "bks_bank_ag",
+ "brull_kallmus_bank_ag",
+ "btv_vier_lander_bank",
+ "capital_bank_grawe_gruppe_ag",
+ "deutsche_bank_ag",
+ "dolomitenbank",
+ "easybank_ag",
+ "erste_bank_und_sparkassen",
+ "hypo_alpeadriabank_international_ag",
+ "hypo_bank_burgenland_aktiengesellschaft",
+ "hypo_noe_lb_fur_niederosterreich_u_wien",
+ "hypo_oberosterreich_salzburg_steiermark",
+ "hypo_tirol_bank_ag",
+ "hypo_vorarlberg_bank_ag",
+ "marchfelder_bank",
+ "oberbank_ag",
+ "raiffeisen_bankengruppe_osterreich",
+ "schoellerbank_ag",
+ "sparda_bank_wien",
+ "volksbank_gruppe",
+ "volkskreditbank_ag",
+ "vr_bank_braunau"
],
+ "nullable": true,
"type": "string"
},
- "visa_checkout": {
- "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
+ "verified_name": {
+ "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "required": [
- "type"
- ],
- "title": "payment_method_card_wallet",
- "type": "object",
- "x-expandableFields": [
- "amex_express_checkout",
- "apple_pay",
- "google_pay",
- "masterpass",
- "samsung_pay",
- "visa_checkout"
- ]
- },
- "payment_method_card_wallet_amex_express_checkout": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_card_wallet_amex_express_checkout",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_card_wallet_apple_pay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_card_wallet_apple_pay",
+ "title": "payment_method_details_eps",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card_wallet_google_pay": {
+ "payment_method_details_fpx": {
"description": "",
"properties": {
+ "bank": {
+ "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
+ "enum": [
+ "affin_bank",
+ "agrobank",
+ "alliance_bank",
+ "ambank",
+ "bank_islam",
+ "bank_muamalat",
+ "bank_of_china",
+ "bank_rakyat",
+ "bsn",
+ "cimb",
+ "deutsche_bank",
+ "hong_leong_bank",
+ "hsbc",
+ "kfh",
+ "maybank2e",
+ "maybank2u",
+ "ocbc",
+ "pb_enterprise",
+ "public_bank",
+ "rhb",
+ "standard_chartered",
+ "uob"
+ ],
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "Unique transaction id generated by FPX for every request from the merchant",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
},
- "title": "payment_method_card_wallet_google_pay",
+ "required": [
+ "bank"
+ ],
+ "title": "payment_method_details_fpx",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card_wallet_masterpass": {
+ "payment_method_details_giropay": {
"description": "",
"properties": {
- "billing_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
+ "bank_code": {
+ "description": "Bank code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
},
- "email": {
- "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "name": {
- "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "bic": {
+ "description": "Bank Identifier Code of the bank associated with the bank account.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "shipping_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
+ "verified_name": {
+ "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "title": "payment_method_card_wallet_masterpass",
+ "title": "payment_method_details_giropay",
"type": "object",
"x-expandableFields": [
- "billing_address",
- "shipping_address"
+
]
},
- "payment_method_card_wallet_samsung_pay": {
+ "payment_method_details_grabpay": {
"description": "",
"properties": {
+ "transaction_id": {
+ "description": "Unique transaction id generated by GrabPay",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
},
- "title": "payment_method_card_wallet_samsung_pay",
+ "title": "payment_method_details_grabpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_card_wallet_visa_checkout": {
+ "payment_method_details_ideal": {
"description": "",
"properties": {
- "billing_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
+ "bank": {
+ "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.",
+ "enum": [
+ "abn_amro",
+ "asn_bank",
+ "bunq",
+ "handelsbanken",
+ "ing",
+ "knab",
+ "moneyou",
+ "rabobank",
+ "regiobank",
+ "revolut",
+ "sns_bank",
+ "triodos_bank",
+ "van_lanschot"
],
- "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- },
- "email": {
- "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "name": {
- "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
+ "bic": {
+ "description": "The Bank Identifier Code of the customer's bank.",
+ "enum": [
+ "ABNANL2A",
+ "ASNBNL21",
+ "BUNQNL2A",
+ "FVLBNL22",
+ "HANDNL2A",
+ "INGBNL2A",
+ "KNABNL2H",
+ "MOYONL21",
+ "RABONL2U",
+ "RBRBNL21",
+ "REVOLT21",
+ "SNSBNL2A",
+ "TRIONL2U"
+ ],
"nullable": true,
"type": "string"
},
- "shipping_address": {
+ "generated_sepa_debit": {
"anyOf": [
{
- "$ref": "#/components/schemas/address"
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/payment_method"
}
],
- "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- }
- },
- "title": "payment_method_card_wallet_visa_checkout",
- "type": "object",
- "x-expandableFields": [
- "billing_address",
- "shipping_address"
- ]
- },
- "payment_method_customer_balance": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_customer_balance",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details": {
- "description": "",
- "properties": {
- "ach_credit_transfer": {
- "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
- },
- "ach_debit": {
- "$ref": "#/components/schemas/payment_method_details_ach_debit"
- },
- "acss_debit": {
- "$ref": "#/components/schemas/payment_method_details_acss_debit"
- },
- "affirm": {
- "$ref": "#/components/schemas/payment_method_details_affirm"
- },
- "afterpay_clearpay": {
- "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay"
- },
- "alipay": {
- "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
- },
- "au_becs_debit": {
- "$ref": "#/components/schemas/payment_method_details_au_becs_debit"
- },
- "bacs_debit": {
- "$ref": "#/components/schemas/payment_method_details_bacs_debit"
- },
- "bancontact": {
- "$ref": "#/components/schemas/payment_method_details_bancontact"
- },
- "blik": {
- "$ref": "#/components/schemas/payment_method_details_blik"
- },
- "boleto": {
- "$ref": "#/components/schemas/payment_method_details_boleto"
- },
- "card": {
- "$ref": "#/components/schemas/payment_method_details_card"
- },
- "card_present": {
- "$ref": "#/components/schemas/payment_method_details_card_present"
- },
- "customer_balance": {
- "$ref": "#/components/schemas/payment_method_details_customer_balance"
- },
- "eps": {
- "$ref": "#/components/schemas/payment_method_details_eps"
- },
- "fpx": {
- "$ref": "#/components/schemas/payment_method_details_fpx"
- },
- "giropay": {
- "$ref": "#/components/schemas/payment_method_details_giropay"
- },
- "grabpay": {
- "$ref": "#/components/schemas/payment_method_details_grabpay"
- },
- "ideal": {
- "$ref": "#/components/schemas/payment_method_details_ideal"
- },
- "interac_present": {
- "$ref": "#/components/schemas/payment_method_details_interac_present"
- },
- "klarna": {
- "$ref": "#/components/schemas/payment_method_details_klarna"
- },
- "konbini": {
- "$ref": "#/components/schemas/payment_method_details_konbini"
- },
- "link": {
- "$ref": "#/components/schemas/payment_method_details_link"
- },
- "multibanco": {
- "$ref": "#/components/schemas/payment_method_details_multibanco"
- },
- "oxxo": {
- "$ref": "#/components/schemas/payment_method_details_oxxo"
- },
- "p24": {
- "$ref": "#/components/schemas/payment_method_details_p24"
- },
- "paynow": {
- "$ref": "#/components/schemas/payment_method_details_paynow"
- },
- "pix": {
- "$ref": "#/components/schemas/payment_method_details_pix"
- },
- "promptpay": {
- "$ref": "#/components/schemas/payment_method_details_promptpay"
- },
- "sepa_debit": {
- "$ref": "#/components/schemas/payment_method_details_sepa_debit"
- },
- "sofort": {
- "$ref": "#/components/schemas/payment_method_details_sofort"
+ "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ ]
+ }
},
- "stripe_account": {
- "$ref": "#/components/schemas/payment_method_details_stripe_account"
+ "generated_sepa_debit_mandate": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/mandate"
+ }
+ ],
+ "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/mandate"
+ }
+ ]
+ }
},
- "type": {
- "description": "The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.",
+ "iban_last4": {
+ "description": "Last four characters of the IBAN.",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "us_bank_account": {
- "$ref": "#/components/schemas/payment_method_details_us_bank_account"
- },
- "wechat": {
- "$ref": "#/components/schemas/payment_method_details_wechat"
- },
- "wechat_pay": {
- "$ref": "#/components/schemas/payment_method_details_wechat_pay"
+ "verified_name": {
+ "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
- "required": [
- "type"
- ],
- "title": "payment_method_details",
+ "title": "payment_method_details_ideal",
"type": "object",
"x-expandableFields": [
- "ach_credit_transfer",
- "ach_debit",
- "acss_debit",
- "affirm",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "blik",
- "boleto",
- "card",
- "card_present",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "interac_present",
- "klarna",
- "konbini",
- "link",
- "multibanco",
- "oxxo",
- "p24",
- "paynow",
- "pix",
- "promptpay",
- "sepa_debit",
- "sofort",
- "stripe_account",
- "us_bank_account",
- "wechat",
- "wechat_pay"
+ "generated_sepa_debit",
+ "generated_sepa_debit_mandate"
]
},
- "payment_method_details_ach_credit_transfer": {
+ "payment_method_details_interac_present": {
"description": "",
"properties": {
- "account_number": {
- "description": "Account number to transfer funds to.",
+ "brand": {
+ "description": "Card brand. Can be `interac`, `mastercard` or `visa`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "bank_name": {
- "description": "Name of the bank associated with the routing number.",
+ "cardholder_name": {
+ "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "routing_number": {
- "description": "Routing transit number for the bank account to transfer funds to.",
+ "country": {
+ "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "swift_code": {
- "description": "SWIFT code of the bank associated with the routing number.",
+ "emv_auth_data": {
+ "description": "Authorization response cryptogram.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_details_ach_credit_transfer",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_ach_debit": {
- "description": "",
- "properties": {
- "account_holder_type": {
- "description": "Type of entity that holds the account. This can be either `individual` or `company`.",
- "enum": [
- "company",
- "individual"
- ],
- "nullable": true,
- "type": "string"
},
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
+ "exp_month": {
+ "description": "Two-digit number representing the card's expiration month.",
+ "type": "integer"
+ },
+ "exp_year": {
+ "description": "Four-digit number representing the card's expiration year.",
+ "type": "integer"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "country": {
- "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "funding": {
+ "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "generated_card": {
+ "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"last4": {
- "description": "Last four digits of the bank account number.",
+ "description": "The last four digits of the card.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "routing_number": {
- "description": "Routing transit number of the bank account.",
+ "network": {
+ "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_details_ach_debit",
- "type": "object",
+ },
+ "preferred_locales": {
+ "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "nullable": true,
+ "type": "array"
+ },
+ "read_method": {
+ "description": "How card details were read in this transaction.",
+ "enum": [
+ "contact_emv",
+ "contactless_emv",
+ "contactless_magstripe_mode",
+ "magnetic_stripe_fallback",
+ "magnetic_stripe_track2"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "receipt": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
+ }
+ ],
+ "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
+ "nullable": true
+ }
+ },
+ "required": [
+ "exp_month",
+ "exp_year"
+ ],
+ "title": "payment_method_details_interac_present",
+ "type": "object",
"x-expandableFields": [
-
+ "receipt"
]
},
- "payment_method_details_acss_debit": {
+ "payment_method_details_interac_present_receipt": {
"description": "",
"properties": {
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
+ "account_type": {
+ "description": "The type of account being debited or credited",
+ "enum": [
+ "checking",
+ "savings",
+ "unknown"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "application_cryptogram": {
+ "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "application_preferred_name": {
+ "description": "Mnenomic of the Application Identifier.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "institution_number": {
- "description": "Institution number of the bank account",
+ "authorization_code": {
+ "description": "Identifier for this transaction.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "authorization_response_code": {
+ "description": "EMV tag 8A. A code returned by the card issuer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "mandate": {
- "description": "ID of the mandate used to make this payment.",
+ "cardholder_verification_method": {
+ "description": "How the cardholder verified ownership of the card.",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
},
- "transit_number": {
- "description": "Transit number of the bank account.",
+ "dedicated_file_name": {
+ "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "terminal_verification_results": {
+ "description": "The outcome of a series of EMV functions performed by the card reader.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "transaction_status_information": {
+ "description": "An indication of various EMV functions performed during the transaction.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_acss_debit",
+ "title": "payment_method_details_interac_present_receipt",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_affirm": {
+ "payment_method_details_klarna": {
"description": "",
"properties": {
+ "payment_method_category": {
+ "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "preferred_locale": {
+ "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
},
- "title": "payment_method_details_affirm",
+ "title": "payment_method_details_klarna",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_afterpay_clearpay": {
+ "payment_method_details_konbini": {
+ "description": "",
+ "properties": {
+ "store": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_konbini_store"
+ }
+ ],
+ "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed.",
+ "nullable": true
+ }
+ },
+ "title": "payment_method_details_konbini",
+ "type": "object",
+ "x-expandableFields": [
+ "store"
+ ]
+ },
+ "payment_method_details_konbini_store": {
"description": "",
"properties": {
+ "chain": {
+ "description": "The name of the convenience store chain where the payment was completed.",
+ "enum": [
+ "familymart",
+ "lawson",
+ "ministop",
+ "seicomart"
+ ],
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_konbini_store",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_link": {
+ "description": "",
+ "properties": {
+ },
+ "title": "payment_method_details_link",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_multibanco": {
+ "description": "",
+ "properties": {
+ "entity": {
+ "description": "Entity number associated with this Multibanco payment.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"reference": {
- "description": "Order identifier shown to the merchant in Afterpay’s online portal.",
+ "description": "Reference number associated with this Multibanco payment.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_afterpay_clearpay",
+ "title": "payment_method_details_multibanco",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_au_becs_debit": {
+ "payment_method_details_oxxo": {
"description": "",
"properties": {
- "bsb_number": {
- "description": "Bank-State-Branch number of the bank account.",
+ "number": {
+ "description": "OXXO reference number",
"maxLength": 5000,
"nullable": true,
"type": "string"
+ }
+ },
+ "title": "payment_method_details_oxxo",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_p24": {
+ "description": "",
+ "properties": {
+ "bank": {
+ "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.",
+ "enum": [
+ "alior_bank",
+ "bank_millennium",
+ "bank_nowy_bfg_sa",
+ "bank_pekao_sa",
+ "banki_spbdzielcze",
+ "blik",
+ "bnp_paribas",
+ "boz",
+ "citi_handlowy",
+ "credit_agricole",
+ "envelobank",
+ "etransfer_pocztowy24",
+ "getin_bank",
+ "ideabank",
+ "ing",
+ "inteligo",
+ "mbank_mtransfer",
+ "nest_przelew",
+ "noble_pay",
+ "pbac_z_ipko",
+ "plus_bank",
+ "santander_przelew24",
+ "tmobile_usbugi_bankowe",
+ "toyota_bank",
+ "volkswagen_bank"
+ ],
+ "nullable": true,
+ "type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "reference": {
+ "description": "Unique reference for this Przelewy24 payment.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "last4": {
- "description": "Last four digits of the bank account number.",
+ "verified_name": {
+ "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- },
- "mandate": {
- "description": "ID of the mandate used to make this payment.",
+ }
+ },
+ "title": "payment_method_details_p24",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_paynow": {
+ "description": "",
+ "properties": {
+ "reference": {
+ "description": "Reference number associated with this PayNow payment",
"maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_au_becs_debit",
+ "title": "payment_method_details_paynow",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_bacs_debit": {
+ "payment_method_details_pix": {
+ "description": "",
+ "properties": {
+ "bank_transaction_id": {
+ "description": "Unique transaction id generated by BCB",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_pix",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_promptpay": {
+ "description": "",
+ "properties": {
+ "reference": {
+ "description": "Bill reference generated by PromptPay",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "title": "payment_method_details_promptpay",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_details_sepa_debit": {
"description": "",
"properties": {
+ "bank_code": {
+ "description": "Bank code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "branch_code": {
+ "description": "Branch code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"fingerprint": {
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
"maxLength": 5000,
@@ -23402,7 +23741,7 @@
"type": "string"
},
"last4": {
- "description": "Last four digits of the bank account number.",
+ "description": "Last four characters of the IBAN.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -23412,21 +23751,15 @@
"maxLength": 5000,
"nullable": true,
"type": "string"
- },
- "sort_code": {
- "description": "Sort code of the bank account. (e.g., `10-20-30`)",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
}
},
- "title": "payment_method_details_bacs_debit",
+ "title": "payment_method_details_sepa_debit",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_bancontact": {
+ "payment_method_details_sofort": {
"description": "",
"properties": {
"bank_code": {
@@ -23447,6 +23780,12 @@
"nullable": true,
"type": "string"
},
+ "country": {
+ "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"generated_sepa_debit": {
"anyOf": [
{
@@ -23494,614 +23833,128 @@
"type": "string"
},
"preferred_language": {
- "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`",
+ "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`",
"enum": [
"de",
"en",
+ "es",
"fr",
- "nl"
+ "it",
+ "nl",
+ "pl"
],
"nullable": true,
"type": "string"
},
"verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
+ "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_bancontact",
+ "title": "payment_method_details_sofort",
"type": "object",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
},
- "payment_method_details_blik": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_blik",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_boleto": {
+ "payment_method_details_stripe_account": {
"description": "",
"properties": {
- "tax_id": {
- "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)",
- "maxLength": 5000,
- "type": "string"
- }
},
- "required": [
- "tax_id"
- ],
- "title": "payment_method_details_boleto",
+ "title": "payment_method_details_stripe_account",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_card": {
+ "payment_method_details_us_bank_account": {
"description": "",
"properties": {
- "brand": {
- "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "checks": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_checks"
- }
+ "account_holder_type": {
+ "description": "Account holder type: individual or company.",
+ "enum": [
+ "company",
+ "individual"
],
- "description": "Check results by Card networks on Card address and CVC at time of payment.",
- "nullable": true
- },
- "country": {
- "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "exp_month": {
- "description": "Two-digit number representing the card's expiration month.",
- "type": "integer"
- },
- "exp_year": {
- "description": "Four-digit number representing the card's expiration year.",
- "type": "integer"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "funding": {
- "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
- "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "installments": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_installments"
- }
+ "account_type": {
+ "description": "Account type: checkings or savings. Defaults to checking if omitted.",
+ "enum": [
+ "checking",
+ "savings"
],
- "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).",
- "nullable": true
- },
- "last4": {
- "description": "The last four digits of the card.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "mandate": {
- "description": "ID of the mandate used to make this payment or created by it.",
- "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "network": {
- "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "bank_name": {
+ "description": "Name of the bank associated with the bank account.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "three_d_secure": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/three_d_secure_details"
- }
- ],
- "description": "Populated if this transaction used 3D Secure authentication.",
- "nullable": true
- },
- "wallet": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_wallet"
- }
- ],
- "description": "If this Card is part of a card wallet, this contains the details of the card wallet.",
- "nullable": true
- }
- },
- "required": [
- "exp_month",
- "exp_year"
- ],
- "title": "payment_method_details_card",
- "type": "object",
- "x-expandableFields": [
- "checks",
- "installments",
- "three_d_secure",
- "wallet"
- ]
- },
- "payment_method_details_card_checks": {
- "description": "",
- "properties": {
- "address_line1_check": {
- "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "address_postal_code_check": {
- "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "last4": {
+ "description": "Last four digits of the bank account number.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "cvc_check": {
- "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "routing_number": {
+ "description": "Routing number of the bank account.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_card_checks",
+ "title": "payment_method_details_us_bank_account",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_card_installments": {
+ "payment_method_details_wechat": {
"description": "",
"properties": {
- "plan": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
- }
- ],
- "description": "Installment plan selected for the payment.",
- "nullable": true
- }
},
- "title": "payment_method_details_card_installments",
+ "title": "payment_method_details_wechat",
"type": "object",
"x-expandableFields": [
- "plan"
+
]
},
- "payment_method_details_card_installments_plan": {
+ "payment_method_details_wechat_pay": {
"description": "",
"properties": {
- "count": {
- "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.",
- "nullable": true,
- "type": "integer"
- },
- "interval": {
- "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.",
- "enum": [
- "month"
- ],
+ "fingerprint": {
+ "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "type": {
- "description": "Type of installment plan, one of `fixed_count`.",
- "enum": [
- "fixed_count"
- ],
+ "transaction_id": {
+ "description": "Transaction ID of this particular WeChat Pay transaction.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "required": [
- "type"
- ],
- "title": "payment_method_details_card_installments_plan",
+ "title": "payment_method_details_wechat_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_card_present": {
- "description": "",
- "properties": {
- "amount_authorized": {
- "description": "The authorized amount",
- "nullable": true,
- "type": "integer"
- },
- "brand": {
- "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "capture_before": {
- "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.",
- "format": "unix-time",
- "type": "integer"
- },
- "cardholder_name": {
- "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "country": {
- "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "emv_auth_data": {
- "description": "Authorization response cryptogram.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "exp_month": {
- "description": "Two-digit number representing the card's expiration month.",
- "type": "integer"
- },
- "exp_year": {
- "description": "Four-digit number representing the card's expiration year.",
- "type": "integer"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "funding": {
- "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "generated_card": {
- "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "incremental_authorization_supported": {
- "description": "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).",
- "type": "boolean"
- },
- "last4": {
- "description": "The last four digits of the card.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "network": {
- "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "overcapture_supported": {
- "description": "Defines whether the authorized amount can be over-captured or not",
- "type": "boolean"
- },
- "read_method": {
- "description": "How card details were read in this transaction.",
- "enum": [
- "contact_emv",
- "contactless_emv",
- "contactless_magstripe_mode",
- "magnetic_stripe_fallback",
- "magnetic_stripe_track2"
- ],
- "nullable": true,
- "type": "string"
- },
- "receipt": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_present_receipt"
- }
- ],
- "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
- "nullable": true
- }
- },
- "required": [
- "exp_month",
- "exp_year",
- "incremental_authorization_supported",
- "overcapture_supported"
- ],
- "title": "payment_method_details_card_present",
- "type": "object",
- "x-expandableFields": [
- "receipt"
- ]
- },
- "payment_method_details_card_present_receipt": {
- "description": "",
- "properties": {
- "account_type": {
- "description": "The type of account being debited or credited",
- "enum": [
- "checking",
- "credit",
- "prepaid",
- "unknown"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "application_cryptogram": {
- "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "application_preferred_name": {
- "description": "Mnenomic of the Application Identifier.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "authorization_code": {
- "description": "Identifier for this transaction.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "authorization_response_code": {
- "description": "EMV tag 8A. A code returned by the card issuer.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "cardholder_verification_method": {
- "description": "How the cardholder verified ownership of the card.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "dedicated_file_name": {
- "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "terminal_verification_results": {
- "description": "The outcome of a series of EMV functions performed by the card reader.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "transaction_status_information": {
- "description": "An indication of various EMV functions performed during the transaction.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "title": "payment_method_details_card_present_receipt",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_card_wallet": {
- "description": "",
- "properties": {
- "amex_express_checkout": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
- },
- "apple_pay": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
- },
- "dynamic_last4": {
- "description": "(For tokenized numbers only.) The last four digits of the device account number.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "google_pay": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
- },
- "masterpass": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
- },
- "samsung_pay": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
- },
- "type": {
- "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
- "enum": [
- "amex_express_checkout",
- "apple_pay",
- "google_pay",
- "masterpass",
- "samsung_pay",
- "visa_checkout"
- ],
- "type": "string"
- },
- "visa_checkout": {
- "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
- }
- },
- "required": [
- "type"
- ],
- "title": "payment_method_details_card_wallet",
- "type": "object",
- "x-expandableFields": [
- "amex_express_checkout",
- "apple_pay",
- "google_pay",
- "masterpass",
- "samsung_pay",
- "visa_checkout"
- ]
- },
- "payment_method_details_card_wallet_amex_express_checkout": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_card_wallet_amex_express_checkout",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_card_wallet_apple_pay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_card_wallet_apple_pay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_card_wallet_google_pay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_card_wallet_google_pay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_card_wallet_masterpass": {
- "description": "",
- "properties": {
- "billing_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- },
- "email": {
- "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "name": {
- "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "shipping_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- }
- },
- "title": "payment_method_details_card_wallet_masterpass",
- "type": "object",
- "x-expandableFields": [
- "billing_address",
- "shipping_address"
- ]
- },
- "payment_method_details_card_wallet_samsung_pay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_card_wallet_samsung_pay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_card_wallet_visa_checkout": {
- "description": "",
- "properties": {
- "billing_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- },
- "email": {
- "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "name": {
- "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "shipping_address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "nullable": true
- }
- },
- "title": "payment_method_details_card_wallet_visa_checkout",
- "type": "object",
- "x-expandableFields": [
- "billing_address",
- "shipping_address"
- ]
- },
- "payment_method_details_customer_balance": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_customer_balance",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_eps": {
+ "payment_method_eps": {
"description": "",
"properties": {
"bank": {
@@ -24138,25 +23991,19 @@
],
"nullable": true,
"type": "string"
- },
- "verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
}
},
- "title": "payment_method_details_eps",
+ "title": "payment_method_eps",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_fpx": {
+ "payment_method_fpx": {
"description": "",
"properties": {
"bank": {
- "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
+ "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
"enum": [
"affin_bank",
"agrobank",
@@ -24182,78 +24029,42 @@
"uob"
],
"type": "string"
- },
- "transaction_id": {
- "description": "Unique transaction id generated by FPX for every request from the merchant",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
}
},
"required": [
"bank"
],
- "title": "payment_method_details_fpx",
+ "title": "payment_method_fpx",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_giropay": {
+ "payment_method_giropay": {
"description": "",
"properties": {
- "bank_code": {
- "description": "Bank code of bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "bic": {
- "description": "Bank Identifier Code of the bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
},
- "title": "payment_method_details_giropay",
+ "title": "payment_method_giropay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_grabpay": {
+ "payment_method_grabpay": {
"description": "",
"properties": {
- "transaction_id": {
- "description": "Unique transaction id generated by GrabPay",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
},
- "title": "payment_method_details_grabpay",
+ "title": "payment_method_grabpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_ideal": {
+ "payment_method_ideal": {
"description": "",
"properties": {
"bank": {
- "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.",
+ "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.",
"enum": [
"abn_amro",
"asn_bank",
@@ -24273,7 +24084,7 @@
"type": "string"
},
"bic": {
- "description": "The Bank Identifier Code of the customer's bank.",
+ "description": "The Bank Identifier Code of the customer's bank, if the bank was provided.",
"enum": [
"ABNANL2A",
"ASNBNL21",
@@ -24291,920 +24102,624 @@
],
"nullable": true,
"type": "string"
- },
- "generated_sepa_debit": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/payment_method"
- }
- ],
- "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/payment_method"
- }
- ]
- }
- },
- "generated_sepa_debit_mandate": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/mandate"
- }
- ],
- "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/mandate"
- }
- ]
- }
- },
- "iban_last4": {
- "description": "Last four characters of the IBAN.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
}
},
- "title": "payment_method_details_ideal",
+ "title": "payment_method_ideal",
"type": "object",
"x-expandableFields": [
- "generated_sepa_debit",
- "generated_sepa_debit_mandate"
+
]
},
- "payment_method_details_interac_present": {
+ "payment_method_interac_present": {
"description": "",
"properties": {
- "brand": {
- "description": "Card brand. Can be `interac`, `mastercard` or `visa`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "cardholder_name": {
- "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "country": {
- "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "emv_auth_data": {
- "description": "Authorization response cryptogram.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "exp_month": {
- "description": "Two-digit number representing the card's expiration month.",
- "type": "integer"
- },
- "exp_year": {
- "description": "Four-digit number representing the card's expiration year.",
- "type": "integer"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "funding": {
- "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "generated_card": {
- "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "last4": {
- "description": "The last four digits of the card.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "network": {
- "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "preferred_locales": {
- "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "nullable": true,
- "type": "array"
- },
- "read_method": {
- "description": "How card details were read in this transaction.",
- "enum": [
- "contact_emv",
- "contactless_emv",
- "contactless_magstripe_mode",
- "magnetic_stripe_fallback",
- "magnetic_stripe_track2"
- ],
- "nullable": true,
- "type": "string"
- },
- "receipt": {
+ },
+ "title": "payment_method_interac_present",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_klarna": {
+ "description": "",
+ "properties": {
+ "dob": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"
}
],
- "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions.",
+ "description": "The customer's date of birth, if provided.",
"nullable": true
}
},
- "required": [
- "exp_month",
- "exp_year"
- ],
- "title": "payment_method_details_interac_present",
+ "title": "payment_method_klarna",
"type": "object",
"x-expandableFields": [
- "receipt"
+ "dob"
]
},
- "payment_method_details_interac_present_receipt": {
+ "payment_method_konbini": {
"description": "",
"properties": {
- "account_type": {
- "description": "The type of account being debited or credited",
- "enum": [
- "checking",
- "savings",
- "unknown"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "application_cryptogram": {
- "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "application_preferred_name": {
- "description": "Mnenomic of the Application Identifier.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "authorization_code": {
- "description": "Identifier for this transaction.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "authorization_response_code": {
- "description": "EMV tag 8A. A code returned by the card issuer.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "cardholder_verification_method": {
- "description": "How the cardholder verified ownership of the card.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "dedicated_file_name": {
- "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "terminal_verification_results": {
- "description": "The outcome of a series of EMV functions performed by the card reader.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "transaction_status_information": {
- "description": "An indication of various EMV functions performed during the transaction.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
},
- "title": "payment_method_details_interac_present_receipt",
+ "title": "payment_method_konbini",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_klarna": {
+ "payment_method_link": {
"description": "",
"properties": {
- "payment_method_category": {
- "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`",
+ "email": {
+ "description": "Account owner's email address.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
- "preferred_locale": {
- "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`",
+ "persistent_token": {
+ "description": "Token used for persistent Link logins.",
"maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_klarna",
+ "title": "payment_method_link",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_konbini": {
+ "payment_method_options_affirm": {
"description": "",
"properties": {
- "store": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_konbini_store"
- }
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
],
- "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed.",
- "nullable": true
- }
- },
- "title": "payment_method_details_konbini",
- "type": "object",
- "x-expandableFields": [
- "store"
- ]
- },
- "payment_method_details_konbini_store": {
- "description": "",
- "properties": {
- "chain": {
- "description": "The name of the convenience store chain where the payment was completed.",
+ "type": "string"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "familymart",
- "lawson",
- "ministop",
- "seicomart"
+ "none"
],
- "nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_konbini_store",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_details_link": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_link",
+ "title": "payment_method_options_affirm",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_multibanco": {
+ "payment_method_options_afterpay_clearpay": {
"description": "",
"properties": {
- "entity": {
- "description": "Entity number associated with this Multibanco payment.",
- "maxLength": 5000,
- "nullable": true,
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
+ ],
"type": "string"
},
"reference": {
- "description": "Reference number associated with this Multibanco payment.",
+ "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "payment_method_details_multibanco",
+ "title": "payment_method_options_afterpay_clearpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_oxxo": {
+ "payment_method_options_alipay": {
"description": "",
"properties": {
- "number": {
- "description": "OXXO reference number",
- "maxLength": 5000,
- "nullable": true,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session"
+ ],
"type": "string"
}
},
- "title": "payment_method_details_oxxo",
+ "title": "payment_method_options_alipay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_p24": {
+ "payment_method_options_bacs_debit": {
"description": "",
"properties": {
- "bank": {
- "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "alior_bank",
- "bank_millennium",
- "bank_nowy_bfg_sa",
- "bank_pekao_sa",
- "banki_spbdzielcze",
- "blik",
- "bnp_paribas",
- "boz",
- "citi_handlowy",
- "credit_agricole",
- "envelobank",
- "etransfer_pocztowy24",
- "getin_bank",
- "ideabank",
- "ing",
- "inteligo",
- "mbank_mtransfer",
- "nest_przelew",
- "noble_pay",
- "pbac_z_ipko",
- "plus_bank",
- "santander_przelew24",
- "tmobile_usbugi_bankowe",
- "toyota_bank",
- "volkswagen_bank"
+ "none",
+ "off_session",
+ "on_session"
],
- "nullable": true,
- "type": "string"
- },
- "reference": {
- "description": "Unique reference for this Przelewy24 payment.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.",
- "maxLength": 5000,
- "nullable": true,
"type": "string"
}
},
- "title": "payment_method_details_p24",
+ "title": "payment_method_options_bacs_debit",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_paynow": {
+ "payment_method_options_bancontact": {
"description": "",
"properties": {
- "reference": {
- "description": "Reference number associated with this PayNow payment",
- "maxLength": 5000,
- "nullable": true,
+ "preferred_language": {
+ "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
+ "enum": [
+ "de",
+ "en",
+ "fr",
+ "nl"
+ ],
+ "type": "string"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session"
+ ],
"type": "string"
}
},
- "title": "payment_method_details_paynow",
+ "required": [
+ "preferred_language"
+ ],
+ "title": "payment_method_options_bancontact",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_pix": {
+ "payment_method_options_boleto": {
"description": "",
"properties": {
- "bank_transaction_id": {
- "description": "Unique transaction id generated by BCB",
- "maxLength": 5000,
- "nullable": true,
+ "expires_after_days": {
+ "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.",
+ "type": "integer"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session",
+ "on_session"
+ ],
"type": "string"
}
},
- "title": "payment_method_details_pix",
+ "required": [
+ "expires_after_days"
+ ],
+ "title": "payment_method_options_boleto",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_promptpay": {
+ "payment_method_options_card_installments": {
"description": "",
"properties": {
- "reference": {
- "description": "Bill reference generated by PromptPay",
- "maxLength": 5000,
+ "available_plans": {
+ "description": "Installment plans that may be selected for this PaymentIntent.",
+ "items": {
+ "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
+ },
"nullable": true,
- "type": "string"
+ "type": "array"
+ },
+ "enabled": {
+ "description": "Whether Installments are enabled for this PaymentIntent.",
+ "type": "boolean"
+ },
+ "plan": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
+ }
+ ],
+ "description": "Installment plan selected for this PaymentIntent.",
+ "nullable": true
}
},
- "title": "payment_method_details_promptpay",
+ "required": [
+ "enabled"
+ ],
+ "title": "payment_method_options_card_installments",
"type": "object",
"x-expandableFields": [
-
+ "available_plans",
+ "plan"
]
},
- "payment_method_details_sepa_debit": {
+ "payment_method_options_card_mandate_options": {
"description": "",
"properties": {
- "bank_code": {
- "description": "Bank code of bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "amount": {
+ "description": "Amount to be charged for future payments.",
+ "type": "integer"
},
- "branch_code": {
- "description": "Branch code of bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
+ "amount_type": {
+ "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.",
+ "enum": [
+ "fixed",
+ "maximum"
+ ],
"type": "string"
},
- "country": {
- "description": "Two-letter ISO code representing the country the bank account is located in.",
- "maxLength": 5000,
+ "description": {
+ "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
+ "maxLength": 200,
"nullable": true,
"type": "string"
},
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
+ "end_date": {
+ "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.",
+ "format": "unix-time",
"nullable": true,
+ "type": "integer"
+ },
+ "interval": {
+ "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
+ "enum": [
+ "day",
+ "month",
+ "sporadic",
+ "week",
+ "year"
+ ],
"type": "string"
},
- "last4": {
- "description": "Last four characters of the IBAN.",
- "maxLength": 5000,
+ "interval_count": {
+ "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.",
"nullable": true,
+ "type": "integer"
+ },
+ "reference": {
+ "description": "Unique identifier for the mandate or subscription.",
+ "maxLength": 80,
"type": "string"
},
- "mandate": {
- "description": "ID of the mandate used to make this payment.",
- "maxLength": 5000,
+ "start_date": {
+ "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "supported_types": {
+ "description": "Specifies the type of mandates supported. Possible values are `india`.",
+ "items": {
+ "enum": [
+ "india"
+ ],
+ "type": "string"
+ },
"nullable": true,
- "type": "string"
+ "type": "array"
}
},
- "title": "payment_method_details_sepa_debit",
+ "required": [
+ "amount",
+ "amount_type",
+ "interval",
+ "reference",
+ "start_date"
+ ],
+ "title": "payment_method_options_card_mandate_options",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_sofort": {
+ "payment_method_options_card_present": {
"description": "",
"properties": {
- "bank_code": {
- "description": "Bank code of bank associated with the bank account.",
- "maxLength": 5000,
+ "request_extended_authorization": {
+ "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
"nullable": true,
- "type": "string"
+ "type": "boolean"
},
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
- "maxLength": 5000,
+ "request_incremental_authorization_support": {
+ "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
"nullable": true,
- "type": "string"
+ "type": "boolean"
+ }
+ },
+ "title": "payment_method_options_card_present",
+ "type": "object",
+ "x-expandableFields": [
+
+ ]
+ },
+ "payment_method_options_customer_balance": {
+ "description": "",
+ "properties": {
+ "bank_transfer": {
+ "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
},
- "bic": {
- "description": "Bank Identifier Code of the bank associated with the bank account.",
- "maxLength": 5000,
+ "funding_type": {
+ "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
+ "enum": [
+ "bank_transfer"
+ ],
"nullable": true,
"type": "string"
},
- "country": {
- "description": "Two-letter ISO code representing the country the bank account is located in.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "generated_sepa_debit": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/payment_method"
- }
- ],
- "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/payment_method"
- }
- ]
- }
- },
- "generated_sepa_debit_mandate": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/mandate"
- }
- ],
- "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/mandate"
- }
- ]
- }
- },
- "iban_last4": {
- "description": "Last four characters of the IBAN.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "preferred_language": {
- "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`",
- "enum": [
- "de",
- "en",
- "es",
- "fr",
- "it",
- "nl",
- "pl"
- ],
- "nullable": true,
- "type": "string"
- },
- "verified_name": {
- "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.",
- "maxLength": 5000,
- "nullable": true,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
"type": "string"
}
},
- "title": "payment_method_details_sofort",
- "type": "object",
- "x-expandableFields": [
- "generated_sepa_debit",
- "generated_sepa_debit_mandate"
- ]
- },
- "payment_method_details_stripe_account": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_details_stripe_account",
+ "title": "payment_method_options_customer_balance",
"type": "object",
"x-expandableFields": [
-
+ "bank_transfer"
]
},
- "payment_method_details_us_bank_account": {
+ "payment_method_options_customer_balance_bank_transfer": {
"description": "",
"properties": {
- "account_holder_type": {
- "description": "Account holder type: individual or company.",
- "enum": [
- "company",
- "individual"
- ],
- "nullable": true,
- "type": "string"
+ "eu_bank_transfer": {
+ "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
},
- "account_type": {
- "description": "Account type: checkings or savings. Defaults to checking if omitted.",
+ "requested_address_types": {
+ "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
+ "items": {
+ "enum": [
+ "iban",
+ "sepa",
+ "sort_code",
+ "spei",
+ "zengin"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.",
"enum": [
- "checking",
- "savings"
+ "eu_bank_transfer",
+ "gb_bank_transfer",
+ "jp_bank_transfer",
+ "mx_bank_transfer"
],
"nullable": true,
- "type": "string"
- },
- "bank_name": {
- "description": "Name of the bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "last4": {
- "description": "Last four digits of the bank account number.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "routing_number": {
- "description": "Routing number of the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "payment_method_details_us_bank_account",
+ "title": "payment_method_options_customer_balance_bank_transfer",
"type": "object",
"x-expandableFields": [
-
+ "eu_bank_transfer"
]
},
- "payment_method_details_wechat": {
+ "payment_method_options_customer_balance_eu_bank_account": {
"description": "",
"properties": {
+ "country": {
+ "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
+ "enum": [
+ "DE",
+ "ES",
+ "FR",
+ "IE",
+ "NL"
+ ],
+ "type": "string"
+ }
},
- "title": "payment_method_details_wechat",
+ "required": [
+ "country"
+ ],
+ "title": "payment_method_options_customer_balance_eu_bank_account",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_details_wechat_pay": {
+ "payment_method_options_fpx": {
"description": "",
"properties": {
- "fingerprint": {
- "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "transaction_id": {
- "description": "Transaction ID of this particular WeChat Pay transaction.",
- "maxLength": 5000,
- "nullable": true,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
"type": "string"
}
},
- "title": "payment_method_details_wechat_pay",
+ "title": "payment_method_options_fpx",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_eps": {
+ "payment_method_options_giropay": {
"description": "",
"properties": {
- "bank": {
- "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "arzte_und_apotheker_bank",
- "austrian_anadi_bank_ag",
- "bank_austria",
- "bankhaus_carl_spangler",
- "bankhaus_schelhammer_und_schattera_ag",
- "bawag_psk_ag",
- "bks_bank_ag",
- "brull_kallmus_bank_ag",
- "btv_vier_lander_bank",
- "capital_bank_grawe_gruppe_ag",
- "deutsche_bank_ag",
- "dolomitenbank",
- "easybank_ag",
- "erste_bank_und_sparkassen",
- "hypo_alpeadriabank_international_ag",
- "hypo_bank_burgenland_aktiengesellschaft",
- "hypo_noe_lb_fur_niederosterreich_u_wien",
- "hypo_oberosterreich_salzburg_steiermark",
- "hypo_tirol_bank_ag",
- "hypo_vorarlberg_bank_ag",
- "marchfelder_bank",
- "oberbank_ag",
- "raiffeisen_bankengruppe_osterreich",
- "schoellerbank_ag",
- "sparda_bank_wien",
- "volksbank_gruppe",
- "volkskreditbank_ag",
- "vr_bank_braunau"
+ "none"
],
- "nullable": true,
"type": "string"
}
},
- "title": "payment_method_eps",
+ "title": "payment_method_options_giropay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_fpx": {
+ "payment_method_options_grabpay": {
"description": "",
"properties": {
- "bank": {
- "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "affin_bank",
- "agrobank",
- "alliance_bank",
- "ambank",
- "bank_islam",
- "bank_muamalat",
- "bank_of_china",
- "bank_rakyat",
- "bsn",
- "cimb",
- "deutsche_bank",
- "hong_leong_bank",
- "hsbc",
- "kfh",
- "maybank2e",
- "maybank2u",
- "ocbc",
- "pb_enterprise",
- "public_bank",
- "rhb",
- "standard_chartered",
- "uob"
+ "none"
],
"type": "string"
}
},
- "required": [
- "bank"
- ],
- "title": "payment_method_fpx",
+ "title": "payment_method_options_grabpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_giropay": {
+ "payment_method_options_ideal": {
"description": "",
"properties": {
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
},
- "title": "payment_method_giropay",
+ "title": "payment_method_options_ideal",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_grabpay": {
+ "payment_method_options_interac_present": {
"description": "",
"properties": {
},
- "title": "payment_method_grabpay",
+ "title": "payment_method_options_interac_present",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_ideal": {
+ "payment_method_options_klarna": {
"description": "",
"properties": {
- "bank": {
- "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.",
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
"enum": [
- "abn_amro",
- "asn_bank",
- "bunq",
- "handelsbanken",
- "ing",
- "knab",
- "moneyou",
- "rabobank",
- "regiobank",
- "revolut",
- "sns_bank",
- "triodos_bank",
- "van_lanschot"
+ "manual"
],
+ "type": "string"
+ },
+ "preferred_locale": {
+ "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.",
+ "maxLength": 5000,
"nullable": true,
"type": "string"
},
- "bic": {
- "description": "The Bank Identifier Code of the customer's bank, if the bank was provided.",
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "ABNANL2A",
- "ASNBNL21",
- "BUNQNL2A",
- "FVLBNL22",
- "HANDNL2A",
- "INGBNL2A",
- "KNABNL2H",
- "MOYONL21",
- "RABONL2U",
- "RBRBNL21",
- "REVOLT21",
- "SNSBNL2A",
- "TRIONL2U"
+ "none"
],
- "nullable": true,
"type": "string"
}
},
- "title": "payment_method_ideal",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_interac_present": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_interac_present",
+ "title": "payment_method_options_klarna",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_klarna": {
+ "payment_method_options_konbini": {
"description": "",
"properties": {
- "dob": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"
- }
+ "confirmation_number": {
+ "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "expires_after_days": {
+ "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "expires_at": {
+ "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "product_description": {
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
],
- "description": "The customer's date of birth, if provided.",
- "nullable": true
+ "type": "string"
}
},
- "title": "payment_method_klarna",
- "type": "object",
- "x-expandableFields": [
- "dob"
- ]
- },
- "payment_method_konbini": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_konbini",
+ "title": "payment_method_options_konbini",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_link": {
+ "payment_method_options_oxxo": {
"description": "",
"properties": {
- "email": {
- "description": "Account owner's email address.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "expires_after_days": {
+ "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.",
+ "type": "integer"
},
- "persistent_token": {
- "description": "Token used for persistent Link logins.",
- "maxLength": 5000,
+ "setup_future_usage": {
+ "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "enum": [
+ "none"
+ ],
"type": "string"
}
},
- "title": "payment_method_link",
+ "required": [
+ "expires_after_days"
+ ],
+ "title": "payment_method_options_oxxo",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_affirm": {
+ "payment_method_options_p24": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
- "type": "string"
- },
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
@@ -25213,91 +24728,88 @@
"type": "string"
}
},
- "title": "payment_method_options_affirm",
+ "title": "payment_method_options_p24",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_afterpay_clearpay": {
+ "payment_method_options_paynow": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
- "type": "string"
- },
- "reference": {
- "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
"none"
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
}
},
- "title": "payment_method_options_afterpay_clearpay",
+ "title": "payment_method_options_paynow",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_alipay": {
+ "payment_method_options_pix": {
"description": "",
"properties": {
+ "expires_after_seconds": {
+ "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "expires_at": {
+ "description": "The timestamp at which the Pix expires.",
+ "nullable": true,
+ "type": "integer"
+ },
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "none",
- "off_session"
+ "none"
],
"type": "string"
}
},
- "title": "payment_method_options_alipay",
+ "title": "payment_method_options_pix",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_bacs_debit": {
+ "payment_method_options_promptpay": {
"description": "",
"properties": {
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "none",
- "off_session",
- "on_session"
+ "none"
],
"type": "string"
}
},
- "title": "payment_method_options_bacs_debit",
+ "title": "payment_method_options_promptpay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_bancontact": {
+ "payment_method_options_sofort": {
"description": "",
"properties": {
"preferred_language": {
- "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.",
+ "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.",
"enum": [
"de",
"en",
+ "es",
"fr",
- "nl"
+ "it",
+ "nl",
+ "pl"
],
+ "nullable": true,
"type": "string"
},
"setup_future_usage": {
@@ -25309,996 +24821,436 @@
"type": "string"
}
},
- "required": [
- "preferred_language"
- ],
- "title": "payment_method_options_bancontact",
+ "title": "payment_method_options_sofort",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_boleto": {
+ "payment_method_options_wechat_pay": {
"description": "",
"properties": {
- "expires_after_days": {
- "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.",
- "type": "integer"
+ "app_id": {
+ "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "client": {
+ "description": "The client type that the end customer will pay from",
+ "enum": [
+ "android",
+ "ios",
+ "web"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
"enum": [
- "none",
- "off_session",
- "on_session"
+ "none"
],
"type": "string"
}
},
- "required": [
- "expires_after_days"
- ],
- "title": "payment_method_options_boleto",
+ "title": "payment_method_options_wechat_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_card_installments": {
+ "payment_method_oxxo": {
"description": "",
"properties": {
- "available_plans": {
- "description": "Installment plans that may be selected for this PaymentIntent.",
- "items": {
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
- },
- "nullable": true,
- "type": "array"
- },
- "enabled": {
- "description": "Whether Installments are enabled for this PaymentIntent.",
- "type": "boolean"
- },
- "plan": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
- }
- ],
- "description": "Installment plan selected for this PaymentIntent.",
- "nullable": true
- }
},
- "required": [
- "enabled"
- ],
- "title": "payment_method_options_card_installments",
+ "title": "payment_method_oxxo",
"type": "object",
"x-expandableFields": [
- "available_plans",
- "plan"
+
]
},
- "payment_method_options_card_mandate_options": {
+ "payment_method_p24": {
"description": "",
"properties": {
- "amount": {
- "description": "Amount to be charged for future payments.",
- "type": "integer"
- },
- "amount_type": {
- "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.",
- "enum": [
- "fixed",
- "maximum"
- ],
- "type": "string"
- },
- "description": {
- "description": "A description of the mandate or subscription that is meant to be displayed to the customer.",
- "maxLength": 200,
- "nullable": true,
- "type": "string"
- },
- "end_date": {
- "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "interval": {
- "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.",
+ "bank": {
+ "description": "The customer's bank, if provided.",
"enum": [
- "day",
- "month",
- "sporadic",
- "week",
- "year"
+ "alior_bank",
+ "bank_millennium",
+ "bank_nowy_bfg_sa",
+ "bank_pekao_sa",
+ "banki_spbdzielcze",
+ "blik",
+ "bnp_paribas",
+ "boz",
+ "citi_handlowy",
+ "credit_agricole",
+ "envelobank",
+ "etransfer_pocztowy24",
+ "getin_bank",
+ "ideabank",
+ "ing",
+ "inteligo",
+ "mbank_mtransfer",
+ "nest_przelew",
+ "noble_pay",
+ "pbac_z_ipko",
+ "plus_bank",
+ "santander_przelew24",
+ "tmobile_usbugi_bankowe",
+ "toyota_bank",
+ "volkswagen_bank"
],
- "type": "string"
- },
- "interval_count": {
- "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.",
- "nullable": true,
- "type": "integer"
- },
- "reference": {
- "description": "Unique identifier for the mandate or subscription.",
- "maxLength": 80,
- "type": "string"
- },
- "start_date": {
- "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday.",
- "format": "unix-time",
- "type": "integer"
- },
- "supported_types": {
- "description": "Specifies the type of mandates supported. Possible values are `india`.",
- "items": {
- "enum": [
- "india"
- ],
- "type": "string"
- },
"nullable": true,
- "type": "array"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "required": [
- "amount",
- "amount_type",
- "interval",
- "reference",
- "start_date"
- ],
- "title": "payment_method_options_card_mandate_options",
+ "title": "payment_method_p24",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_card_present": {
+ "payment_method_paynow": {
"description": "",
"properties": {
- "request_extended_authorization": {
- "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
- "nullable": true,
- "type": "boolean"
- },
- "request_incremental_authorization_support": {
- "description": "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.",
- "nullable": true,
- "type": "boolean"
- }
},
- "title": "payment_method_options_card_present",
+ "title": "payment_method_paynow",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_customer_balance": {
+ "payment_method_pix": {
"description": "",
"properties": {
- "bank_transfer": {
- "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
- },
- "funding_type": {
- "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.",
- "enum": [
- "bank_transfer"
- ],
- "nullable": true,
- "type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
- }
},
- "title": "payment_method_options_customer_balance",
+ "title": "payment_method_pix",
"type": "object",
"x-expandableFields": [
- "bank_transfer"
+
]
},
- "payment_method_options_customer_balance_bank_transfer": {
+ "payment_method_promptpay": {
"description": "",
"properties": {
- "eu_bank_transfer": {
- "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
- },
- "requested_address_types": {
- "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.",
- "items": {
- "enum": [
- "iban",
- "sepa",
- "sort_code",
- "spei",
- "zengin"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "type": {
- "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.",
- "enum": [
- "eu_bank_transfer",
- "gb_bank_transfer",
- "jp_bank_transfer",
- "mx_bank_transfer"
- ],
- "nullable": true,
- "type": "string",
- "x-stripeBypassValidation": true
- }
},
- "title": "payment_method_options_customer_balance_bank_transfer",
+ "title": "payment_method_promptpay",
"type": "object",
"x-expandableFields": [
- "eu_bank_transfer"
+
]
},
- "payment_method_options_customer_balance_eu_bank_account": {
+ "payment_method_sepa_debit": {
"description": "",
"properties": {
+ "bank_code": {
+ "description": "Bank code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "branch_code": {
+ "description": "Branch code of bank associated with the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"country": {
- "description": "The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.",
- "enum": [
- "DE",
- "ES",
- "FR",
- "IE",
- "NL"
+ "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "generated_from": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/sepa_debit_generated_from"
+ }
],
+ "description": "Information about the object that generated this PaymentMethod.",
+ "nullable": true
+ },
+ "last4": {
+ "description": "Last four characters of the IBAN.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "required": [
- "country"
- ],
- "title": "payment_method_options_customer_balance_eu_bank_account",
+ "title": "payment_method_sepa_debit",
"type": "object",
"x-expandableFields": [
-
+ "generated_from"
]
},
- "payment_method_options_fpx": {
+ "payment_method_sofort": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
+ "country": {
+ "description": "Two-letter ISO code representing the country the bank account is located in.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_method_options_fpx",
+ "title": "payment_method_sofort",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_giropay": {
+ "payment_method_us_bank_account": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "account_holder_type": {
+ "description": "Account holder type: individual or company.",
"enum": [
- "none"
+ "company",
+ "individual"
],
+ "nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_options_giropay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_grabpay": {
- "description": "",
- "properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ },
+ "account_type": {
+ "description": "Account type: checkings or savings. Defaults to checking if omitted.",
"enum": [
- "none"
+ "checking",
+ "savings"
],
+ "nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_options_grabpay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_ideal": {
- "description": "",
- "properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session"
+ },
+ "bank_name": {
+ "description": "The name of the bank.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "financial_connections_account": {
+ "description": "The ID of the Financial Connections Account used to create the payment method.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "last4": {
+ "description": "Last four digits of the bank account number.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "networks": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/us_bank_account_networks"
+ }
],
+ "description": "Contains information about US bank account networks that can be used.",
+ "nullable": true
+ },
+ "routing_number": {
+ "description": "Routing number of the bank account.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_method_options_ideal",
+ "title": "payment_method_us_bank_account",
"type": "object",
"x-expandableFields": [
-
+ "networks"
]
},
- "payment_method_options_interac_present": {
+ "payment_method_wechat_pay": {
"description": "",
"properties": {
},
- "title": "payment_method_options_interac_present",
+ "title": "payment_method_wechat_pay",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_klarna": {
+ "payment_pages_checkout_session_after_expiration": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
- ],
- "type": "string"
- },
- "preferred_locale": {
- "description": "Preferred locale of the Klarna checkout page that the customer is redirected to.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
+ "recovery": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"
+ }
],
- "type": "string"
+ "description": "When set, configuration used to recover the Checkout Session on expiry.",
+ "nullable": true
}
},
- "title": "payment_method_options_klarna",
+ "title": "PaymentPagesCheckoutSessionAfterExpiration",
"type": "object",
"x-expandableFields": [
-
+ "recovery"
]
},
- "payment_method_options_konbini": {
+ "payment_pages_checkout_session_after_expiration_recovery": {
"description": "",
"properties": {
- "confirmation_number": {
- "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "allow_promotion_codes": {
+ "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`",
+ "type": "boolean"
},
- "expires_after_days": {
- "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.",
- "nullable": true,
- "type": "integer"
+ "enabled": {
+ "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.",
+ "type": "boolean"
},
"expires_at": {
- "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.",
+ "description": "The timestamp at which the recovery URL will expire.",
"format": "unix-time",
"nullable": true,
"type": "integer"
},
- "product_description": {
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
+ "url": {
+ "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session",
"maxLength": 5000,
"nullable": true,
"type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
}
},
- "title": "payment_method_options_konbini",
+ "required": [
+ "allow_promotion_codes",
+ "enabled"
+ ],
+ "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_oxxo": {
+ "payment_pages_checkout_session_automatic_tax": {
"description": "",
"properties": {
- "expires_after_days": {
- "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.",
- "type": "integer"
+ "enabled": {
+ "description": "Indicates whether automatic tax is enabled for the session",
+ "type": "boolean"
},
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "status": {
+ "description": "The status of the most recent automated tax calculation for this session.",
"enum": [
- "none"
+ "complete",
+ "failed",
+ "requires_location_inputs"
],
+ "nullable": true,
"type": "string"
}
},
"required": [
- "expires_after_days"
+ "enabled"
],
- "title": "payment_method_options_oxxo",
+ "title": "PaymentPagesCheckoutSessionAutomaticTax",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_p24": {
+ "payment_pages_checkout_session_consent": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "promotions": {
+ "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.",
"enum": [
- "none"
+ "opt_in",
+ "opt_out"
],
+ "nullable": true,
"type": "string"
+ },
+ "terms_of_service": {
+ "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.",
+ "enum": [
+ "accepted"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "title": "payment_method_options_p24",
+ "title": "PaymentPagesCheckoutSessionConsent",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_paynow": {
+ "payment_pages_checkout_session_consent_collection": {
"description": "",
"properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
+ "promotions": {
+ "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
"enum": [
+ "auto",
"none"
],
+ "nullable": true,
+ "type": "string"
+ },
+ "terms_of_service": {
+ "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay.",
+ "enum": [
+ "none",
+ "required"
+ ],
+ "nullable": true,
"type": "string"
}
},
- "title": "payment_method_options_paynow",
+ "title": "PaymentPagesCheckoutSessionConsentCollection",
"type": "object",
"x-expandableFields": [
]
},
- "payment_method_options_paypal": {
+ "payment_pages_checkout_session_customer_details": {
"description": "",
"properties": {
- "capture_method": {
- "description": "Controls when the funds will be captured from the customer's account.",
- "enum": [
- "manual"
+ "address": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/address"
+ }
],
- "type": "string"
+ "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
+ "nullable": true
},
- "preferred_locale": {
- "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.",
+ "email": {
+ "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.",
"maxLength": 5000,
"nullable": true,
"type": "string"
- }
- },
- "title": "payment_method_options_paypal",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_pix": {
- "description": "",
- "properties": {
- "expires_after_seconds": {
- "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire.",
+ },
+ "name": {
+ "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
+ "maxLength": 5000,
"nullable": true,
- "type": "integer"
+ "type": "string"
},
- "expires_at": {
- "description": "The timestamp at which the Pix expires.",
+ "phone": {
+ "description": "The customer's phone number after a completed Checkout Session.",
+ "maxLength": 5000,
"nullable": true,
- "type": "integer"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_pix",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_promptpay": {
- "description": "",
- "properties": {
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_promptpay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_sofort": {
- "description": "",
- "properties": {
- "preferred_language": {
- "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.",
- "enum": [
- "de",
- "en",
- "es",
- "fr",
- "it",
- "nl",
- "pl"
- ],
- "nullable": true,
- "type": "string"
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_sofort",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_options_wechat_pay": {
- "description": "",
- "properties": {
- "app_id": {
- "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "client": {
- "description": "The client type that the end customer will pay from",
- "enum": [
- "android",
- "ios",
- "web"
- ],
- "nullable": true,
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "setup_future_usage": {
- "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).",
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_wechat_pay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_oxxo": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_oxxo",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_p24": {
- "description": "",
- "properties": {
- "bank": {
- "description": "The customer's bank, if provided.",
- "enum": [
- "alior_bank",
- "bank_millennium",
- "bank_nowy_bfg_sa",
- "bank_pekao_sa",
- "banki_spbdzielcze",
- "blik",
- "bnp_paribas",
- "boz",
- "citi_handlowy",
- "credit_agricole",
- "envelobank",
- "etransfer_pocztowy24",
- "getin_bank",
- "ideabank",
- "ing",
- "inteligo",
- "mbank_mtransfer",
- "nest_przelew",
- "noble_pay",
- "pbac_z_ipko",
- "plus_bank",
- "santander_przelew24",
- "tmobile_usbugi_bankowe",
- "toyota_bank",
- "volkswagen_bank"
- ],
- "nullable": true,
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "title": "payment_method_p24",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_paynow": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_paynow",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_pix": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_pix",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_promptpay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_promptpay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_sepa_debit": {
- "description": "",
- "properties": {
- "bank_code": {
- "description": "Bank code of bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "branch_code": {
- "description": "Branch code of bank associated with the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "country": {
- "description": "Two-letter ISO code representing the country the bank account is located in.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "generated_from": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/sepa_debit_generated_from"
- }
- ],
- "description": "Information about the object that generated this PaymentMethod.",
- "nullable": true
- },
- "last4": {
- "description": "Last four characters of the IBAN.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "title": "payment_method_sepa_debit",
- "type": "object",
- "x-expandableFields": [
- "generated_from"
- ]
- },
- "payment_method_sofort": {
- "description": "",
- "properties": {
- "country": {
- "description": "Two-letter ISO code representing the country the bank account is located in.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "title": "payment_method_sofort",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_method_us_bank_account": {
- "description": "",
- "properties": {
- "account_holder_type": {
- "description": "Account holder type: individual or company.",
- "enum": [
- "company",
- "individual"
- ],
- "nullable": true,
- "type": "string"
- },
- "account_type": {
- "description": "Account type: checkings or savings. Defaults to checking if omitted.",
- "enum": [
- "checking",
- "savings"
- ],
- "nullable": true,
- "type": "string"
- },
- "bank_name": {
- "description": "The name of the bank.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "financial_connections_account": {
- "description": "The ID of the Financial Connections Account used to create the payment method.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "fingerprint": {
- "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "last4": {
- "description": "Last four digits of the bank account number.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "networks": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/us_bank_account_networks"
- }
- ],
- "description": "Contains information about US bank account networks that can be used.",
- "nullable": true
- },
- "routing_number": {
- "description": "Routing number of the bank account.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "title": "payment_method_us_bank_account",
- "type": "object",
- "x-expandableFields": [
- "networks"
- ]
- },
- "payment_method_wechat_pay": {
- "description": "",
- "properties": {
- },
- "title": "payment_method_wechat_pay",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_pages_checkout_session_after_expiration": {
- "description": "",
- "properties": {
- "recovery": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"
- }
- ],
- "description": "When set, configuration used to recover the Checkout Session on expiry.",
- "nullable": true
- }
- },
- "title": "PaymentPagesCheckoutSessionAfterExpiration",
- "type": "object",
- "x-expandableFields": [
- "recovery"
- ]
- },
- "payment_pages_checkout_session_after_expiration_recovery": {
- "description": "",
- "properties": {
- "allow_promotion_codes": {
- "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`",
- "type": "boolean"
- },
- "enabled": {
- "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.",
- "type": "boolean"
- },
- "expires_at": {
- "description": "The timestamp at which the recovery URL will expire.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "url": {
- "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "required": [
- "allow_promotion_codes",
- "enabled"
- ],
- "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_pages_checkout_session_automatic_tax": {
- "description": "",
- "properties": {
- "enabled": {
- "description": "Indicates whether automatic tax is enabled for the session",
- "type": "boolean"
- },
- "status": {
- "description": "The status of the most recent automated tax calculation for this session.",
- "enum": [
- "complete",
- "failed",
- "requires_location_inputs"
- ],
- "nullable": true,
- "type": "string"
- }
- },
- "required": [
- "enabled"
- ],
- "title": "PaymentPagesCheckoutSessionAutomaticTax",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_pages_checkout_session_consent": {
- "description": "",
- "properties": {
- "promotions": {
- "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.",
- "enum": [
- "opt_in",
- "opt_out"
- ],
- "nullable": true,
- "type": "string"
- },
- "terms_of_service": {
- "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.",
- "enum": [
- "accepted"
- ],
- "nullable": true,
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "title": "PaymentPagesCheckoutSessionConsent",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_pages_checkout_session_consent_collection": {
- "description": "",
- "properties": {
- "promotions": {
- "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
- "enum": [
- "auto",
- "none"
- ],
- "nullable": true,
- "type": "string"
- },
- "terms_of_service": {
- "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay.",
- "enum": [
- "none",
- "required"
- ],
- "nullable": true,
- "type": "string"
- }
- },
- "title": "PaymentPagesCheckoutSessionConsentCollection",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
- "payment_pages_checkout_session_customer_details": {
- "description": "",
- "properties": {
- "address": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/address"
- }
- ],
- "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
- "nullable": true
- },
- "email": {
- "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "name": {
- "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "phone": {
- "description": "The customer's phone number after a completed Checkout Session.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
+ "type": "string"
},
"tax_exempt": {
"description": "The customer’s tax exempt status after a completed Checkout Session.",
@@ -29832,7 +28784,7 @@
]
},
"refund": {
- "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nStripe Tax users with recurring payments and invoices can create [Credit Notes](https://stripe.com/docs/api/credit_notes),\nwhich reduce overall tax liability because tax is correctly recalculated and\napportioned to the related invoice.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds).",
+ "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds).",
"properties": {
"amount": {
"description": "Amount, in %s.",
@@ -32383,153 +31335,6 @@
]
},
- "sku": {
- "description": "Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit).\nSKUs describe specific product variations, taking into account any combination of: attributes,\ncurrency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents\nthe `size: large`, `color: red` version of that shirt.\n\nCan also be used to manage inventory.",
- "properties": {
- "active": {
- "description": "Whether the SKU is available for purchase.",
- "type": "boolean"
- },
- "attributes": {
- "additionalProperties": {
- "maxLength": 5000,
- "type": "string"
- },
- "description": "A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `[\"size\", \"gender\"]`, a valid SKU has the following dictionary of attributes: `{\"size\": \"Medium\", \"gender\": \"Unisex\"}`.",
- "type": "object"
- },
- "created": {
- "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
- "format": "unix-time",
- "type": "integer"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the object.",
- "maxLength": 5000,
- "type": "string"
- },
- "image": {
- "description": "The URL of an image for this SKU, meant to be displayable to the customer.",
- "maxLength": 2048,
- "nullable": true,
- "type": "string"
- },
- "inventory": {
- "$ref": "#/components/schemas/sku_inventory"
- },
- "livemode": {
- "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
- "type": "boolean"
- },
- "metadata": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "type": "object"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value.",
- "enum": [
- "sku"
- ],
- "type": "string"
- },
- "package_dimensions": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/package_dimensions"
- }
- ],
- "description": "The dimensions of this SKU for shipping purposes.",
- "nullable": true
- },
- "price": {
- "description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
- "type": "integer"
- },
- "product": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/product"
- }
- ],
- "description": "The ID of the product this SKU is associated with. The product must be currently active.",
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/product"
- }
- ]
- }
- },
- "updated": {
- "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.",
- "format": "unix-time",
- "type": "integer"
- }
- },
- "required": [
- "active",
- "attributes",
- "created",
- "currency",
- "id",
- "inventory",
- "livemode",
- "metadata",
- "object",
- "price",
- "product",
- "updated"
- ],
- "title": "Sku",
- "type": "object",
- "x-expandableFields": [
- "inventory",
- "package_dimensions",
- "product"
- ],
- "x-resourceId": "sku"
- },
- "sku_inventory": {
- "description": "",
- "properties": {
- "quantity": {
- "description": "The count of inventory available. Will be present if and only if `type` is `finite`.",
- "nullable": true,
- "type": "integer"
- },
- "type": {
- "description": "Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`.",
- "maxLength": 5000,
- "type": "string"
- },
- "value": {
- "description": "An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "SKUInventory",
- "type": "object",
- "x-expandableFields": [
-
- ]
- },
"source": {
"description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).",
"properties": {
@@ -40279,7 +39084,7 @@
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
"title": "Stripe API",
- "version": "2022-08-01",
+ "version": "2022-11-15",
"x-stripeSpecFilename": "spec3"
},
"openapi": "3.0.0",
@@ -80634,3695 +79439,119 @@
},
"/v1/link_account_sessions": {
"post": {
- "description": "To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
",
- "operationId": "PostLinkAccountSessions",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "account_holder": {
- "explode": true,
- "style": "deepObject"
- },
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "filters": {
- "explode": true,
- "style": "deepObject"
- },
- "permissions": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "account_holder": {
- "description": "The account holder to link accounts for.",
- "properties": {
- "account": {
- "maxLength": 5000,
- "type": "string"
- },
- "customer": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": {
- "enum": [
- "account",
- "customer"
- ],
- "type": "string"
- }
- },
- "required": [
- "type"
- ],
- "title": "accountholder_params",
- "type": "object"
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "filters": {
- "description": "Filters to restrict the kinds of accounts to collect.",
- "properties": {
- "countries": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "countries"
- ],
- "title": "filters_params",
- "type": "object"
- },
- "permissions": {
- "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
- "items": {
- "enum": [
- "balances",
- "ownership",
- "payment_method",
- "transactions"
- ],
- "maxLength": 5000,
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "return_url": {
- "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "account_holder",
- "permissions"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/financial_connections.session"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/link_account_sessions/{session}": {
- "get": {
- "description": "Retrieves the details of a Financial Connections Session
",
- "operationId": "GetLinkAccountSessionsSession",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "session",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/financial_connections.session"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/linked_accounts": {
- "get": {
- "description": "Returns a list of Financial Connections Account objects.
",
- "operationId": "GetLinkedAccounts",
- "parameters": [
- {
- "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.",
- "explode": true,
- "in": "query",
- "name": "account_holder",
- "required": false,
- "schema": {
- "properties": {
- "account": {
- "maxLength": 5000,
- "type": "string"
- },
- "customer": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "accountholder_params",
- "type": "object"
- },
- "style": "deepObject"
- },
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "If present, only return accounts that were collected as part of the given session.",
- "in": "query",
- "name": "session",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/financial_connections.account"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "pattern": "^/v1/financial_connections/accounts",
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "BankConnectionsResourceLinkedAccountList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/linked_accounts/{account}": {
- "get": {
- "description": "Retrieves the details of an Financial Connections Account.
",
- "operationId": "GetLinkedAccountsAccount",
- "parameters": [
- {
- "in": "path",
- "name": "account",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/financial_connections.account"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/linked_accounts/{account}/disconnect": {
- "post": {
- "description": "Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
",
- "operationId": "PostLinkedAccountsAccountDisconnect",
- "parameters": [
- {
- "in": "path",
- "name": "account",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/financial_connections.account"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/linked_accounts/{account}/owners": {
- "get": {
- "description": "Lists all owners for a given Account
",
- "operationId": "GetLinkedAccountsAccountOwners",
- "parameters": [
- {
- "in": "path",
- "name": "account",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- },
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "The ID of the ownership object to fetch owners from.",
- "in": "query",
- "name": "ownership",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "description": "Details about each object.",
- "items": {
- "$ref": "#/components/schemas/financial_connections.account_owner"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "BankConnectionsResourceOwnerList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/linked_accounts/{account}/refresh": {
- "post": {
- "description": "Refreshes the data associated with a Financial Connections Account.
",
- "operationId": "PostLinkedAccountsAccountRefresh",
- "parameters": [
- {
- "in": "path",
- "name": "account",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "features": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "features": {
- "description": "The list of account features that you would like to refresh.",
- "items": {
- "enum": [
- "balance",
- "ownership"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- }
- },
- "required": [
- "features"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/financial_connections.account"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/mandates/{mandate}": {
- "get": {
- "description": "Retrieves a Mandate object.
",
- "operationId": "GetMandatesMandate",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "mandate",
- "required": true,
- "schema": {
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/mandate"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/orders": {
- "get": {
- "description": "Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
",
- "operationId": "GetOrders",
- "parameters": [
- {
- "description": "Only return orders for the given customer.",
- "in": "query",
- "name": "customer",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "items": {
- "$ref": "#/components/schemas/order"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "pattern": "^/v1/orders",
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "OrdersV2ResourceOrderList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- },
- "post": {
- "description": "Creates a new open order object.
",
- "operationId": "PostOrders",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "automatic_tax": {
- "explode": true,
- "style": "deepObject"
- },
- "billing_details": {
- "explode": true,
- "style": "deepObject"
- },
- "client_permissions": {
- "explode": true,
- "style": "deepObject"
- },
- "discounts": {
- "explode": true,
- "style": "deepObject"
- },
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "line_items": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- },
- "payment": {
- "explode": true,
- "style": "deepObject"
- },
- "shipping_cost": {
- "explode": true,
- "style": "deepObject"
- },
- "shipping_details": {
- "explode": true,
- "style": "deepObject"
- },
- "tax_details": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "automatic_tax": {
- "description": "Settings for automatic tax calculation for this order.",
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- },
- "required": [
- "enabled"
- ],
- "title": "automatic_tax",
- "type": "object"
- },
- "billing_details": {
- "anyOf": [
- {
- "properties": {
- "address": {
- "properties": {
- "city": {
- "maxLength": 5000,
- "type": "string"
- },
- "country": {
- "maxLength": 5000,
- "type": "string"
- },
- "line1": {
- "maxLength": 5000,
- "type": "string"
- },
- "line2": {
- "maxLength": 5000,
- "type": "string"
- },
- "postal_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "state": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "validated_optional_fields_address",
- "type": "object"
- },
- "email": {
- "type": "string"
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "phone": {
- "maxLength": 20,
- "type": "string"
- }
- },
- "title": "billing_details",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided."
- },
- "client_permissions": {
- "description": "The fields on the order that are allowed to be updated from your frontend application with a publishable key and order client secret.",
- "properties": {
- "billing_details": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- },
- "promotion_codes": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- },
- "shipping_details": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- }
- },
- "title": "client_permissions",
- "type": "object"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "customer": {
- "description": "The customer associated with this order.",
- "maxLength": 5000,
- "type": "string"
- },
- "description": {
- "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
- "maxLength": 5000,
- "type": "string"
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "maxLength": 5000,
- "type": "string"
- },
- "promotion_code": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons, promotion codes, and/or discounts to apply to the order."
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "ip_address": {
- "description": "The IP address of the purchaser for this order.",
- "type": "string"
- },
- "line_items": {
- "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "description": {
- "maxLength": 5000,
- "type": "string"
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "price": {
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "properties": {
- "currency": {
- "type": "string"
- },
- "product": {
- "maxLength": 5000,
- "type": "string"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "type": "integer"
- },
- "unit_amount_decimal": {
- "format": "decimal",
- "type": "string"
- }
- },
- "title": "price_data_with_optional_product",
- "type": "object"
- },
- "product": {
- "maxLength": 5000,
- "type": "string"
- },
- "product_data": {
- "properties": {
- "description": {
- "maxLength": 40000,
- "type": "string"
- },
- "id": {
- "maxLength": 5000,
- "type": "string"
- },
- "images": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "package_dimensions": {
- "anyOf": [
- {
- "properties": {
- "height": {
- "type": "number"
- },
- "length": {
- "type": "number"
- },
- "weight": {
- "type": "number"
- },
- "width": {
- "type": "number"
- }
- },
- "required": [
- "height",
- "length",
- "weight",
- "width"
- ],
- "title": "package_dimensions_specs",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "shippable": {
- "type": "boolean"
- },
- "tax_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "required": [
- "id",
- "name"
- ],
- "title": "product_upsert_data",
- "type": "object"
- },
- "quantity": {
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "title": "create_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.",
- "type": "object"
- },
- "payment": {
- "description": "Payment information associated with the order, including payment settings.",
- "properties": {
- "settings": {
- "properties": {
- "application_fee_amount": {
- "type": "integer"
- },
- "payment_method_options": {
- "properties": {
- "acss_debit": {
- "properties": {
- "mandate_options": {
- "properties": {
- "custom_mandate_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "interval_description": {
- "maxLength": 500,
- "type": "string"
- },
- "payment_schedule": {
- "enum": [
- "combined",
- "interval",
- "sporadic"
- ],
- "type": "string"
- },
- "transaction_type": {
- "enum": [
- "business",
- "personal"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- },
- "verification_method": {
- "enum": [
- "automatic",
- "instant",
- "microdeposits"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- "afterpay_clearpay": {
- "properties": {
- "capture_method": {
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "reference": {
- "maxLength": 128,
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "afterpay_clearpay_payment_method_options_param",
- "type": "object"
- },
- "alipay": {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "bancontact": {
- "properties": {
- "preferred_language": {
- "enum": [
- "de",
- "en",
- "fr",
- "nl"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "card": {
- "properties": {
- "capture_method": {
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- }
- },
- "title": "card_payment_method_options",
- "type": "object"
- },
- "customer_balance": {
- "properties": {
- "bank_transfer": {
- "properties": {
- "eu_bank_transfer": {
- "properties": {
- "country": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "country"
- ],
- "title": "eu_bank_transfer_params",
- "type": "object"
- },
- "requested_address_types": {
- "items": {
- "enum": [
- "iban",
- "sepa",
- "sort_code",
- "spei",
- "zengin"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "type": {
- "enum": [
- "eu_bank_transfer",
- "gb_bank_transfer",
- "jp_bank_transfer",
- "mx_bank_transfer"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "required": [
- "type"
- ],
- "title": "bank_transfer_param",
- "type": "object"
- },
- "funding_type": {
- "enum": [
- "bank_transfer"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- "ideal": {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "klarna": {
- "properties": {
- "capture_method": {
- "enum": [
- "",
- "manual"
- ],
- "type": "string"
- },
- "preferred_locale": {
- "enum": [
- "da-DK",
- "de-AT",
- "de-CH",
- "de-DE",
- "en-AT",
- "en-AU",
- "en-BE",
- "en-CA",
- "en-CH",
- "en-DE",
- "en-DK",
- "en-ES",
- "en-FI",
- "en-FR",
- "en-GB",
- "en-IE",
- "en-IT",
- "en-NL",
- "en-NO",
- "en-NZ",
- "en-PL",
- "en-PT",
- "en-SE",
- "en-US",
- "es-ES",
- "es-US",
- "fi-FI",
- "fr-BE",
- "fr-CA",
- "fr-CH",
- "fr-FR",
- "it-CH",
- "it-IT",
- "nb-NO",
- "nl-BE",
- "nl-NL",
- "pl-PL",
- "pt-PT",
- "sv-FI",
- "sv-SE"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "link": {
- "properties": {
- "capture_method": {
- "enum": [
- "",
- "manual"
- ],
- "type": "string"
- },
- "persistent_token": {
- "maxLength": 5000,
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- "oxxo": {
- "properties": {
- "expires_after_days": {
- "type": "integer"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "p24": {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- },
- "tos_shown_and_accepted": {
- "type": "boolean"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "sepa_debit": {
- "properties": {
- "mandate_options": {
- "properties": {
- },
- "title": "payment_method_options_mandate_options_param",
- "type": "object"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- "sofort": {
- "properties": {
- "preferred_language": {
- "enum": [
- "",
- "de",
- "en",
- "es",
- "fr",
- "it",
- "nl",
- "pl"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- "wechat_pay": {
- "properties": {
- "app_id": {
- "maxLength": 5000,
- "type": "string"
- },
- "client": {
- "enum": [
- "android",
- "ios",
- "web"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "required": [
- "client"
- ],
- "title": "payment_method_options_param",
- "type": "object"
- }
- },
- "title": "create_params",
- "type": "object"
- },
- "payment_method_types": {
- "items": {
- "enum": [
- "acss_debit",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "card",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "klarna",
- "link",
- "oxxo",
- "p24",
- "sepa_debit",
- "sofort",
- "wechat_pay"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "return_url": {
- "type": "string"
- },
- "statement_descriptor": {
- "maxLength": 22,
- "type": "string"
- },
- "statement_descriptor_suffix": {
- "maxLength": 22,
- "type": "string"
- },
- "transfer_data": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "destination": {
- "type": "string"
- }
- },
- "required": [
- "destination"
- ],
- "title": "transfer_data",
- "type": "object"
- }
- },
- "title": "create_params",
- "type": "object"
- }
- },
- "required": [
- "settings"
- ],
- "title": "create_params",
- "type": "object"
- },
- "shipping_cost": {
- "anyOf": [
- {
- "properties": {
- "shipping_rate": {
- "maxLength": 5000,
- "type": "string"
- },
- "shipping_rate_data": {
- "properties": {
- "delivery_estimate": {
- "properties": {
- "maximum": {
- "properties": {
- "unit": {
- "enum": [
- "business_day",
- "day",
- "hour",
- "month",
- "week"
- ],
- "type": "string"
- },
- "value": {
- "type": "integer"
- }
- },
- "required": [
- "unit",
- "value"
- ],
- "title": "delivery_estimate_bound",
- "type": "object"
- },
- "minimum": {
- "properties": {
- "unit": {
- "enum": [
- "business_day",
- "day",
- "hour",
- "month",
- "week"
- ],
- "type": "string"
- },
- "value": {
- "type": "integer"
- }
- },
- "required": [
- "unit",
- "value"
- ],
- "title": "delivery_estimate_bound",
- "type": "object"
- }
- },
- "title": "delivery_estimate",
- "type": "object"
- },
- "display_name": {
- "maxLength": 100,
- "type": "string"
- },
- "fixed_amount": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "currency": {
- "type": "string"
- },
- "currency_options": {
- "additionalProperties": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount"
- ],
- "title": "currency_option",
- "type": "object"
- },
- "type": "object"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "title": "fixed_amount",
- "type": "object"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "tax_code": {
- "type": "string"
- },
- "type": {
- "enum": [
- "fixed_amount"
- ],
- "type": "string"
- }
- },
- "required": [
- "display_name"
- ],
- "title": "method_params",
- "type": "object"
- }
- },
- "title": "shipping_cost",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Settings for the customer cost of shipping for this order."
- },
- "shipping_details": {
- "anyOf": [
- {
- "properties": {
- "address": {
- "properties": {
- "city": {
- "maxLength": 5000,
- "type": "string"
- },
- "country": {
- "maxLength": 5000,
- "type": "string"
- },
- "line1": {
- "maxLength": 5000,
- "type": "string"
- },
- "line2": {
- "maxLength": 5000,
- "type": "string"
- },
- "postal_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "state": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "validated_optional_fields_address",
- "type": "object"
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "phone": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "address",
- "name"
- ],
- "title": "shipping_details",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Shipping details for the order."
- },
- "tax_details": {
- "description": "Additional tax details about the purchaser to be used for this order.",
- "properties": {
- "tax_exempt": {
- "enum": [
- "",
- "exempt",
- "none",
- "reverse"
- ],
- "type": "string"
- },
- "tax_ids": {
- "items": {
- "properties": {
- "type": {
- "enum": [
- "ae_trn",
- "au_abn",
- "au_arn",
- "bg_uic",
- "br_cnpj",
- "br_cpf",
- "ca_bn",
- "ca_gst_hst",
- "ca_pst_bc",
- "ca_pst_mb",
- "ca_pst_sk",
- "ca_qst",
- "ch_vat",
- "cl_tin",
- "eg_tin",
- "es_cif",
- "eu_oss_vat",
- "eu_vat",
- "gb_vat",
- "ge_vat",
- "hk_br",
- "hu_tin",
- "id_npwp",
- "il_vat",
- "in_gst",
- "is_vat",
- "jp_cn",
- "jp_rn",
- "jp_trn",
- "ke_pin",
- "kr_brn",
- "li_uid",
- "mx_rfc",
- "my_frp",
- "my_itn",
- "my_sst",
- "no_vat",
- "nz_gst",
- "ph_tin",
- "ru_inn",
- "ru_kpp",
- "sa_vat",
- "sg_gst",
- "sg_uen",
- "si_tin",
- "th_vat",
- "tr_tin",
- "tw_vat",
- "ua_vat",
- "us_ein",
- "za_vat"
- ],
- "maxLength": 5000,
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "title": "data_params",
- "type": "object"
- },
- "type": "array"
- }
- },
- "title": "tax_details",
- "type": "object"
- }
- },
- "required": [
- "currency",
- "line_items"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/order"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/orders/{id}": {
- "get": {
- "description": "Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
",
- "operationId": "GetOrdersId",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "id",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/order"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- },
- "post": {
- "description": "Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
",
- "operationId": "PostOrdersId",
- "parameters": [
- {
- "in": "path",
- "name": "id",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "automatic_tax": {
- "explode": true,
- "style": "deepObject"
- },
- "billing_details": {
- "explode": true,
- "style": "deepObject"
- },
- "client_permissions": {
- "explode": true,
- "style": "deepObject"
- },
- "discounts": {
- "explode": true,
- "style": "deepObject"
- },
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "line_items": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- },
- "payment": {
- "explode": true,
- "style": "deepObject"
- },
- "shipping_cost": {
- "explode": true,
- "style": "deepObject"
- },
- "shipping_details": {
- "explode": true,
- "style": "deepObject"
- },
- "tax_details": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "automatic_tax": {
- "description": "Settings for automatic tax calculation for this order.",
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- },
- "required": [
- "enabled"
- ],
- "title": "automatic_tax",
- "type": "object"
- },
- "billing_details": {
- "anyOf": [
- {
- "properties": {
- "address": {
- "properties": {
- "city": {
- "maxLength": 5000,
- "type": "string"
- },
- "country": {
- "maxLength": 5000,
- "type": "string"
- },
- "line1": {
- "maxLength": 5000,
- "type": "string"
- },
- "line2": {
- "maxLength": 5000,
- "type": "string"
- },
- "postal_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "state": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "validated_optional_fields_address",
- "type": "object"
- },
- "email": {
- "type": "string"
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "phone": {
- "maxLength": 20,
- "type": "string"
- }
- },
- "title": "billing_details",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Billing details for the customer. If a customer is provided, this will be automatically populated with values from that customer if override values are not provided."
- },
- "client_permissions": {
- "description": "The fields on the order that are allowed to be updated from your frontend application with a publishable key and order client secret.",
- "properties": {
- "billing_details": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- },
- "promotion_codes": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- },
- "shipping_details": {
- "enum": [
- "allow",
- "disallow"
- ],
- "type": "string"
- }
- },
- "title": "client_permissions",
- "type": "object"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "customer": {
- "description": "The customer associated with this order.",
- "maxLength": 5000,
- "type": "string"
- },
- "description": {
- "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
- "maxLength": 5000,
- "type": "string"
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "maxLength": 5000,
- "type": "string"
- },
- "promotion_code": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The coupons, promotion codes, and/or discounts to apply to the order. Pass the empty string `\"\"` to unset this field."
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "ip_address": {
- "description": "The IP address of the purchaser for this order.",
- "type": "string"
- },
- "line_items": {
- "description": "A list of line items the customer is ordering. Each line item includes information about the product, the quantity, and the resulting cost.",
- "items": {
- "properties": {
- "description": {
- "maxLength": 5000,
- "type": "string"
- },
- "discounts": {
- "anyOf": [
- {
- "items": {
- "properties": {
- "coupon": {
- "maxLength": 5000,
- "type": "string"
- },
- "discount": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "discounts_data_param",
- "type": "object"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "id": {
- "maxLength": 5000,
- "type": "string"
- },
- "price": {
- "maxLength": 5000,
- "type": "string"
- },
- "price_data": {
- "properties": {
- "currency": {
- "type": "string"
- },
- "product": {
- "maxLength": 5000,
- "type": "string"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "unit_amount": {
- "type": "integer"
- },
- "unit_amount_decimal": {
- "format": "decimal",
- "type": "string"
- }
- },
- "title": "price_data_with_optional_product",
- "type": "object"
- },
- "product": {
- "maxLength": 5000,
- "type": "string"
- },
- "product_data": {
- "properties": {
- "description": {
- "maxLength": 40000,
- "type": "string"
- },
- "id": {
- "maxLength": 5000,
- "type": "string"
- },
- "images": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "package_dimensions": {
- "anyOf": [
- {
- "properties": {
- "height": {
- "type": "number"
- },
- "length": {
- "type": "number"
- },
- "weight": {
- "type": "number"
- },
- "width": {
- "type": "number"
- }
- },
- "required": [
- "height",
- "length",
- "weight",
- "width"
- ],
- "title": "package_dimensions_specs",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "shippable": {
- "type": "boolean"
- },
- "tax_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "required": [
- "id",
- "name"
- ],
- "title": "product_upsert_data",
- "type": "object"
- },
- "quantity": {
- "type": "integer"
- },
- "tax_rates": {
- "anyOf": [
- {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "title": "update_params",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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": {
- "description": "Payment information associated with the order, including payment settings.",
- "properties": {
- "settings": {
- "properties": {
- "application_fee_amount": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "payment_method_options": {
- "properties": {
- "acss_debit": {
- "anyOf": [
- {
- "properties": {
- "mandate_options": {
- "properties": {
- "custom_mandate_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "interval_description": {
- "maxLength": 500,
- "type": "string"
- },
- "payment_schedule": {
- "enum": [
- "combined",
- "interval",
- "sporadic"
- ],
- "type": "string"
- },
- "transaction_type": {
- "enum": [
- "business",
- "personal"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_mandate_options_param",
- "type": "object"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- },
- "verification_method": {
- "enum": [
- "automatic",
- "instant",
- "microdeposits"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "afterpay_clearpay": {
- "anyOf": [
- {
- "properties": {
- "capture_method": {
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "reference": {
- "maxLength": 128,
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "afterpay_clearpay_payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "alipay": {
- "anyOf": [
- {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "bancontact": {
- "anyOf": [
- {
- "properties": {
- "preferred_language": {
- "enum": [
- "de",
- "en",
- "fr",
- "nl"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "card": {
- "anyOf": [
- {
- "properties": {
- "capture_method": {
- "enum": [
- "automatic",
- "manual"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- }
- },
- "title": "card_payment_method_options",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "customer_balance": {
- "anyOf": [
- {
- "properties": {
- "bank_transfer": {
- "properties": {
- "eu_bank_transfer": {
- "properties": {
- "country": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "country"
- ],
- "title": "eu_bank_transfer_params",
- "type": "object"
- },
- "requested_address_types": {
- "items": {
- "enum": [
- "iban",
- "sepa",
- "sort_code",
- "spei",
- "zengin"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "type": {
- "enum": [
- "eu_bank_transfer",
- "gb_bank_transfer",
- "jp_bank_transfer",
- "mx_bank_transfer"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- }
- },
- "required": [
- "type"
- ],
- "title": "bank_transfer_param",
- "type": "object"
- },
- "funding_type": {
- "enum": [
- "bank_transfer"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "ideal": {
- "anyOf": [
- {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "klarna": {
- "anyOf": [
- {
- "properties": {
- "capture_method": {
- "enum": [
- "",
- "manual"
- ],
- "type": "string"
- },
- "preferred_locale": {
- "enum": [
- "da-DK",
- "de-AT",
- "de-CH",
- "de-DE",
- "en-AT",
- "en-AU",
- "en-BE",
- "en-CA",
- "en-CH",
- "en-DE",
- "en-DK",
- "en-ES",
- "en-FI",
- "en-FR",
- "en-GB",
- "en-IE",
- "en-IT",
- "en-NL",
- "en-NO",
- "en-NZ",
- "en-PL",
- "en-PT",
- "en-SE",
- "en-US",
- "es-ES",
- "es-US",
- "fi-FI",
- "fr-BE",
- "fr-CA",
- "fr-CH",
- "fr-FR",
- "it-CH",
- "it-IT",
- "nb-NO",
- "nl-BE",
- "nl-NL",
- "pl-PL",
- "pt-PT",
- "sv-FI",
- "sv-SE"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "link": {
- "anyOf": [
- {
- "properties": {
- "capture_method": {
- "enum": [
- "",
- "manual"
- ],
- "type": "string"
- },
- "persistent_token": {
- "maxLength": 5000,
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "oxxo": {
- "anyOf": [
- {
- "properties": {
- "expires_after_days": {
- "type": "integer"
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "p24": {
- "anyOf": [
- {
- "properties": {
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- },
- "tos_shown_and_accepted": {
- "type": "boolean"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "sepa_debit": {
- "anyOf": [
- {
- "properties": {
- "mandate_options": {
- "properties": {
- },
- "title": "payment_method_options_mandate_options_param",
- "type": "object"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session",
- "on_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_intent_payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "sofort": {
- "anyOf": [
- {
- "properties": {
- "preferred_language": {
- "enum": [
- "",
- "de",
- "en",
- "es",
- "fr",
- "it",
- "nl",
- "pl"
- ],
- "type": "string"
- },
- "setup_future_usage": {
- "enum": [
- "",
- "none",
- "off_session"
- ],
- "type": "string"
- }
- },
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "wechat_pay": {
- "anyOf": [
- {
- "properties": {
- "app_id": {
- "maxLength": 5000,
- "type": "string"
- },
- "client": {
- "enum": [
- "android",
- "ios",
- "web"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "setup_future_usage": {
- "enum": [
- "none"
- ],
- "type": "string"
- }
- },
- "required": [
- "client"
- ],
- "title": "payment_method_options_param",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "title": "update_params",
- "type": "object"
- },
- "payment_method_types": {
- "items": {
- "enum": [
- "acss_debit",
- "afterpay_clearpay",
- "alipay",
- "au_becs_debit",
- "bacs_debit",
- "bancontact",
- "card",
- "customer_balance",
- "eps",
- "fpx",
- "giropay",
- "grabpay",
- "ideal",
- "klarna",
- "link",
- "oxxo",
- "p24",
- "sepa_debit",
- "sofort",
- "wechat_pay"
- ],
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "type": "array"
- },
- "return_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- },
- "statement_descriptor": {
- "maxLength": 22,
- "type": "string"
- },
- "statement_descriptor_suffix": {
- "maxLength": 22,
- "type": "string"
- },
- "transfer_data": {
- "anyOf": [
- {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "destination": {
- "type": "string"
- }
- },
- "required": [
- "destination"
- ],
- "title": "transfer_data",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ]
- }
- },
- "title": "update_params",
- "type": "object"
- }
- },
- "required": [
- "settings"
- ],
- "title": "update_params",
- "type": "object"
- },
- "shipping_cost": {
- "anyOf": [
- {
- "properties": {
- "shipping_rate": {
- "maxLength": 5000,
- "type": "string"
- },
- "shipping_rate_data": {
- "properties": {
- "delivery_estimate": {
- "properties": {
- "maximum": {
- "properties": {
- "unit": {
- "enum": [
- "business_day",
- "day",
- "hour",
- "month",
- "week"
- ],
- "type": "string"
- },
- "value": {
- "type": "integer"
- }
- },
- "required": [
- "unit",
- "value"
- ],
- "title": "delivery_estimate_bound",
- "type": "object"
- },
- "minimum": {
- "properties": {
- "unit": {
- "enum": [
- "business_day",
- "day",
- "hour",
- "month",
- "week"
- ],
- "type": "string"
- },
- "value": {
- "type": "integer"
- }
- },
- "required": [
- "unit",
- "value"
- ],
- "title": "delivery_estimate_bound",
- "type": "object"
- }
- },
- "title": "delivery_estimate",
- "type": "object"
- },
- "display_name": {
- "maxLength": 100,
- "type": "string"
- },
- "fixed_amount": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "currency": {
- "type": "string"
- },
- "currency_options": {
- "additionalProperties": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- }
- },
- "required": [
- "amount"
- ],
- "title": "currency_option",
- "type": "object"
- },
- "type": "object"
- }
- },
- "required": [
- "amount",
- "currency"
- ],
- "title": "fixed_amount",
- "type": "object"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- },
- "tax_code": {
- "type": "string"
- },
- "type": {
- "enum": [
- "fixed_amount"
- ],
- "type": "string"
- }
- },
- "required": [
- "display_name"
- ],
- "title": "method_params",
- "type": "object"
- }
- },
- "title": "shipping_cost",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Settings for the customer cost of shipping for this order."
- },
- "shipping_details": {
- "anyOf": [
- {
- "properties": {
- "address": {
- "properties": {
- "city": {
- "maxLength": 5000,
- "type": "string"
- },
- "country": {
- "maxLength": 5000,
- "type": "string"
- },
- "line1": {
- "maxLength": 5000,
- "type": "string"
- },
- "line2": {
- "maxLength": 5000,
- "type": "string"
- },
- "postal_code": {
- "maxLength": 5000,
- "type": "string"
- },
- "state": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "validated_optional_fields_address",
- "type": "object"
- },
- "name": {
- "maxLength": 5000,
- "type": "string"
- },
- "phone": {
- "maxLength": 5000,
- "type": "string"
- }
- },
- "required": [
- "address",
- "name"
- ],
- "title": "shipping_details",
- "type": "object"
+ "description": "To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
",
+ "operationId": "PostLinkAccountSessions",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "account_holder": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "filters": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "permissions": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "account_holder": {
+ "description": "The account holder to link accounts for.",
+ "properties": {
+ "account": {
+ "maxLength": 5000,
+ "type": "string"
},
- {
+ "customer": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
"enum": [
- ""
+ "account",
+ "customer"
],
"type": "string"
}
+ },
+ "required": [
+ "type"
],
- "description": "Shipping details for the order."
+ "title": "accountholder_params",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
},
- "tax_details": {
- "description": "Additional tax details about the purchaser to be used for this order.",
+ "filters": {
+ "description": "Filters to restrict the kinds of accounts to collect.",
"properties": {
- "tax_exempt": {
- "enum": [
- "",
- "exempt",
- "none",
- "reverse"
- ],
- "type": "string"
- },
- "tax_ids": {
+ "countries": {
"items": {
- "properties": {
- "type": {
- "enum": [
- "ae_trn",
- "au_abn",
- "au_arn",
- "bg_uic",
- "br_cnpj",
- "br_cpf",
- "ca_bn",
- "ca_gst_hst",
- "ca_pst_bc",
- "ca_pst_mb",
- "ca_pst_sk",
- "ca_qst",
- "ch_vat",
- "cl_tin",
- "eg_tin",
- "es_cif",
- "eu_oss_vat",
- "eu_vat",
- "gb_vat",
- "ge_vat",
- "hk_br",
- "hu_tin",
- "id_npwp",
- "il_vat",
- "in_gst",
- "is_vat",
- "jp_cn",
- "jp_rn",
- "jp_trn",
- "ke_pin",
- "kr_brn",
- "li_uid",
- "mx_rfc",
- "my_frp",
- "my_itn",
- "my_sst",
- "no_vat",
- "nz_gst",
- "ph_tin",
- "ru_inn",
- "ru_kpp",
- "sa_vat",
- "sg_gst",
- "sg_uen",
- "si_tin",
- "th_vat",
- "tr_tin",
- "tw_vat",
- "ua_vat",
- "us_ein",
- "za_vat"
- ],
- "maxLength": 5000,
- "type": "string",
- "x-stripeBypassValidation": true
- },
- "value": {
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "title": "data_params",
- "type": "object"
+ "maxLength": 5000,
+ "type": "string"
},
"type": "array"
}
},
- "title": "tax_details",
+ "required": [
+ "countries"
+ ],
+ "title": "filters_params",
"type": "object"
+ },
+ "permissions": {
+ "description": "List of data features that you would like to request access to.\n\nPossible values are `balances`, `transactions`, `ownership`, and `payment_method`.",
+ "items": {
+ "enum": [
+ "balances",
+ "ownership",
+ "payment_method",
+ "transactions"
+ ],
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
+ "return_url": {
+ "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.",
+ "maxLength": 5000,
+ "type": "string"
}
},
+ "required": [
+ "account_holder",
+ "permissions"
+ ],
"type": "object"
}
}
},
- "required": false
+ "required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/order"
+ "$ref": "#/components/schemas/financial_connections.session"
}
}
},
@@ -84341,14 +79570,29 @@
}
}
},
- "/v1/orders/{id}/cancel": {
- "post": {
- "description": "Cancels the order as well as the payment intent if one is attached.
",
- "operationId": "PostOrdersIdCancel",
+ "/v1/link_account_sessions/{session}": {
+ "get": {
+ "description": "Retrieves the details of a Financial Connections Session
",
+ "operationId": "GetLinkAccountSessionsSession",
"parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
{
"in": "path",
- "name": "id",
+ "name": "session",
"required": true,
"schema": {
"maxLength": 5000,
@@ -84361,22 +79605,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- }
},
"schema": {
"additionalProperties": false,
"properties": {
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- }
},
"type": "object"
}
@@ -84389,7 +79621,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/order"
+ "$ref": "#/components/schemas/financial_connections.session"
}
}
},
@@ -84408,11 +79640,33 @@
}
}
},
- "/v1/orders/{id}/line_items": {
+ "/v1/linked_accounts": {
"get": {
- "description": "When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
",
- "operationId": "GetOrdersIdLineItems",
+ "description": "Returns a list of Financial Connections Account objects.
",
+ "operationId": "GetLinkedAccounts",
"parameters": [
+ {
+ "description": "If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.",
+ "explode": true,
+ "in": "query",
+ "name": "account_holder",
+ "required": false,
+ "schema": {
+ "properties": {
+ "account": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "customer": {
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "accountholder_params",
+ "type": "object"
+ },
+ "style": "deepObject"
+ },
{
"description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
"in": "query",
@@ -84440,22 +79694,23 @@
"style": "deepObject"
},
{
- "in": "path",
- "name": "id",
- "required": true,
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
"schema": {
- "maxLength": 5000,
- "type": "string"
+ "type": "integer"
},
- "style": "simple"
+ "style": "form"
},
{
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "description": "If present, only return accounts that were collected as part of the given session.",
"in": "query",
- "name": "limit",
+ "name": "session",
"required": false,
"schema": {
- "type": "integer"
+ "maxLength": 5000,
+ "type": "string"
},
"style": "form"
},
@@ -84496,7 +79751,7 @@
"data": {
"description": "Details about each object.",
"items": {
- "$ref": "#/components/schemas/item"
+ "$ref": "#/components/schemas/financial_connections.account"
},
"type": "array"
},
@@ -84514,6 +79769,7 @@
"url": {
"description": "The URL where this list can be accessed.",
"maxLength": 5000,
+ "pattern": "^/v1/financial_connections/accounts",
"type": "string"
}
},
@@ -84523,7 +79779,7 @@
"object",
"url"
],
- "title": "OrdersV2ResourceLineItemList",
+ "title": "BankConnectionsResourceLinkedAccountList",
"type": "object",
"x-expandableFields": [
"data"
@@ -84546,14 +79802,84 @@
}
}
},
- "/v1/orders/{id}/reopen": {
+ "/v1/linked_accounts/{account}": {
+ "get": {
+ "description": "Retrieves the details of an Financial Connections Account.
",
+ "operationId": "GetLinkedAccountsAccount",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "account",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/linked_accounts/{account}/disconnect": {
"post": {
- "description": "Reopens a submitted order.
",
- "operationId": "PostOrdersIdReopen",
+ "description": "Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
",
+ "operationId": "PostLinkedAccountsAccountDisconnect",
"parameters": [
{
"in": "path",
- "name": "id",
+ "name": "account",
"required": true,
"schema": {
"maxLength": 5000,
@@ -84594,7 +79920,156 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/order"
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/linked_accounts/{account}/owners": {
+ "get": {
+ "description": "Lists all owners for a given Account
",
+ "operationId": "GetLinkedAccountsAccountOwners",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "account",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "description": "The ID of the ownership object to fetch owners from.",
+ "in": "query",
+ "name": "ownership",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/financial_connections.account_owner"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "BankConnectionsResourceOwnerList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
}
}
},
@@ -84613,14 +80088,14 @@
}
}
},
- "/v1/orders/{id}/submit": {
+ "/v1/linked_accounts/{account}/refresh": {
"post": {
- "description": "Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the reopen method is called.
",
- "operationId": "PostOrdersIdSubmit",
+ "description": "Refreshes the data associated with a Financial Connections Account.
",
+ "operationId": "PostLinkedAccountsAccountRefresh",
"parameters": [
{
"in": "path",
- "name": "id",
+ "name": "account",
"required": true,
"schema": {
"maxLength": 5000,
@@ -84636,6 +80111,10 @@
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "features": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
@@ -84649,13 +80128,21 @@
},
"type": "array"
},
- "expected_total": {
- "description": "`expected_total` should always be set to the order's `amount_total` field. If they don't match, submitting the order will fail. This helps detect race conditions where something else concurrently modifies the order.",
- "type": "integer"
+ "features": {
+ "description": "The list of account features that you would like to refresh.",
+ "items": {
+ "enum": [
+ "balance",
+ "ownership"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"required": [
- "expected_total"
+ "features"
],
"type": "object"
}
@@ -84668,7 +80155,76 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/order"
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/mandates/{mandate}": {
+ "get": {
+ "description": "Retrieves a Mandate object.
",
+ "operationId": "GetMandatesMandate",
+ "parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "in": "path",
+ "name": "mandate",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/mandate"
}
}
},
@@ -106952,421 +102508,23 @@
"fixed_amount"
],
"type": "string"
- }
- },
- "required": [
- "display_name"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/shipping_rate"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/shipping_rates/{shipping_rate_token}": {
- "get": {
- "description": "Returns the shipping rate object with the given ID.
",
- "operationId": "GetShippingRatesShippingRateToken",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "shipping_rate_token",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/shipping_rate"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- },
- "post": {
- "description": "Updates an existing shipping rate object.
",
- "operationId": "PostShippingRatesShippingRateToken",
- "parameters": [
- {
- "in": "path",
- "name": "shipping_rate_token",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "fixed_amount": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "active": {
- "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.",
- "type": "boolean"
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "fixed_amount": {
- "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
- "properties": {
- "currency_options": {
- "additionalProperties": {
- "properties": {
- "amount": {
- "type": "integer"
- },
- "tax_behavior": {
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- }
- },
- "title": "currency_option_update",
- "type": "object"
- },
- "type": "object"
- }
- },
- "title": "fixed_amount_update",
- "type": "object"
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`."
- },
- "tax_behavior": {
- "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
- "enum": [
- "exclusive",
- "inclusive",
- "unspecified"
- ],
- "type": "string"
- }
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/shipping_rate"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/sigma/scheduled_query_runs": {
- "get": {
- "description": "Returns a list of scheduled query runs.
",
- "operationId": "GetSigmaScheduledQueryRuns",
- "parameters": [
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "description": "",
- "properties": {
- "data": {
- "items": {
- "$ref": "#/components/schemas/scheduled_query_run"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "pattern": "^/v1/sigma/scheduled_query_runs",
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "SigmaScheduledQueryRunList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": {
- "get": {
- "description": "Retrieves the details of an scheduled query run.
",
- "operationId": "GetSigmaScheduledQueryRunsScheduledQueryRun",
- "parameters": [
- {
- "description": "Specifies which fields in the response should be expanded.",
- "explode": true,
- "in": "query",
- "name": "expand",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "in": "path",
- "name": "scheduled_query_run",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
+ }
},
+ "required": [
+ "display_name"
+ ],
"type": "object"
}
}
},
- "required": false
+ "required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/scheduled_query_run"
+ "$ref": "#/components/schemas/shipping_rate"
}
}
},
@@ -107385,47 +102543,11 @@
}
}
},
- "/v1/skus": {
+ "/v1/shipping_rates/{shipping_rate_token}": {
"get": {
- "description": "Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
",
- "operationId": "GetSkus",
+ "description": "Returns the shipping rate object with the given ID.
",
+ "operationId": "GetShippingRatesShippingRateToken",
"parameters": [
- {
- "description": "Only return SKUs that are active or inactive (e.g., pass `false` to list all inactive products).",
- "in": "query",
- "name": "active",
- "required": false,
- "schema": {
- "type": "boolean"
- },
- "style": "form"
- },
- {
- "description": "Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `[\"color\", \"size\"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`.",
- "explode": true,
- "in": "query",
- "name": "attributes",
- "required": false,
- "schema": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "type": "object"
- },
- "style": "deepObject"
- },
- {
- "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
- "in": "query",
- "name": "ending_before",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
{
"description": "Specifies which fields in the response should be expanded.",
"explode": true,
@@ -107442,61 +102564,14 @@
"style": "deepObject"
},
{
- "description": "Only return SKUs with the given IDs.",
- "explode": true,
- "in": "query",
- "name": "ids",
- "required": false,
- "schema": {
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "style": "deepObject"
- },
- {
- "description": "Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.",
- "in": "query",
- "name": "in_stock",
- "required": false,
- "schema": {
- "type": "boolean"
- },
- "style": "form"
- },
- {
- "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
- "in": "query",
- "name": "limit",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "style": "form"
- },
- {
- "description": "The ID of the product whose SKUs will be retrieved. Must be a product with type `good`.",
- "in": "query",
- "name": "product",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
- "in": "query",
- "name": "starting_after",
- "required": false,
+ "in": "path",
+ "name": "shipping_rate_token",
+ "required": true,
"schema": {
"maxLength": 5000,
"type": "string"
},
- "style": "form"
+ "style": "simple"
}
],
"requestBody": {
@@ -107519,43 +102594,7 @@
"content": {
"application/json": {
"schema": {
- "description": "",
- "properties": {
- "data": {
- "items": {
- "$ref": "#/components/schemas/sku"
- },
- "type": "array"
- },
- "has_more": {
- "description": "True if this list has another page of items after this one that can be fetched.",
- "type": "boolean"
- },
- "object": {
- "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
- "enum": [
- "list"
- ],
- "type": "string"
- },
- "url": {
- "description": "The URL where this list can be accessed.",
- "maxLength": 5000,
- "pattern": "^/v1/skus",
- "type": "string"
- }
- },
- "required": [
- "data",
- "has_more",
- "object",
- "url"
- ],
- "title": "ProductsMethodSKUList",
- "type": "object",
- "x-expandableFields": [
- "data"
- ]
+ "$ref": "#/components/schemas/shipping_rate"
}
}
},
@@ -107574,52 +102613,44 @@
}
},
"post": {
- "description": "Creates a new SKU associated with a product.
",
- "operationId": "PostSkus",
+ "description": "Updates an existing shipping rate object.
",
+ "operationId": "PostShippingRatesShippingRateToken",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "shipping_rate_token",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "attributes": {
- "explode": true,
- "style": "deepObject"
- },
"expand": {
"explode": true,
"style": "deepObject"
},
- "inventory": {
+ "fixed_amount": {
"explode": true,
"style": "deepObject"
},
"metadata": {
"explode": true,
"style": "deepObject"
- },
- "package_dimensions": {
- "explode": true,
- "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
"active": {
- "description": "Whether the SKU is available for purchase. Default to `true`.",
+ "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`.",
"type": "boolean"
},
- "attributes": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `[\"size\", \"gender\"]`, a valid SKU has the following dictionary of attributes: `{\"size\": \"Medium\", \"gender\": \"Unisex\"}`.",
- "type": "object"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -107628,105 +102659,72 @@
},
"type": "array"
},
- "id": {
- "description": "The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.",
- "type": "string"
- },
- "image": {
- "description": "The URL of an image for this SKU, meant to be displayable to the customer.",
- "maxLength": 5000,
- "type": "string"
- },
- "inventory": {
- "description": "Description of the SKU's inventory.",
+ "fixed_amount": {
+ "description": "Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.",
"properties": {
- "quantity": {
- "type": "integer"
- },
- "type": {
- "enum": [
- "bucket",
- "finite",
- "infinite"
- ],
- "type": "string"
- },
- "value": {
- "enum": [
- "",
- "in_stock",
- "limited",
- "out_of_stock"
- ],
- "type": "string"
+ "currency_options": {
+ "additionalProperties": {
+ "properties": {
+ "amount": {
+ "type": "integer"
+ },
+ "tax_behavior": {
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "currency_option_update",
+ "type": "object"
+ },
+ "type": "object"
}
},
- "required": [
- "type"
- ],
- "title": "inventory_create_specs",
+ "title": "fixed_amount_update",
"type": "object"
},
"metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.",
- "type": "object"
- },
- "package_dimensions": {
- "description": "The dimensions of this SKU for shipping purposes.",
- "properties": {
- "height": {
- "type": "number"
- },
- "length": {
- "type": "number"
- },
- "weight": {
- "type": "number"
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
- "width": {
- "type": "number"
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
}
- },
- "required": [
- "height",
- "length",
- "weight",
- "width"
],
- "title": "package_dimensions_specs",
- "type": "object"
- },
- "price": {
- "description": "The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
- "type": "integer"
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`."
},
- "product": {
- "description": "The ID of the product this SKU is associated with. Must be a product with type `good`.",
- "maxLength": 5000,
+ "tax_behavior": {
+ "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
"type": "string"
}
},
- "required": [
- "currency",
- "inventory",
- "price",
- "product"
- ],
"type": "object"
}
}
},
- "required": true
+ "required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/sku"
+ "$ref": "#/components/schemas/shipping_rate"
}
}
},
@@ -107745,64 +102743,22 @@
}
}
},
- "/v1/skus/{id}": {
- "delete": {
- "description": "Delete a SKU. Deleting a SKU is only possible until it has been used in an order.
",
- "operationId": "DeleteSkusId",
+ "/v1/sigma/scheduled_query_runs": {
+ "get": {
+ "description": "Returns a list of scheduled query runs.
",
+ "operationId": "GetSigmaScheduledQueryRuns",
"parameters": [
{
- "in": "path",
- "name": "id",
- "required": true,
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
"schema": {
"maxLength": 5000,
"type": "string"
},
- "style": "simple"
- }
- ],
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/deleted_sku"
- }
- }
- },
- "description": "Successful response."
+ "style": "form"
},
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- },
- "get": {
- "description": "Retrieves the details of an existing SKU. Supply the unique SKU identifier from either a SKU creation request or from the product, and Stripe will return the corresponding SKU information.
",
- "operationId": "GetSkusId",
- "parameters": [
{
"description": "Specifies which fields in the response should be expanded.",
"explode": true,
@@ -107819,14 +102775,25 @@
"style": "deepObject"
},
{
- "in": "path",
- "name": "id",
- "required": true,
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
"schema": {
"maxLength": 5000,
"type": "string"
},
- "style": "simple"
+ "style": "form"
}
],
"requestBody": {
@@ -107849,13 +102816,42 @@
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/sku"
+ "description": "",
+ "properties": {
+ "data": {
+ "items": {
+ "$ref": "#/components/schemas/scheduled_query_run"
+ },
+ "type": "array"
},
- {
- "$ref": "#/components/schemas/deleted_sku"
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "pattern": "^/v1/sigma/scheduled_query_runs",
+ "type": "string"
}
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "SigmaScheduledQueryRunList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
]
}
}
@@ -107873,14 +102869,31 @@
"description": "Error response."
}
}
- },
- "post": {
- "description": "Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nNote that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.
",
- "operationId": "PostSkusId",
+ }
+ },
+ "/v1/sigma/scheduled_query_runs/{scheduled_query_run}": {
+ "get": {
+ "description": "Retrieves the details of an scheduled query run.
",
+ "operationId": "GetSigmaScheduledQueryRunsScheduledQueryRun",
"parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
{
"in": "path",
- "name": "id",
+ "name": "scheduled_query_run",
"required": true,
"schema": {
"maxLength": 5000,
@@ -107893,147 +102906,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "attributes": {
- "explode": true,
- "style": "deepObject"
- },
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "inventory": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- },
- "package_dimensions": {
- "explode": true,
- "style": "deepObject"
- }
},
"schema": {
"additionalProperties": false,
"properties": {
- "active": {
- "description": "Whether this SKU is available for purchase.",
- "type": "boolean"
- },
- "attributes": {
- "additionalProperties": {
- "maxLength": 500,
- "type": "string"
- },
- "description": "A dictionary of attributes and values for the attributes defined by the product. When specified, `attributes` will partially update the existing attributes dictionary on the product, with the postcondition that a value must be present for each attribute key on the product.",
- "type": "object"
- },
- "currency": {
- "description": "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).",
- "type": "string"
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "image": {
- "description": "The URL of an image for this SKU, meant to be displayable to the customer.",
- "maxLength": 5000,
- "type": "string"
- },
- "inventory": {
- "description": "Description of the SKU's inventory.",
- "properties": {
- "quantity": {
- "type": "integer"
- },
- "type": {
- "enum": [
- "bucket",
- "finite",
- "infinite"
- ],
- "type": "string"
- },
- "value": {
- "enum": [
- "",
- "in_stock",
- "limited",
- "out_of_stock"
- ],
- "type": "string"
- }
- },
- "title": "inventory_update_specs",
- "type": "object"
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`."
- },
- "package_dimensions": {
- "anyOf": [
- {
- "properties": {
- "height": {
- "type": "number"
- },
- "length": {
- "type": "number"
- },
- "weight": {
- "type": "number"
- },
- "width": {
- "type": "number"
- }
- },
- "required": [
- "height",
- "length",
- "weight",
- "width"
- ],
- "title": "package_dimensions_specs",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The dimensions of this SKU for shipping purposes."
- },
- "price": {
- "description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
- "type": "integer"
- },
- "product": {
- "description": "The ID of the product that this SKU should belong to. The product must exist, have the same set of attribute names as the SKU's current product, and be of type `good`.",
- "maxLength": 5000,
- "type": "string"
- }
},
"type": "object"
}
@@ -108046,7 +102922,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/sku"
+ "$ref": "#/components/schemas/scheduled_query_run"
}
}
},
@@ -126320,7 +121196,8 @@
"2019-12-03",
"2020-03-02",
"2020-08-27",
- "2022-08-01"
+ "2022-08-01",
+ "2022-11-15"
],
"maxLength": 5000,
"type": "string",