c518aa1319
Stripe Starter toolkit auto-generated from the official [OpenAPI specification](https://raw.githubusercontent.com/stripe/openapi/refs/heads/master/openapi/spec3.json).
266 lines
10 KiB
JSON
266 lines
10 KiB
JSON
{
|
|
"name": "GetReceivedDebits",
|
|
"fully_qualified_name": "StripeApi.GetReceivedDebits@0.1.0",
|
|
"description": "Retrieve a list of received debits from Stripe Treasury.\n\nCall this tool to obtain a list of received debits, which can be useful for financial reporting or auditing purposes.",
|
|
"toolkit": {
|
|
"name": "ArcadeStripeApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "financial_account_id",
|
|
"required": true,
|
|
"description": "The ID of the FinancialAccount from which funds were pulled.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The FinancialAccount that funds were pulled from."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "financial_account"
|
|
},
|
|
{
|
|
"name": "pagination_cursor_previous_page",
|
|
"required": false,
|
|
"description": "A cursor for pagination to fetch the previous page of the list. Use an object ID received in a previous response.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "ending_before"
|
|
},
|
|
{
|
|
"name": "expand_fields",
|
|
"required": false,
|
|
"description": "List of fields in the response to expand for more detailed information.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Specifies which fields in the response should be expanded."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "expand"
|
|
},
|
|
{
|
|
"name": "max_number_of_debits",
|
|
"required": false,
|
|
"description": "Specify the maximum number of received debits to return. Accepts an integer between 1 and 100, default is 10.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "limit"
|
|
},
|
|
{
|
|
"name": "pagination_starting_after",
|
|
"required": false,
|
|
"description": "An object ID for pagination to fetch the next page, starting after this ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "starting_after"
|
|
},
|
|
{
|
|
"name": "debit_status_filter",
|
|
"required": false,
|
|
"description": "Filter results by status: 'succeeded' or 'failed'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"failed",
|
|
"succeeded"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "status"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'GetTreasuryReceivedDebits'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "STRIPE_API_KEY"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.0.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Stripe API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.0.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.stripe.com/v1/treasury/received_debits",
|
|
"http_method": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "ending_before",
|
|
"tool_parameter_name": "pagination_cursor_previous_page",
|
|
"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.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"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."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "expand",
|
|
"tool_parameter_name": "expand_fields",
|
|
"description": "Specifies which fields in the response should be expanded.",
|
|
"value_schema": {
|
|
"val_type": "array",
|
|
"inner_val_type": "string",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Specifies which fields in the response should be expanded."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "financial_account",
|
|
"tool_parameter_name": "financial_account_id",
|
|
"description": "The FinancialAccount that funds were pulled from.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The FinancialAccount that funds were pulled from."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"tool_parameter_name": "max_number_of_debits",
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "starting_after",
|
|
"tool_parameter_name": "pagination_starting_after",
|
|
"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.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"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."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "status",
|
|
"tool_parameter_name": "debit_status_filter",
|
|
"description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"failed",
|
|
"succeeded"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Only return ReceivedDebits that have the given status: `succeeded` or `failed`."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "STRIPE_API_KEY",
|
|
"parameter_name": "Authorization",
|
|
"accepted_as": "header",
|
|
"formatted_value": "Bearer {authorization}",
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
]
|
|
}
|
|
}
|