Skip to content

Commit

Permalink
Update OpenAPI specification for beta
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Oct 15, 2024
1 parent a778ed9 commit b2d9cd6
Show file tree
Hide file tree
Showing 2 changed files with 504 additions and 0 deletions.
282 changes: 282 additions & 0 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16299,6 +16299,13 @@
"method_type": "retrieve",
"operation": "get",
"path": "/v1/customers/{customer}/cash_balance_transactions/{transaction}"
},
{
"method_name": "create",
"method_on": "service",
"method_type": "create",
"operation": "post",
"path": "/v1/test_helpers/customer_cash_balance_transactions"
}
],
"x-stripeResource": {
Expand Down Expand Up @@ -227841,6 +227848,281 @@
"summary": "Create a test Confirmation Token"
}
},
"/v1/test_helpers/customer_cash_balance_transactions": {
"post": {
"description": "<p>Simulate various customer cash balance side-effects by creating synthetic cash balance transactions in testmode.</p>",
"operationId": "PostTestHelpersCustomerCashBalanceTransactions",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
"expand": {
"explode": true,
"style": "deepObject"
},
"funded": {
"explode": true,
"style": "deepObject"
},
"funding_reversed": {
"explode": true,
"style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
"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).",
"maxLength": 5000,
"type": "string"
},
"customer": {
"description": "The ID of the customer.",
"maxLength": 5000,
"type": "string"
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
},
"funded": {
"description": "If this is a `type=funded` transaction, contains information about the funding.",
"properties": {
"bank_transfer": {
"properties": {
"ca_bank_transfer": {
"description": "CA-specific details of the bank transfer funding.",
"properties": {},
"title": "ca_bank_transfer_param",
"type": "object"
},
"eu_bank_transfer": {
"description": "EU-specific details of the bank transfer funding.",
"properties": {
"bic": {
"maxLength": 5000,
"type": "string"
},
"iban_last4": {
"maxLength": 5000,
"type": "string"
},
"network": {
"enum": [
"sepa",
"swift"
],
"type": "string"
},
"sender_name": {
"maxLength": 5000,
"type": "string"
}
},
"title": "eu_bank_transfer_param",
"type": "object",
"x-stripeMostCommon": [
"bic",
"iban_last4",
"network",
"sender_name"
]
},
"gb_bank_transfer": {
"description": "GB-specific details of the bank transfer funding.",
"properties": {
"account_number_last4": {
"maxLength": 5000,
"type": "string"
},
"sender_name": {
"maxLength": 5000,
"type": "string"
},
"sort_code": {
"maxLength": 5000,
"type": "string"
}
},
"title": "gb_bank_transfer_param",
"type": "object",
"x-stripeMostCommon": [
"account_number_last4",
"sender_name",
"sort_code"
]
},
"jp_bank_transfer": {
"description": "JP-specific details of the bank transfer funding.",
"properties": {
"sender_bank": {
"maxLength": 5000,
"type": "string"
},
"sender_branch": {
"maxLength": 5000,
"type": "string"
},
"sender_name": {
"maxLength": 5000,
"type": "string"
}
},
"title": "jp_bank_transfer_param",
"type": "object",
"x-stripeMostCommon": [
"sender_bank",
"sender_branch",
"sender_name"
]
},
"mx_bank_transfer": {
"description": "MX-specific details of the bank transfer funding.",
"properties": {},
"title": "mx_bank_transfer_param",
"type": "object"
},
"reference": {
"maxLength": 5000,
"type": "string"
},
"type": {
"enum": [
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"us_bank_transfer"
],
"type": "string",
"x-stripeBypassValidation": true
},
"us_bank_transfer": {
"description": "US-specific details of the bank transfer funding.",
"properties": {
"network": {
"enum": [
"ach",
"domestic_wire_us",
"swift"
],
"type": "string"
},
"sender_name": {
"maxLength": 5000,
"type": "string"
}
},
"title": "us_bank_transfer_param",
"type": "object",
"x-stripeMostCommon": [
"network",
"sender_name"
]
}
},
"title": "bank_transfer_param",
"type": "object",
"x-stripeMostCommon": [
"ca_bank_transfer",
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"reference",
"type",
"us_bank_transfer"
]
}
},
"required": [
"bank_transfer"
],
"title": "testmode_funded_transaction_param",
"type": "object",
"x-stripeMostCommon": [
"bank_transfer"
]
},
"funding_reversed": {
"description": "If this is a `type=funding_reversed` transaction, contains information about the reversal of a funding.",
"properties": {
"reversed_customer_cash_balance_transaction": {
"description": "The ID of the `funded` cash balance transaction to be reversed.",
"type": "string"
}
},
"required": [
"reversed_customer_cash_balance_transaction"
],
"title": "testmode_funding_reversed_param",
"type": "object",
"x-stripeMostCommon": [
"reversed_customer_cash_balance_transaction"
]
},
"net_amount": {
"description": "The amount associated with the cash balance transaction. Only applicable to transactions of type `funded`.",
"type": "integer"
},
"type": {
"description": "The type of cash balance transaction to generate.",
"enum": [
"funded",
"funding_reversed"
],
"type": "string"
}
},
"required": [
"currency",
"customer",
"type"
],
"type": "object",
"x-stripeMostCommon": [
"currency",
"customer",
"funded",
"funding_reversed",
"net_amount",
"type"
]
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer_cash_balance_transaction"
}
}
},
"description": "Successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
},
"description": "Error response."
}
},
"summary": "Create testmode Customer cash balance transaction"
}
},
"/v1/test_helpers/customers/{customer}/fund_cash_balance": {
"post": {
"description": "<p>Create an incoming testmode bank transfer</p>",
Expand Down
Loading

0 comments on commit b2d9cd6

Please sign in to comment.