Update OpenAPI specification

stripe · Aug 7, 2024 · f86d2ed · f86d2ed
1 parent facd678
commit f86d2ed
Show file tree

Hide file tree

Showing 2 changed files with 175 additions and 0 deletions.
diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -153083,6 +153083,101 @@
         }
       }
     },
+    "/v1/test_helpers/issuing/settlements": {
+      "post": {
+        "description": "<p>Allows the user to create an Issuing settlement.</p>",
+        "operationId": "PostTestHelpersIssuingSettlements",
+        "requestBody": {
+          "content": {
+            "application/x-www-form-urlencoded": {
+              "encoding": {
+                "expand": {
+                  "explode": true,
+                  "style": "deepObject"
+                }
+              },
+              "schema": {
+                "additionalProperties": false,
+                "properties": {
+                  "bin": {
+                    "description": "The Bank Identification Number reflecting this settlement record.",
+                    "maxLength": 5000,
+                    "type": "string"
+                  },
+                  "clearing_date": {
+                    "description": "The date that the transactions are cleared and posted to user's accounts.",
+                    "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"
+                  },
+                  "expand": {
+                    "description": "Specifies which fields in the response should be expanded.",
+                    "items": {
+                      "maxLength": 5000,
+                      "type": "string"
+                    },
+                    "type": "array"
+                  },
+                  "interchange_fees": {
+                    "description": "The total interchange received as reimbursement for the transactions.",
+                    "type": "integer"
+                  },
+                  "net_total": {
+                    "description": "The total net amount required to settle with the network.",
+                    "type": "integer"
+                  },
+                  "network_settlement_identifier": {
+                    "description": "The Settlement Identification Number assigned by the network.",
+                    "maxLength": 5000,
+                    "type": "string"
+                  },
+                  "transaction_count": {
+                    "description": "The total number of transactions reflected in this settlement.",
+                    "type": "integer"
+                  },
+                  "transaction_volume": {
+                    "description": "The total transaction amount reflected in this settlement.",
+                    "type": "integer"
+                  }
+                },
+                "required": [
+                  "bin",
+                  "clearing_date",
+                  "currency",
+                  "net_total"
+                ],
+                "type": "object"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/issuing.settlement"
+                }
+              }
+            },
+            "description": "Successful response."
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/error"
+                }
+              }
+            },
+            "description": "Error response."
+          }
+        }
+      }
+    },
     "/v1/test_helpers/issuing/transactions/create_force_capture": {
       "post": {
         "description": "<p>Allows the user to capture an arbitrary amount, also known as a forced capture.</p>",

diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
@@ -128846,6 +128846,86 @@ paths:
               schema:
                 $ref: '#/components/schemas/error'
           description: Error response.
+  /v1/test_helpers/issuing/settlements:
+    post:
+      description: <p>Allows the user to create an Issuing settlement.</p>
+      operationId: PostTestHelpersIssuingSettlements
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            encoding:
+              expand:
+                explode: true
+                style: deepObject
+            schema:
+              additionalProperties: false
+              properties:
+                bin:
+                  description: >-
+                    The Bank Identification Number reflecting this settlement
+                    record.
+                  maxLength: 5000
+                  type: string
+                clearing_date:
+                  description: >-
+                    The date that the transactions are cleared and posted to
+                    user's accounts.
+                  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
+                expand:
+                  description: Specifies which fields in the response should be expanded.
+                  items:
+                    maxLength: 5000
+                    type: string
+                  type: array
+                interchange_fees:
+                  description: >-
+                    The total interchange received as reimbursement for the
+                    transactions.
+                  type: integer
+                net_total:
+                  description: The total net amount required to settle with the network.
+                  type: integer
+                network_settlement_identifier:
+                  description: >-
+                    The Settlement Identification Number assigned by the
+                    network.
+                  maxLength: 5000
+                  type: string
+                transaction_count:
+                  description: >-
+                    The total number of transactions reflected in this
+                    settlement.
+                  type: integer
+                transaction_volume:
+                  description: The total transaction amount reflected in this settlement.
+                  type: integer
+              required:
+                - bin
+                - clearing_date
+                - currency
+                - net_total
+              type: object
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/issuing.settlement'
+          description: Successful response.
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/error'
+          description: Error response.
   /v1/test_helpers/issuing/transactions/create_force_capture:
     post:
       description: >-