c518aa1319
Stripe Starter toolkit auto-generated from the official [OpenAPI specification](https://raw.githubusercontent.com/stripe/openapi/refs/heads/master/openapi/spec3.json).
270 lines
10 KiB
JSON
270 lines
10 KiB
JSON
{
|
|
"name": "GetInboundTransfers",
|
|
"fully_qualified_name": "StripeApi.GetInboundTransfers@0.1.0",
|
|
"description": "Retrieve inbound transfers for a financial account.\n\nThis tool fetches a list of inbound transfers sent from a specified financial account using Stripe's treasury services.",
|
|
"toolkit": {
|
|
"name": "ArcadeStripeApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "financial_account_id",
|
|
"required": true,
|
|
"description": "The ID of the FinancialAccount to retrieve associated inbound transfers.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Returns objects associated with this FinancialAccount."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "financial_account"
|
|
},
|
|
{
|
|
"name": "pagination_ending_before_id",
|
|
"required": false,
|
|
"description": "The object ID defining your place in the list to fetch the previous page. Use this for pagination.",
|
|
"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_response_fields",
|
|
"required": false,
|
|
"description": "List of fields in the response to be expanded for 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": "transfer_limit",
|
|
"required": false,
|
|
"description": "Set the maximum number of inbound transfer objects to return, ranging from 1 to 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_object_id",
|
|
"required": false,
|
|
"description": "Cursor for pagination to fetch the next page by using the object ID from the end of the previous result set.",
|
|
"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": "filter_by_transfer_status",
|
|
"required": false,
|
|
"description": "Filter inbound transfers by their status: 'processing', 'succeeded', 'failed', or 'canceled'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"canceled",
|
|
"failed",
|
|
"processing",
|
|
"succeeded"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "status"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'GetTreasuryInboundTransfers'.",
|
|
"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/inbound_transfers",
|
|
"http_method": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "ending_before",
|
|
"tool_parameter_name": "pagination_ending_before_id",
|
|
"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_response_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": "Returns objects associated with this FinancialAccount.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Returns objects associated with this FinancialAccount."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"tool_parameter_name": "transfer_limit",
|
|
"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_object_id",
|
|
"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": "filter_by_transfer_status",
|
|
"description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"canceled",
|
|
"failed",
|
|
"processing",
|
|
"succeeded"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`."
|
|
},
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|