{"_id":"@cashfreepayments/agent-toolkit","_rev":"5-99277bc611d4787e36067f44b9753d26","name":"@cashfreepayments/agent-toolkit","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.4":{"name":"@cashfreepayments/agent-toolkit","version":"1.0.4","keywords":["cashfree","openai","agents","payments","ai-sdk","langchain"],"author":"","license":"ISC","_id":"@cashfreepayments/agent-toolkit@1.0.4","maintainers":[{"name":"cashfree-payments","email":"raj@cashfree.com"},{"name":"kishan.cashfree","email":"kishan.maurya@cashfree.com"},{"name":"nikhilkushwah18","email":"nikhil.kushwah@cashfree.com"}],"dist":{"shasum":"c0c149e3d2da99fd921686489a7ec664ca425a81","tarball":"https://registry.npmjs.org/@cashfreepayments/agent-toolkit/-/agent-toolkit-1.0.4.tgz","fileCount":20,"integrity":"sha512-AXptksRAO2fkEswks/FAmT3oW1axrrK0zEsg8ZYmp7rIEimjI1kTDWISqbAHFnIVa+fMxJEh2z7Z2l+e8onnrg==","signatures":[{"sig":"MEQCIHrX8b3p78mD8pyc2r6/7aDZCtozXSJY8ZWrXxjOMwivAiBk23Qiodd1b6ElaeDDuTcvd2FGyUlAYyg6EGjzcznmow==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":529918},"type":"module","engines":{"node":">=18"},"exports":{"./ai-sdk":{"types":"./ai-sdk/index.d.ts","import":"./ai-sdk/index.js","require":"./ai-sdk/index.cjs"},"./openai":{"types":"./openai/index.d.ts","import":"./openai/index.js","require":"./openai/index.cjs"},"./langchain":{"types":"./langchain/index.d.ts","import":"./langchain/index.js","require":"./langchain/index.cjs"}},"gitHead":"173a922bf7bc132904e8e9af8bccc840082e3e78","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup","clean":"rm -rf openai ai-sdk langchain","prettier":"prettier './**/*.{js,ts,md,html,css}' --write","prettier-check":"prettier './**/*.{js,ts,md,html,css}' --check"},"_npmUser":{"name":"cashfree-payments","email":"raj@cashfree.com"},"_npmVersion":"10.8.2","description":"Cashfree payments tools for AI agent frameworks","directories":{},"_nodeVersion":"18.20.8","dependencies":{"zod":"^3.25.76","cashfree-pg":"^5.1.0","zod-to-json-schema":"^3.24.6"},"_hasShrinkwrap":false,"devDependencies":{"ai":"^6.0.3","zod":"^3.25.76","tsup":"^8.3.5","openai":"^5.0.0","prettier":"^3.7.4","langchain":"^1.2.3","typescript":"^5.9.3","@types/node":"^22.10.5","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.7","@langchain/core":"^1.1.8","@langchain/openai":"^1.2.0"},"peerDependencies":{"ai":"^6.0.3","openai":"^4.86.1 || ^5.0.0","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.0","@langchain/core":"^1.0.0"},"peerDependenciesMeta":{"ai":{"optional":true},"openai":{"optional":true},"langchain":{"optional":true},"@ai-sdk/openai":{"optional":true},"@openai/agents":{"optional":true},"@langchain/core":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/agent-toolkit_1.0.4_1767012154889_0.7644133369895505","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@cashfreepayments/agent-toolkit","version":"1.0.5","keywords":["cashfree","openai","agents","payments","ai-sdk","langchain"],"author":"","license":"ISC","_id":"@cashfreepayments/agent-toolkit@1.0.5","maintainers":[{"name":"cashfree-payments","email":"raj@cashfree.com"},{"name":"kishan.cashfree","email":"kishan.maurya@cashfree.com"},{"name":"nikhilkushwah18","email":"nikhil.kushwah@cashfree.com"}],"dist":{"shasum":"150ce9a81db02c274ee6bce29d51fca9b292c94a","tarball":"https://registry.npmjs.org/@cashfreepayments/agent-toolkit/-/agent-toolkit-1.0.5.tgz","fileCount":20,"integrity":"sha512-k1L0xKV8CquqlqjYNrEp1LAZn95g3bu4N7j2EnZmmolD+M2jRC5kErUUplZr5qevok1Vb4PbGb5YTsSPW4R9yQ==","signatures":[{"sig":"MEYCIQC6+Avuj8xs9Zl9lrnXICvtCi/xepekj1TllkayIMt9DgIhAJfmq052qIU7bJhFISJFnX0mc3ygFHxrfOQVYVTQr4wb","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":530071},"type":"module","engines":{"node":">=18"},"exports":{"./ai-sdk":{"types":"./ai-sdk/index.d.ts","import":"./ai-sdk/index.js","require":"./ai-sdk/index.cjs"},"./openai":{"types":"./openai/index.d.ts","import":"./openai/index.js","require":"./openai/index.cjs"},"./langchain":{"types":"./langchain/index.d.ts","import":"./langchain/index.js","require":"./langchain/index.cjs"}},"gitHead":"8b8ce6764f6690695e08d8dee2dc38ac2a6bf303","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup","clean":"rm -rf openai ai-sdk langchain","prettier":"prettier './**/*.{js,ts,md,html,css}' --write","prettier-check":"prettier './**/*.{js,ts,md,html,css}' --check"},"_npmUser":{"name":"cashfree-payments","email":"raj@cashfree.com"},"_npmVersion":"10.8.2","description":"Cashfree payments tools for AI agent frameworks","directories":{},"_nodeVersion":"18.20.8","dependencies":{"zod":"^3.25.76","cashfree-pg":"^5.1.0","zod-to-json-schema":"^3.24.6"},"_hasShrinkwrap":false,"devDependencies":{"ai":"^6.0.3","zod":"^3.25.76","tsup":"^8.3.5","openai":"^5.0.0","prettier":"^3.7.4","langchain":"^1.2.3","typescript":"^5.9.3","@types/node":"^22.10.5","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.7","@langchain/core":"^1.1.8","@langchain/openai":"^1.2.0"},"peerDependencies":{"ai":"^6.0.3","openai":"^4.86.1 || ^5.0.0","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.0","@langchain/core":"^1.0.0"},"peerDependenciesMeta":{"ai":{"optional":true},"openai":{"optional":true},"langchain":{"optional":true},"@ai-sdk/openai":{"optional":true},"@openai/agents":{"optional":true},"@langchain/core":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/agent-toolkit_1.0.5_1767012648577_0.41908682280202925","host":"s3://npm-registry-packages-npm-production"}},"1.0.6":{"name":"@cashfreepayments/agent-toolkit","version":"1.0.6","keywords":["cashfree","openai","agents","payments","ai-sdk","langchain"],"author":"","license":"ISC","_id":"@cashfreepayments/agent-toolkit@1.0.6","maintainers":[{"name":"cashfree-payments","email":"raj@cashfree.com"},{"name":"kishan.cashfree","email":"kishan.maurya@cashfree.com"},{"name":"nikhilkushwah18","email":"nikhil.kushwah@cashfree.com"}],"dist":{"shasum":"f05b84845ac5722d540733e0caeed0f2edf5d337","tarball":"https://registry.npmjs.org/@cashfreepayments/agent-toolkit/-/agent-toolkit-1.0.6.tgz","fileCount":20,"integrity":"sha512-RYK3oWS2eKJ1G3b97m/9ZOo0LPQ+t1lffPpUfqcVbAeAOnNxdgDV57rhqqMw2rTyAYyGi5AlNKBhdalinUzvwA==","signatures":[{"sig":"MEUCIQC6th8ggP/AxwbGJyxxfTsjc/R83wysvPprpUXNDZHPFAIgSRUMKWcF+4lqF8AD8oGyIVcZsseDsw6uTtawcG3ccHs=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":530081},"type":"module","engines":{"node":">=18"},"exports":{"./ai-sdk":{"types":"./ai-sdk/index.d.ts","import":"./ai-sdk/index.js","require":"./ai-sdk/index.cjs"},"./openai":{"types":"./openai/index.d.ts","import":"./openai/index.js","require":"./openai/index.cjs"},"./langchain":{"types":"./langchain/index.d.ts","import":"./langchain/index.js","require":"./langchain/index.cjs"}},"gitHead":"c4262b52ef56cbe2af14fa6743d883cf91f57de2","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup","clean":"rm -rf openai ai-sdk langchain","prettier":"prettier './**/*.{js,ts,md,html,css}' --write","prettier-check":"prettier './**/*.{js,ts,md,html,css}' --check"},"_npmUser":{"name":"cashfree-payments","email":"raj@cashfree.com"},"_npmVersion":"10.8.2","description":"Cashfree payments tools for AI agent frameworks","directories":{},"_nodeVersion":"18.20.8","dependencies":{"zod":"^3.25.76","cashfree-pg":"^5.1.0","zod-to-json-schema":"^3.24.6"},"_hasShrinkwrap":false,"devDependencies":{"ai":"^6.0.3","zod":"^3.25.76","tsup":"^8.3.5","openai":"^6.0.0","prettier":"^3.7.4","langchain":"^1.2.3","typescript":"^5.9.3","@types/node":"^22.10.5","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.7","@langchain/core":"^1.1.8","@langchain/openai":"^1.2.0"},"peerDependencies":{"ai":"^6.0.3","openai":"^4.86.1 || ^5.0.0 || ^6.0.0","@ai-sdk/openai":"^3.0.1","@openai/agents":"^0.3.0","@langchain/core":"^1.0.0"},"peerDependenciesMeta":{"ai":{"optional":true},"openai":{"optional":true},"langchain":{"optional":true},"@ai-sdk/openai":{"optional":true},"@openai/agents":{"optional":true},"@langchain/core":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/agent-toolkit_1.0.6_1767075603677_0.4083150912599245","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@cashfreepayments/agent-toolkit","version":"1.1.0","description":"Cashfree payments tools for AI agent frameworks","repository":{"type":"git","url":"git+https://github.com/cashfree/agent-tools-js.git"},"scripts":{"build":"tsup","clean":"rm -rf openai ai-sdk langchain","test":"echo \"Error: no test specified\" && exit 1","prettier":"prettier './**/*.{js,ts,md,html,css}' --write","prettier-check":"prettier './**/*.{js,ts,md,html,css}' --check"},"exports":{"./openai":{"types":"./openai/index.d.ts","require":"./openai/index.cjs","import":"./openai/index.js"},"./ai-sdk":{"types":"./ai-sdk/index.d.ts","require":"./ai-sdk/index.cjs","import":"./ai-sdk/index.js"},"./langchain":{"types":"./langchain/index.d.ts","require":"./langchain/index.cjs","import":"./langchain/index.js"}},"keywords":["cashfree","openai","agents","payments","ai-sdk","langchain"],"author":"","license":"ISC","type":"module","engines":{"node":">=18"},"devDependencies":{"@ai-sdk/openai":"^3.0.1","@langchain/core":"^1.1.8","@langchain/openai":"^1.2.0","@openai/agents":"^0.3.7","@types/node":"^22.10.5","ai":"^6.0.3","langchain":"^1.2.3","openai":"^6.0.0","prettier":"^3.7.4","tsup":"^8.3.5","typescript":"^5.9.3","zod":"^3.25.76"},"dependencies":{"cashfree-pg":"^5.1.0","cashfree-verification":"^4.0.1","zod":"^3.25.76","zod-to-json-schema":"^3.24.6"},"peerDependencies":{"@ai-sdk/openai":"^3.0.1","@langchain/core":"^1.0.0","@openai/agents":"^0.3.0","ai":"^6.0.3","openai":"^4.86.1 || ^5.0.0 || ^6.0.0"},"peerDependenciesMeta":{"@ai-sdk/openai":{"optional":true},"@langchain/core":{"optional":true},"@openai/agents":{"optional":true},"ai":{"optional":true},"langchain":{"optional":true},"openai":{"optional":true}},"gitHead":"f618ee287d1c8415de97da06516b2a8af0c70156","_id":"@cashfreepayments/agent-toolkit@1.1.0","bugs":{"url":"https://github.com/cashfree/agent-tools-js/issues"},"homepage":"https://github.com/cashfree/agent-tools-js#readme","_nodeVersion":"22.23.1","_npmVersion":"11.18.0","dist":{"integrity":"sha512-gvgnO9agNfaGA5TWdTqKVz0QVG39gVskOCl6k/YH1XCJeYGKEbyi6tBpWviTqSlLzxWGRSEOw3grrC9W6hZ7pQ==","shasum":"11346d050c30effcafe26f945fb48487394a24cf","tarball":"https://registry.npmjs.org/@cashfreepayments/agent-toolkit/-/agent-toolkit-1.1.0.tgz","fileCount":20,"unpackedSize":1480192,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@cashfreepayments%2fagent-toolkit@1.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIH4zUT05kGxs2ZuVDZ5/pJMbIzmi/GqQ5pz2VZpa3ZyqAiEAvqtcnVIsOOijIJuYOq04hwMhAUiLlcg/xph/hjWAV8A="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:ec138e0f-c461-4333-9e4b-d83a24f643fa"}},"directories":{},"maintainers":[{"name":"cashfree-payments","email":"developers@cashfree.com"},{"name":"kishan.cashfree","email":"kishan.maurya@cashfree.com"},{"name":"vibhorohbiv","email":"vibhor.jain@cashfree.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/agent-toolkit_1.1.0_1783594346530_0.06128079885292004"},"_hasShrinkwrap":false}},"time":{"created":"2025-12-29T12:42:34.792Z","modified":"2026-07-09T10:52:26.993Z","1.0.4":"2025-12-29T12:42:35.041Z","1.0.5":"2025-12-29T12:50:48.767Z","1.0.6":"2025-12-30T06:20:03.858Z","1.1.0":"2026-07-09T10:52:26.679Z"},"license":"ISC","keywords":["cashfree","openai","agents","payments","ai-sdk","langchain"],"description":"Cashfree payments tools for AI agent frameworks","maintainers":[{"name":"cashfree-payments","email":"developers@cashfree.com"},{"name":"kishan.cashfree","email":"kishan.maurya@cashfree.com"},{"name":"vibhorohbiv","email":"vibhor.jain@cashfree.com"}],"readme":"# Cashfree Payments Agent Toolkit\n\nThe Cashfree Payments Agent Toolkit enables popular agent frameworks including LangChain, Vercel's AI SDK, and OpenAI's Agents SDK to integrate with Cashfree APIs through function calling.\n\n## Installation\n\n```bash\nnpm install @cashfreepayments/agent-toolkit\n```\n\n## Requirements\n\n- Node 18+\n- Cashfree Merchant Account (Sandbox or Production)\n\n## Framework Support\n\nThe toolkit supports multiple frameworks, exposed through sub-paths:\n\n- **AI SDK**: `@cashfreepayments/agent-toolkit/ai-sdk` - [Documentation](https://github.com/cashfree/agent-tools-js/blob/main/src/ai-sdk/README.md)\n- **LangChain**: `@cashfreepayments/agent-toolkit/langchain` - [Documentation](https://github.com/cashfree/agent-tools-js/blob/main/src/langchain/README.md)\n- **OpenAI**: `@cashfreepayments/agent-toolkit/openai` - [Documentation](https://github.com/cashfree/agent-tools-js/blob/main/src/openai/README.md)\n\n## Usage\n\nEach toolkit is initialized with your Cashfree credentials and environment configuration.\n\n```typescript\nimport {\n  CashfreeAgentToolkit,\n  CFEnvironment,\n} from '@cashfreepayments/agent-toolkit/openai'; // or langchain, ai-sdk\n\n// Configuration\nconst environment = CFEnvironment.SANDBOX; // or PRODUCTION\nconst clientId = process.env.CASHFREE_CLIENT_ID;\nconst clientSecret = process.env.CASHFREE_CLIENT_SECRET;\n\n// Initialize the toolkit\nconst cashfree = new CashfreeAgentToolkit(environment, clientId, clientSecret);\n```\n\nCashfree issues **separate API keys** for Payment Gateway and for the Verification Suite (SecureID). The PG keys go in the second and third arguments and are used by the order/refund/payment tools. If you plan to use the verification tools, explicitly pass your SecureID keys as the fourth argument:\n\n```typescript\nconst cashfree = new CashfreeAgentToolkit(environment, clientId, clientSecret, {\n  verification: {\n    clientId: process.env.CASHFREE_VERIFICATION_CLIENT_ID, // SecureID keys — used by verification tools\n    clientSecret: process.env.CASHFREE_VERIFICATION_CLIENT_SECRET,\n  },\n});\n```\n\nIf the `verification` option is omitted, the PG keys are reused for verification tools — those calls will fail with authentication errors unless your account uses the same keys for both products.\n\n## Tools\n\nThe toolkit works with OpenAI Agents SDK, LangChain and Vercel's AI SDK and can be passed as a list of tools. For example:\n\n- Using all tools:\n\n```typescript\nimport {Agent, run} from '@openai/agents';\n\nconst allTools = cashfree.getAgentTools(); // Get all tools\n\nconst agent = new Agent({\n  name: 'Payment Agent',\n  instructions: 'You are a helpful payment assistant.',\n  model: 'gpt-4o',\n  tools: allTools,\n});\n\nconst result = await run(\n  agent,\n  'Look up customer cust_123 and create an order for Rs. 500'\n);\n```\n\n- Using selective tools:\n\n```typescript\nimport {Agent, run} from '@openai/agents';\n\nconst getOrderTool = cashfree.tools.getOrder;\n\nconst agent = new Agent({\n  name: 'Order Details Fetching Agent',\n  instructions:\n    'You are a helpful assistant that fetches and returns order details',\n  model: 'gpt-4o',\n  tools: getOrderTool,\n});\n\nconst result = await run(agent, 'Get details of order: order_12345678');\n```\n\n## Available Tools\n\n### Payment Gateway (PG)\n\n- createOrder: Create a new order\n- getOrder: Retrieve details of an existing order\n- terminateOrder: Terminate/cancel an order\n- getOrderExtendedData: Retrieve extended order data (shipment/delivery details)\n- updateOrderExtendedData: Update order shipment/tracking and delivery status\n- authorizeOrder: Capture or void a pre-authorized payment\n- createRefund: Initiate a refund for an order\n- getAllRefunds: List all refunds for an order\n- getRefund: Retrieve details of a specific refund\n- orderPayUsingUpi: Pay for an order using UPI\n- orderPayUsingNetbanking: Pay for an order using Netbanking\n- orderPayUsingApp: Pay for an order using a payment app\n- orderPayUsingPlainCard: Pay for an order using a plain card\n- orderPayUsingSavedCard: Pay for an order using a saved card\n- getPaymentsForOrder: List all payment attempts for an order\n- getPaymentById: Retrieve a specific payment by cf_payment_id\n- getEligiblePaymentMethods: Get payment methods eligible for an order\n- getEligibleOffers: Get offers eligible for an order\n- createCustomer: Create a new customer in Cashfree\n- fetchCustomerInstruments: Fetch saved payment instruments for a customer\n- fetchCustomerInstrument: Fetch a specific saved instrument by instrument_id\n- deleteCustomerInstrument: Delete a saved instrument\n\n### Verification Suite (SecureID)\n\n- verifyPan360: Verify a PAN (PAN 360) and fetch the registered name plus enriched details (PAN type, masked Aadhaar, seeding status, DOB, contact/address)\n- verifyGstin: Verify a GSTIN and fetch business details\n- verifyNameMatch: Fuzzy-match two names (e.g., user-provided vs registered)\n- verifyBankAccount: Verify a bank account with penny drop (account number + IFSC)\n- verifyIfsc: Verify an IFSC code and fetch branch details\n- createReversePennyDrop: Create a reverse penny drop bank verification request (UPI link)\n- getReversePennyDropStatus: Fetch the result of a reverse penny drop request\n- mobile360SendOtp: Start the Mobile 360 one-click onboarding flow — send an OTP (SMS/WhatsApp) to a mobile number\n- mobile360VerifyOtp: Submit the OTP to complete Mobile 360 and fetch the enriched profile linked to the number\n- generateKycLink: Generate a per-user hosted KYC (form) link and optionally send it via SMS/email/WhatsApp\n- getKycLinkStatus: Fetch the status and verification results of a KYC link\n- generateStaticKycLink: Generate a reusable static KYC link (with QR code) for a template\n- deactivateStaticKycLink: Deactivate a static KYC link for a template\n- smartOcr: Extract structured data from a document image/PDF (PAN, Aadhaar, DL, Voter ID, Passport, RC, cheque, invoice) via file URL or local file\n- createVkycUser: Create a user for the Video KYC flow (step 1)\n- initiateVkyc: Start a Video KYC session and generate the VKYC link\n- generateVkycAuthToken: Generate an OAuth token to initialise the VKYC SDK (OTP-less flow)\n- getVkycStatus: Fetch the status and results of a Video KYC session\n\nSee specific framework documentation for detailed examples.\n","readmeFilename":"README.md","homepage":"https://github.com/cashfree/agent-tools-js#readme","repository":{"type":"git","url":"git+https://github.com/cashfree/agent-tools-js.git"},"bugs":{"url":"https://github.com/cashfree/agent-tools-js/issues"}}