{ "name": "RetrieveGiftCardFromToken", "fully_qualified_name": "SquareupApi.RetrieveGiftCardFromToken@2.0.0", "description": "Retrieve a gift card using a secure token.\n\nCall this tool to obtain gift card details using a secure payment token.", "toolkit": { "name": "ArcadeSquareupApi", "description": null, "version": "2.0.0" }, "input": { "parameters": [ { "name": "secure_payment_token", "required": true, "description": "The secure payment token used to retrieve the gift card. Generated by the Web Payments SDK or In-App Payments SDK.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The payment token of the gift card to retrieve. Payment tokens are generated by the \nWeb Payments SDK or In-App Payments SDK." }, "inferrable": true, "http_endpoint_parameter_name": "nonce" } ] }, "output": { "description": "Response from the API endpoint 'RetrieveGiftCardFromNonce'.", "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": { "provider_id": "arcade-squareup", "provider_type": "oauth2", "id": null, "oauth2": { "scopes": [ "GIFTCARDS_READ" ] } }, "secrets": null, "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the squareup API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "https://connect.squareup.com/v2/gift-cards/from-nonce", "http_method": "POST", "headers": {}, "parameters": [ { "name": "nonce", "tool_parameter_name": "secure_payment_token", "description": "The payment token of the gift card to retrieve. Payment tokens are generated by the \nWeb Payments SDK or In-App Payments SDK.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The payment token of the gift card to retrieve. Payment tokens are generated by the \nWeb Payments SDK or In-App Payments SDK." }, "accepted_as": "body", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"A request to retrieve a gift card by using a payment token.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"nonce\"\n ],\n \"properties\": {\n \"nonce\": {\n \"type\": \"string\",\n \"description\": \"The payment token of the gift card to retrieve. Payment tokens are generated by the \\nWeb Payments SDK or In-App Payments SDK.\",\n \"minLength\": 1\n }\n },\n \"example\": {\n \"nonce\": \"cnon:7783322135245171\"\n }\n }\n }\n }\n}", "use_request_body_schema_mode": false, "validate_request_body_schema": false } }