From 2da67682910d1565b580c6996c6f778582ca1c12 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 18 Nov 2023 01:33:50 +0000 Subject: [PATCH] Update services based on v674 of Stripe OpenApi SDK Reference: https://github.com/stripe/openapi/releases/tag/v674 --- .latest-tag-stripe-openapi-sdk | 2 +- lib/generated/account.ex | 18 ++- lib/generated/checkout__session.ex | 10 +- lib/generated/event.ex | 2 +- lib/generated/issuing__authorization.ex | 2 +- lib/generated/payment_intent.ex | 168 ++++++++++++++++-------- lib/generated/price.ex | 2 +- lib/generated/setup_intent.ex | 4 +- lib/generated/token.ex | 22 ++-- priv/openapi/spec3.sdk.json | 101 ++++++++++++-- 10 files changed, 233 insertions(+), 98 deletions(-) diff --git a/.latest-tag-stripe-openapi-sdk b/.latest-tag-stripe-openapi-sdk index 1719ca37..211e64ff 100644 --- a/.latest-tag-stripe-openapi-sdk +++ b/.latest-tag-stripe-openapi-sdk @@ -1 +1 @@ -v669 +v674 diff --git a/lib/generated/account.ex b/lib/generated/account.ex index 912bbc3b..935a929f 100644 --- a/lib/generated/account.ex +++ b/lib/generated/account.ex @@ -119,8 +119,8 @@ defmodule Stripe.Account do ) ( - @typedoc "Settings specific to Bacs Direct Debit payments." - @type bacs_debit_payments :: %{optional(:display_name) => binary} + @typedoc "The bacs_debit_payments capability." + @type bacs_debit_payments :: %{optional(:requested) => boolean} ) ( @@ -333,7 +333,7 @@ defmodule Stripe.Account do ) ( - @typedoc "A document verifying the business." + @typedoc "An identifying document, either a passport or local ID card." @type document :: %{optional(:back) => binary, optional(:front) => binary} ) @@ -578,11 +578,12 @@ defmodule Stripe.Account do ) ( - @typedoc "Details on the account's acceptance of the Stripe Treasury Services Agreement." + @typedoc "Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance)." @type tos_acceptance :: %{ optional(:date) => integer, optional(:ip) => binary, - optional(:user_agent) => binary | binary + optional(:service_agreement) => binary, + optional(:user_agent) => binary } ) @@ -602,11 +603,8 @@ defmodule Stripe.Account do ) ( - @typedoc "The individual's verification document information." - @type verification :: %{ - optional(:additional_document) => additional_document, - optional(:document) => document - } + @typedoc "Information on the verification state of the company." + @type verification :: %{optional(:document) => document} ) ( diff --git a/lib/generated/checkout__session.ex b/lib/generated/checkout__session.ex index c364781c..9d89f0f8 100644 --- a/lib/generated/checkout__session.ex +++ b/lib/generated/checkout__session.ex @@ -238,7 +238,15 @@ defmodule Stripe.Checkout.Session do ( @typedoc nil - @type custom_fields :: %{optional(:name) => binary, optional(:value) => binary} + @type custom_fields :: %{ + optional(:dropdown) => dropdown, + optional(:key) => binary, + optional(:label) => label, + optional(:numeric) => numeric, + optional(:optional) => boolean, + optional(:text) => text, + optional(:type) => :dropdown | :numeric | :text + } ) ( diff --git a/lib/generated/event.ex b/lib/generated/event.ex index f3760d48..0dfcb0c4 100644 --- a/lib/generated/event.ex +++ b/lib/generated/event.ex @@ -1,7 +1,7 @@ defmodule Stripe.Event do use Stripe.Entity - @moduledoc "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events]\n(/docs/webhooks) so that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days." + @moduledoc "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days." ( defstruct [ :account, diff --git a/lib/generated/issuing__authorization.ex b/lib/generated/issuing__authorization.ex index 408ddb5d..5fd0687c 100644 --- a/lib/generated/issuing__authorization.ex +++ b/lib/generated/issuing__authorization.ex @@ -31,7 +31,7 @@ defmodule Stripe.Issuing.Authorization do :wallet ] - @typedoc "The `issuing.authorization` type.\n\n * `amount` The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `amount_details` Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `approved` Whether the authorization has been approved.\n * `authorization_method` How the card details were provided.\n * `balance_transactions` List of balance transactions associated with this authorization.\n * `card` \n * `cardholder` The cardholder to whom this authorization belongs.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` 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).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `merchant_amount` The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `merchant_currency` The currency that was presented to the cardholder for the authorization. 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).\n * `merchant_data` \n * `metadata` 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.\n * `network_data` Details about the authorization, such as identifiers, set by the card network.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending_request` The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.\n * `request_history` History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.\n * `status` The current status of the authorization in its lifecycle.\n * `token` [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.\n * `transactions` List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.\n * `treasury` [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).\n * `verification_data` \n * `wallet` The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.\n" + @typedoc "The `issuing.authorization` type.\n\n * `amount` The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.\n * `amount_details` Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).\n * `approved` Whether the authorization has been approved.\n * `authorization_method` How the card details were provided.\n * `balance_transactions` List of balance transactions associated with this authorization.\n * `card` \n * `cardholder` The cardholder to whom this authorization belongs.\n * `created` Time at which the object was created. Measured in seconds since the Unix epoch.\n * `currency` The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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).\n * `id` Unique identifier for the object.\n * `livemode` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.\n * `merchant_amount` The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.\n * `merchant_currency` The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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).\n * `merchant_data` \n * `metadata` 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.\n * `network_data` Details about the authorization, such as identifiers, set by the card network.\n * `object` String representing the object's type. Objects of the same type share the same value.\n * `pending_request` The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.\n * `request_history` History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.\n * `status` The current status of the authorization in its lifecycle.\n * `token` [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.\n * `transactions` List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.\n * `treasury` [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).\n * `verification_data` \n * `wallet` The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.\n" @type t :: %__MODULE__{ amount: integer, amount_details: term | nil, diff --git a/lib/generated/payment_intent.ex b/lib/generated/payment_intent.ex index bbc4ef3d..e78dadda 100644 --- a/lib/generated/payment_intent.ex +++ b/lib/generated/payment_intent.ex @@ -101,7 +101,7 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil + @typedoc "Shipping address." @type address :: %{ optional(:city) => binary, optional(:country) => binary, @@ -136,8 +136,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account." - @type au_becs_debit :: %{optional(:account_number) => binary, optional(:bsb_number) => binary} + @typedoc nil + @type au_becs_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} ) ( @@ -149,8 +149,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type bacs_debit :: %{optional(:setup_future_usage) => :none | :off_session | :on_session} + @typedoc "If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account." + @type bacs_debit :: %{optional(:account_number) => binary, optional(:sort_code) => binary} ) ( @@ -285,38 +285,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method." - @type eps :: %{ - optional(:bank) => - :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 - } + @typedoc nil + @type eps :: %{optional(:setup_future_usage) => :none} ) ( @@ -335,8 +305,33 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type fpx :: %{optional(:setup_future_usage) => :none} + @typedoc "If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method." + @type fpx :: %{ + optional(:account_holder_type) => :company | :individual, + optional(:bank) => + :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 + } ) ( @@ -350,8 +345,25 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type ideal :: %{optional(:setup_future_usage) => :none | :off_session} + @typedoc "If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method." + @type ideal :: %{ + optional(:bank) => + :abn_amro + | :asn_bank + | :bunq + | :handelsbanken + | :ing + | :knab + | :moneyou + | :n26 + | :rabobank + | :regiobank + | :revolut + | :sns_bank + | :triodos_bank + | :van_lanschot + | :yoursafe + } ) ( @@ -360,8 +372,56 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method." - @type klarna :: %{optional(:dob) => dob} + @typedoc nil + @type klarna :: %{ + optional(:capture_method) => :manual, + optional(:preferred_locale) => + :"cs-CZ" + | :"da-DK" + | :"de-AT" + | :"de-CH" + | :"de-DE" + | :"el-GR" + | :"en-AT" + | :"en-AU" + | :"en-BE" + | :"en-CA" + | :"en-CH" + | :"en-CZ" + | :"en-DE" + | :"en-DK" + | :"en-ES" + | :"en-FI" + | :"en-FR" + | :"en-GB" + | :"en-GR" + | :"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", + optional(:setup_future_usage) => :none + } ) ( @@ -390,17 +450,12 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc "Configuration options for setting up an eMandate for cards issued in India." + @typedoc "Additional fields for Mandate creation" @type mandate_options :: %{ - optional(:amount) => integer, - optional(:amount_type) => :fixed | :maximum, - optional(:description) => binary, - optional(:end_date) => integer, - optional(:interval) => :day | :month | :sporadic | :week | :year, - optional(:interval_count) => integer, - optional(:reference) => binary, - optional(:start_date) => integer, - optional(:supported_types) => list(:india) + optional(:custom_mandate_url) => binary | binary, + optional(:interval_description) => binary, + optional(:payment_schedule) => :combined | :interval | :sporadic, + optional(:transaction_type) => :business | :personal } ) @@ -638,11 +693,8 @@ defmodule Stripe.PaymentIntent do ) ( - @typedoc nil - @type sepa_debit :: %{ - optional(:mandate_options) => map(), - optional(:setup_future_usage) => :none | :off_session | :on_session - } + @typedoc "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account." + @type sepa_debit :: %{optional(:iban) => binary} ) ( diff --git a/lib/generated/price.ex b/lib/generated/price.ex index 9c90a42f..80d3c1f6 100644 --- a/lib/generated/price.ex +++ b/lib/generated/price.ex @@ -145,7 +145,7 @@ defmodule Stripe.Price do ( nil - @doc "

