{
  "name": "GetCreditReversals",
  "fully_qualified_name": "StripeApi.GetCreditReversals@0.1.0",
  "description": "Retrieve a list of Credit Reversals from Stripe's Treasury.\n\nThis tool fetches a list of Credit Reversals from Stripe's Treasury endpoint. It should be used when detailed information about credit reversals is needed.",
  "toolkit": {
    "name": "ArcadeStripeApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "financial_account_id",
        "required": true,
        "description": "The ID of the FinancialAccount associated with the CreditReversals to be returned.",
        "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",
        "required": false,
        "description": "A cursor object ID for pagination to fetch the previous list page.",
        "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": "fields_to_expand",
        "required": false,
        "description": "A list of fields to be expanded in the response 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": "max_objects_returned",
        "required": false,
        "description": "Sets the maximum number of credit reversals to be returned. Valid range is 1 to 100, defaulting to 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": "filter_by_received_credit_id",
        "required": false,
        "description": "Filter Credit Reversals to only include those associated with the specified ReceivedCredit ID.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Only return CreditReversals for the ReceivedCredit ID."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "received_credit"
      },
      {
        "name": "pagination_starting_after_cursor",
        "required": false,
        "description": "An object ID used to fetch the next page of the list in a paginated response.",
        "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": "credit_reversal_status",
        "required": false,
        "description": "Filter CreditReversals based on their status. Possible values are: canceled, posted, processing.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "canceled",
            "posted",
            "processing"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Only return CreditReversals for a given status."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "status"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'GetTreasuryCreditReversals'.",
    "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/credit_reversals",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "ending_before",
        "tool_parameter_name": "pagination_ending_before",
        "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": "fields_to_expand",
        "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": "max_objects_returned",
        "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": "received_credit",
        "tool_parameter_name": "filter_by_received_credit_id",
        "description": "Only return CreditReversals for the ReceivedCredit ID.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Only return CreditReversals for the ReceivedCredit ID."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "starting_after",
        "tool_parameter_name": "pagination_starting_after_cursor",
        "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": "credit_reversal_status",
        "description": "Only return CreditReversals for a given status.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "canceled",
            "posted",
            "processing"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Only return CreditReversals for a given status."
        },
        "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
      }
    ]
  }
}