From 22058db3c8e4f38b3204c2e8128812535d50cbb1 Mon Sep 17 00:00:00 2001
From: "stripe-openapi[bot]"
<105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Mon, 1 Jul 2024 16:31:31 +0000
Subject: [PATCH] OpenAPI Update (#893)
Update OpenAPI for 6736cfd004d8fe6b562cfd8571259ae4842cdf65
Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
---
embedded/openapi/spec3.beta.sdk.json | 413 ++++++++++++++++++++++++++-
1 file changed, 407 insertions(+), 6 deletions(-)
diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json
index a28b341..094e104 100644
--- a/embedded/openapi/spec3.beta.sdk.json
+++ b/embedded/openapi/spec3.beta.sdk.json
@@ -2465,6 +2465,7 @@
"email_invalid",
"expired_card",
"financial_connections_account_inactive",
+ "financial_connections_institution_unavailable",
"financial_connections_no_successful_transaction_refresh",
"forwarding_api_inactive",
"forwarding_api_invalid_parameter",
@@ -4094,6 +4095,52 @@
"type": "object",
"x-expandableFields": []
},
+ "bank_connections_resource_institution_feature_support": {
+ "description": "",
+ "properties": {
+ "balances": {
+ "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature"
+ },
+ "ownership": {
+ "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature"
+ },
+ "payment_method": {
+ "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature"
+ },
+ "transactions": {
+ "$ref": "#/components/schemas/bank_connections_resource_institution_supported_feature"
+ }
+ },
+ "required": [
+ "balances",
+ "ownership",
+ "payment_method",
+ "transactions"
+ ],
+ "title": "BankConnectionsResourceInstitutionFeatureSupport",
+ "type": "object",
+ "x-expandableFields": [
+ "balances",
+ "ownership",
+ "payment_method",
+ "transactions"
+ ]
+ },
+ "bank_connections_resource_institution_supported_feature": {
+ "description": "",
+ "properties": {
+ "supported": {
+ "description": "Whether the given feature is supported by this institution.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "supported"
+ ],
+ "title": "BankConnectionsResourceInstitutionSupportedFeature",
+ "type": "object",
+ "x-expandableFields": []
+ },
"bank_connections_resource_link_account_session_filters": {
"description": "",
"properties": {
@@ -4120,6 +4167,11 @@
},
"nullable": true,
"type": "array"
+ },
+ "institution": {
+ "description": "Stripe ID of the institution with which the customer should be directed to log in.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"required": [
@@ -17582,11 +17634,11 @@
"description": "The list of data refresh subscriptions requested on this account.",
"items": {
"enum": [
+ "balance",
"inferred_balances",
"transactions"
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
},
"nullable": true,
"type": "array"
@@ -18029,6 +18081,95 @@
"in_package": "FinancialConnections"
}
},
+ "financial_connections.institution": {
+ "description": "An institution represents a banking institution which may be available for an end user to select in the Financial Connections authentication flow.",
+ "properties": {
+ "features": {
+ "$ref": "#/components/schemas/bank_connections_resource_institution_feature_support"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "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"
+ },
+ "name": {
+ "description": "The name of this institution.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "financial_connections.institution"
+ ],
+ "type": "string"
+ },
+ "routing_numbers": {
+ "description": "A list of routing numbers which are known to correspond to this institution.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "The status of this institution in the Financial Connections authentication flow.",
+ "enum": [
+ "active",
+ "degraded",
+ "inactive"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL for this institution's website.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "features",
+ "id",
+ "livemode",
+ "name",
+ "object",
+ "routing_numbers",
+ "status",
+ "url"
+ ],
+ "title": "BankConnectionsResourceExternalInstitution",
+ "type": "object",
+ "x-expandableFields": [
+ "features"
+ ],
+ "x-resourceId": "financial_connections.institution",
+ "x-stripeOperations": [
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/financial_connections/institutions"
+ },
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/financial_connections/institutions/{institution}"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "Institution",
+ "has_collection_class": true,
+ "in_package": "FinancialConnections"
+ }
+ },
"financial_connections.session": {
"description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.",
"properties": {
@@ -22693,6 +22834,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "The institution to use to filter for possible accounts to link.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters",
@@ -35674,6 +35820,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "The institution to use to filter for possible accounts to link.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters",
@@ -102286,11 +102437,11 @@
"description": "The list of account features to which you would like to subscribe.",
"items": {
"enum": [
+ "balance",
"inferred_balances",
"transactions"
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
},
"type": "array"
}
@@ -102372,11 +102523,11 @@
"description": "The list of account features from which you would like to unsubscribe.",
"items": {
"enum": [
+ "balance",
"inferred_balances",
"transactions"
],
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
},
"type": "array"
}
@@ -102414,6 +102565,201 @@
}
}
},
+ "/v1/financial_connections/institutions": {
+ "get": {
+ "description": "Returns a list of Financial Connections Institution objects.
",
+ "operationId": "GetFinancialConnectionsInstitutions",
+ "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": {
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/financial_connections.institution"
+ },
+ "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/institutions",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "BankConnectionsResourceExternalInstitutionList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/financial_connections/institutions/{institution}": {
+ "get": {
+ "description": "Retrieves the details of a Financial Connections Institution.
",
+ "operationId": "GetFinancialConnectionsInstitutionsInstitution",
+ "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": "institution",
+ "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.institution"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/financial_connections/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.
",
@@ -102514,6 +102860,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "Stripe ID of the institution with which the customer should be directed to log in.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "filters_params",
@@ -107262,6 +107613,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "invoice_linked_account_options_filters_param",
@@ -118089,6 +118445,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "invoice_linked_account_options_filters_param",
@@ -139739,6 +140100,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -143978,6 +144344,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -149157,6 +149528,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -172906,6 +173282,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -174455,6 +174836,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -176036,6 +176422,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "linked_account_options_filters_param",
@@ -184559,6 +184950,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "invoice_linked_account_options_filters_param",
@@ -186348,6 +186744,11 @@
"type": "string"
},
"type": "array"
+ },
+ "institution": {
+ "description": "ID of the institution to use to filter for selectable accounts.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "invoice_linked_account_options_filters_param",