Update OpenAPI specification

stripe · Jul 24, 2024 · a9ad882 · a9ad882
1 parent a319bdc
commit a9ad882
Show file tree

Hide file tree

Showing 6 changed files with 314 additions and 0 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -40780,6 +40780,12 @@
             "nullable": true,
             "type": "string"
           },
+          "brand_product": {
+            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
+            "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,
@@ -40869,6 +40875,7 @@
         },
         "required": [
           "brand",
+          "brand_product",
           "cardholder_name",
           "country",
           "exp_month",
@@ -42370,6 +42377,12 @@
             "nullable": true,
             "type": "string"
           },
+          "brand_product": {
+            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
+            "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",
@@ -42453,6 +42466,12 @@
             "nullable": true,
             "type": "string"
           },
+          "network_transaction_id": {
+            "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "offline": {
             "anyOf": [
               {
@@ -42500,6 +42519,7 @@
         "required": [
           "amount_authorized",
           "brand",
+          "brand_product",
           "cardholder_name",
           "country",
           "emv_auth_data",
@@ -42511,6 +42531,7 @@
           "incremental_authorization_supported",
           "last4",
           "network",
+          "network_transaction_id",
           "offline",
           "overcapture_supported",
           "preferred_locales",
@@ -43207,6 +43228,12 @@
             "nullable": true,
             "type": "string"
           },
+          "network_transaction_id": {
+            "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "preferred_locales": {
             "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
             "items": {
@@ -43250,6 +43277,7 @@
           "generated_card",
           "last4",
           "network",
+          "network_transaction_id",
           "preferred_locales",
           "read_method",
           "receipt"

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -37009,6 +37009,13 @@ components:
           maxLength: 5000
           nullable: true
           type: string
+        brand_product:
+          description: >-
+            The [product code](https://stripe.com/docs/card-product-codes) that
+            identifies the specific program or product associated with a card.
+          maxLength: 5000
+          nullable: true
+          type: string
         cardholder_name:
           description: >-
             The cardholder name as read from the card, in [ISO
@@ -37113,6 +37120,7 @@ components:
           type: string
       required:
         - brand
+        - brand_product
         - cardholder_name
         - country
         - exp_month
@@ -38485,6 +38493,13 @@ components:
           maxLength: 5000
           nullable: true
           type: string
+        brand_product:
+          description: >-
+            The [product code](https://stripe.com/docs/card-product-codes) that
+            identifies the specific program or product associated with a card.
+          maxLength: 5000
+          nullable: true
+          type: string
         capture_before:
           description: >-
             When using manual capture, a future timestamp after which the charge
@@ -38596,6 +38611,22 @@ components:
           maxLength: 5000
           nullable: true
           type: string
+        network_transaction_id:
+          description: >-
+            This is used by the financial networks to identify a transaction.
+
+            Visa calls this the Transaction ID, Mastercard calls this the Trace
+            ID, and American Express calls this the Acquirer Reference Data.
+
+            The first three digits of the Trace ID is the Financial Network
+            Code, the next 6 digits is the Banknet Reference Number, and the
+            last 4 digits represent the date (MM/DD).
+
+            This field will be available for successful Visa, Mastercard, or
+            American Express transactions and always null for other card brands.
+          maxLength: 5000
+          nullable: true
+          type: string
         offline:
           anyOf:
             - $ref: '#/components/schemas/payment_method_details_card_present_offline'
@@ -38633,6 +38664,7 @@ components:
       required:
         - amount_authorized
         - brand
+        - brand_product
         - cardholder_name
         - country
         - emv_auth_data
@@ -38644,6 +38676,7 @@ components:
         - incremental_authorization_supported
         - last4
         - network
+        - network_transaction_id
         - offline
         - overcapture_supported
         - preferred_locales
@@ -39332,6 +39365,22 @@ components:
           maxLength: 5000
           nullable: true
           type: string
+        network_transaction_id:
+          description: >-
+            This is used by the financial networks to identify a transaction.
+
+            Visa calls this the Transaction ID, Mastercard calls this the Trace
+            ID, and American Express calls this the Acquirer Reference Data.
+
+            The first three digits of the Trace ID is the Financial Network
+            Code, the next 6 digits is the Banknet Reference Number, and the
+            last 4 digits represent the date (MM/DD).
+
+            This field will be available for successful Visa, Mastercard, or
+            American Express transactions and always null for other card brands.
+          maxLength: 5000
+          nullable: true
+          type: string
         preferred_locales:
           description: >-
             EMV tag 5F2D. Preferred languages specified by the integrated
@@ -39371,6 +39420,7 @@ components:
         - generated_card
         - last4
         - network
+        - network_transaction_id
         - preferred_locales
         - read_method
         - receipt

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -28746,6 +28746,12 @@
             "nullable": true,
             "type": "string"
           },
+          "brand_product": {
+            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
+            "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,
@@ -28758,6 +28764,12 @@
             "nullable": true,
             "type": "string"
           },
+          "description": {
+            "description": "A high-level description of the type of cards issued in this range.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "exp_month": {
             "description": "Two-digit number representing the card's expiration month.",
             "type": "integer"
@@ -28778,6 +28790,12 @@
             "nullable": true,
             "type": "string"
           },
+          "issuer": {
+            "description": "The name of the card's issuing bank.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "last4": {
             "description": "The last four digits of the card.",
             "maxLength": 5000,
@@ -30136,6 +30154,12 @@
             "nullable": true,
             "type": "string"
           },
+          "brand_product": {
+            "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.",
+            "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",
@@ -30153,6 +30177,12 @@
             "nullable": true,
             "type": "string"
           },
+          "description": {
+            "description": "A high-level description of the type of cards issued in this range.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "emv_auth_data": {
             "description": "Authorization response cryptogram.",
             "maxLength": 5000,
@@ -30189,6 +30219,12 @@
             "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"
           },
+          "issuer": {
+            "description": "The name of the card's issuing bank.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "last4": {
             "description": "The last four digits of the card.",
             "maxLength": 5000,
@@ -30201,6 +30237,12 @@
             "nullable": true,
             "type": "string"
           },
+          "network_transaction_id": {
+            "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "offline": {
             "anyOf": [
               {
@@ -30813,6 +30855,12 @@
             "nullable": true,
             "type": "string"
           },
+          "description": {
+            "description": "A high-level description of the type of cards issued in this range.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "emv_auth_data": {
             "description": "Authorization response cryptogram.",
             "maxLength": 5000,
@@ -30845,6 +30893,12 @@
             "nullable": true,
             "type": "string"
           },
+          "issuer": {
+            "description": "The name of the card's issuing bank.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "last4": {
             "description": "The last four digits of the card.",
             "maxLength": 5000,
@@ -30857,6 +30911,12 @@
             "nullable": true,
             "type": "string"
           },
+          "network_transaction_id": {
+            "description": "This is used by the financial networks to identify a transaction.\nVisa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data.\nThe first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD).\nThis field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "preferred_locales": {
             "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.",
             "items": {
@@ -31810,6 +31870,12 @@
             "nullable": true,
             "type": "string"
           },
+          "description": {
+            "description": "A high-level description of the type of cards issued in this range.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "exp_month": {
             "description": "Two-digit number representing the card's expiration month.",
             "type": "integer"
@@ -31830,6 +31896,12 @@
             "nullable": true,
             "type": "string"
           },
+          "issuer": {
+            "description": "The name of the card's issuing bank.",
+            "maxLength": 5000,
+            "nullable": true,
+            "type": "string"
+          },
           "last4": {
             "description": "The last four digits of the card.",
             "maxLength": 5000,