Returns a list of your active prices. For the list of inactive prices, set active to false.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices`\n" + @doc "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

\n\n#### Details\n\n * Method: `get`\n * Path: `/v1/prices`\n" ( @spec list( params :: %{ diff --git a/lib/generated/setup_intent.ex b/lib/generated/setup_intent.ex index 0689d556..5d78c851 100644 --- a/lib/generated/setup_intent.ex +++ b/lib/generated/setup_intent.ex @@ -431,8 +431,8 @@ defmodule Stripe.SetupIntent do ) ( - @typedoc "If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options." - @type sepa_debit :: %{optional(:mandate_options) => map()} + @typedoc "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account." + @type sepa_debit :: %{optional(:iban) => binary} ) ( diff --git a/lib/generated/token.ex b/lib/generated/token.ex index 5d6c6d71..7a25df5b 100644 --- a/lib/generated/token.ex +++ b/lib/generated/token.ex @@ -20,11 +20,12 @@ defmodule Stripe.Token do ) ( - @typedoc "Details on the legal guardian's acceptance of the main Stripe service agreement." + @typedoc "Information for the account this token represents." @type account :: %{ - optional(:date) => integer, - optional(:ip) => binary, - optional(:user_agent) => binary | binary + optional(:business_type) => :company | :government_entity | :individual | :non_profit, + optional(:company) => company, + optional(:individual) => individual, + optional(:tos_shown_and_accepted) => boolean } ) @@ -51,7 +52,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kana variation of the company's primary address (Japan only)." + @typedoc "The Kana variation of the person's address (Japan only)." @type address_kana :: %{ optional(:city) => binary, optional(:country) => binary, @@ -64,7 +65,7 @@ defmodule Stripe.Token do ) ( - @typedoc "The Kanji variation of the person's address (Japan only)." + @typedoc "The Kanji variation of the company's primary address (Japan only)." @type address_kanji :: %{ optional(:city) => binary, optional(:country) => binary, @@ -175,7 +176,7 @@ defmodule Stripe.Token do ) ( - @typedoc "A document verifying the business." + @typedoc "An identifying document, either a passport or local ID card." @type document :: %{optional(:back) => binary, optional(:front) => binary} ) @@ -293,11 +294,8 @@ defmodule Stripe.Token do ) ( - @typedoc "The individual's verification document information." - @type verification :: %{ - optional(:additional_document) => additional_document, - optional(:document) => document - } + @typedoc "Information on the verification state of the company." + @type verification :: %{optional(:document) => document} ) ( diff --git a/priv/openapi/spec3.sdk.json b/priv/openapi/spec3.sdk.json index e65d79d2..9d7a7706 100644 --- a/priv/openapi/spec3.sdk.json +++ b/priv/openapi/spec3.sdk.json @@ -12067,7 +12067,7 @@ } }, "event": { - "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events]\n(/docs/webhooks) so that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.", + "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days.", "properties": { "account": { "description": "The connected account that originates the event.", @@ -18064,7 +18064,7 @@ "description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)", "properties": { "amount": { - "description": "The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.", "type": "integer" }, "amount_details": { @@ -18127,7 +18127,7 @@ "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).", + "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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": { @@ -18140,11 +18140,11 @@ "type": "boolean" }, "merchant_amount": { - "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", + "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.", "type": "integer" }, "merchant_currency": { - "description": "The currency that was presented to the cardholder for the authorization. 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).", + "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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" }, "merchant_data": { @@ -19630,10 +19630,24 @@ "maxLength": 5000, "nullable": true, "type": "string" + }, + "system_trace_audit_number": { + "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "transaction_id": { + "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ - "acquiring_institution_id" + "acquiring_institution_id", + "system_trace_audit_number", + "transaction_id" ], "title": "IssuingAuthorizationNetworkData", "type": "object", @@ -19674,6 +19688,11 @@ "merchant_currency": { "description": "The local currency the merchant is requesting to authorize.", "type": "string" + }, + "network_risk_score": { + "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", + "nullable": true, + "type": "integer" } }, "required": [ @@ -19682,7 +19701,8 @@ "currency", "is_amount_controllable", "merchant_amount", - "merchant_currency" + "merchant_currency", + "network_risk_score" ], "title": "IssuingAuthorizationPendingRequest", "type": "object", @@ -19739,6 +19759,11 @@ "maxLength": 5000, "type": "string" }, + "network_risk_score": { + "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.", + "nullable": true, + "type": "integer" + }, "reason": { "description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.", "enum": [ @@ -19761,10 +19786,16 @@ "x-stripeBypassValidation": true }, "reason_message": { - "description": "If approve/decline decision is directly responsed to the webhook with json payload and if the response is invalid (e.g., parsing errors), we surface the detailed message via this field.", + "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.", "maxLength": 5000, "nullable": true, "type": "string" + }, + "requested_at": { + "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.", + "format": "unix-time", + "nullable": true, + "type": "integer" } }, "required": [ @@ -19776,8 +19807,10 @@ "currency", "merchant_amount", "merchant_currency", + "network_risk_score", "reason", - "reason_message" + "reason_message", + "requested_at" ], "title": "IssuingAuthorizationRequest", "type": "object", @@ -23769,15 +23802,29 @@ "issuing_transaction_network_data": { "description": "", "properties": { + "authorization_code": { + "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, "processing_date": { "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.", "maxLength": 5000, "nullable": true, "type": "string" + }, + "transaction_id": { + "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.", + "maxLength": 5000, + "nullable": true, + "type": "string" } }, "required": [ - "processing_date" + "authorization_code", + "processing_date", + "transaction_id" ], "title": "IssuingTransactionNetworkData", "type": "object", @@ -32117,6 +32164,15 @@ "nullable": true, "type": "string" }, + "offline": { + "anyOf": [ + { + "$ref": "#/components/schemas/payment_method_details_card_present_offline" + } + ], + "description": "Details about payments collected offline.", + "nullable": true + }, "overcapture_supported": { "description": "Defines whether the authorized amount can be over-captured or not", "type": "boolean" @@ -32157,6 +32213,7 @@ "incremental_authorization_supported", "last4", "network", + "offline", "overcapture_supported", "read_method", "receipt" @@ -32164,6 +32221,7 @@ "title": "payment_method_details_card_present", "type": "object", "x-expandableFields": [ + "offline", "receipt" ], "x-stripeResource": { @@ -32171,6 +32229,27 @@ "in_package": "" } }, + "payment_method_details_card_present_offline": { + "description": "", + "properties": { + "stored_at": { + "description": "Time at which the payment was collected while offline", + "format": "unix-time", + "nullable": true, + "type": "integer" + } + }, + "required": [ + "stored_at" + ], + "title": "payment_method_details_card_present_offline", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "Offline", + "in_package": "" + } + }, "payment_method_details_card_present_receipt": { "description": "", "properties": { @@ -111542,7 +111621,7 @@ }, "/v1/prices": { "get": { - "description": "

Returns a list of your active prices. For the list of inactive prices, set active to false.

", + "description": "

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

", "operationId": "GetPrices", "parameters": [ {