{"_id":"@adsesugh/flutterwave-v3-ts","_rev":"4-d25156be28cab8bdd73d914a28fa02e6","name":"@adsesugh/flutterwave-v3-ts","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@adsesugh/flutterwave-v3-ts","version":"1.0.0","keywords":["flutterwave","payments","typescript","nodejs","api","sdk"],"author":{"name":"Sesugh Agbadu","email":"sesughagbadu@yahoo.com"},"license":"MIT","_id":"@adsesugh/flutterwave-v3-ts@1.0.0","maintainers":[{"name":"adsesugh","email":"sesughagbadu@yahoo.com"}],"homepage":"https://github.com/adsesugh/flutterwave-v3-ts#readme","bugs":{"url":"https://github.com/adsesugh/flutterwave-v3-ts/issues"},"dist":{"shasum":"45868b91adda5ee29b5a5cececfb447864aab581","tarball":"https://registry.npmjs.org/@adsesugh/flutterwave-v3-ts/-/flutterwave-v3-ts-1.0.0.tgz","fileCount":61,"integrity":"sha512-9RYeJMz23RtXT92fcodH5D2e+DDF7YxWNAfJ/TP0thN8y/jsZWa5bs2d5qrna0gHtNxjYCUsigZik8euTwm2pQ==","signatures":[{"sig":"MEUCIQD1BpeGSKA0Rr5vLj4fFLxoZGnV23r2T87+i5dJwskm2wIgQDgVS3hZePgeJUIzt5HhBsegV9oP6QHs4SYGHIzrzqw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":36234},"main":"dist/index.js","_from":"file:adsesugh-flutterwave-v3-ts-1.0.0.tgz","types":"dist/index.d.ts","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"tsc","release":"changeset publish","version-packages":"changeset version"},"_npmUser":{"name":"adsesugh","email":"sesughagbadu@yahoo.com"},"_resolved":"/private/var/folders/53/nmhr7t3s21n5rg7j05j7x7n00000gn/T/4b0fa97313edbd15424dd8c4294dc0e3/adsesugh-flutterwave-v3-ts-1.0.0.tgz","_integrity":"sha512-9RYeJMz23RtXT92fcodH5D2e+DDF7YxWNAfJ/TP0thN8y/jsZWa5bs2d5qrna0gHtNxjYCUsigZik8euTwm2pQ==","repository":{"url":"git+https://github.com/adsesugh/flutterwave-v3-ts.git","type":"git"},"_npmVersion":"10.9.3","description":"Flutterwave v3 Node SDK rewritten in TypeScript","directories":{},"_nodeVersion":"22.19.0","dependencies":{"axios":"^1.12.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.2.0","ts-jest":"^29.4.4","typescript":"^5.9.3","@types/jest":"^30.0.0","@types/node":"^24.6.2","@changesets/cli":"^2.29.7"},"_npmOperationalInternal":{"tmp":"tmp/flutterwave-v3-ts_1.0.0_1759496270682_0.014417683007688087","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@adsesugh/flutterwave-v3-ts","version":"1.0.1","keywords":["flutterwave","payments","typescript","nodejs","api","sdk"],"author":{"name":"Sesugh Agbadu","email":"sesughagbadu@yahoo.com"},"license":"MIT","_id":"@adsesugh/flutterwave-v3-ts@1.0.1","maintainers":[{"name":"adsesugh","email":"sesughagbadu@yahoo.com"}],"homepage":"https://github.com/adsesugh/flutterwave-v3-ts#readme","bugs":{"url":"https://github.com/adsesugh/flutterwave-v3-ts/issues"},"dist":{"shasum":"40fcc4e33cb9b98266c4721066087091d498451c","tarball":"https://registry.npmjs.org/@adsesugh/flutterwave-v3-ts/-/flutterwave-v3-ts-1.0.1.tgz","fileCount":36,"integrity":"sha512-wzAdf1vux49sq/klV5aiJ1XiHoJOkLGqxsBlkFDNcrgeRPIiay7YF+gZBjHiAqUS9wwGKckpt+krsAllTMUSwQ==","signatures":[{"sig":"MEUCIGBIEnYFNYOtbU+Tpx1RQuwoE6SFmDZSQRKq51ktisS1AiEAlqVOpwNmtVF0yaaQd5Y4fzFXmo/VZ1coy6xJzONFI6E=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":57793},"main":"dist/index.js","_from":"file:adsesugh-flutterwave-v3-ts-1.0.1.tgz","types":"dist/index.d.ts","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"tsc","release":"changeset publish","version-packages":"changeset version"},"_npmUser":{"name":"adsesugh","email":"sesughagbadu@yahoo.com"},"_resolved":"/private/var/folders/53/nmhr7t3s21n5rg7j05j7x7n00000gn/T/68e8fdd403762221397730c9160498e7/adsesugh-flutterwave-v3-ts-1.0.1.tgz","_integrity":"sha512-wzAdf1vux49sq/klV5aiJ1XiHoJOkLGqxsBlkFDNcrgeRPIiay7YF+gZBjHiAqUS9wwGKckpt+krsAllTMUSwQ==","repository":{"url":"git+https://github.com/adsesugh/flutterwave-v3-ts.git","type":"git"},"_npmVersion":"10.9.3","description":"Flutterwave v3 Node SDK rewritten in TypeScript","directories":{},"_nodeVersion":"22.19.0","dependencies":{"axios":"^1.12.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.2.0","ts-jest":"^29.4.4","typescript":"^5.9.3","@types/jest":"^30.0.0","@types/node":"^24.6.2","@changesets/cli":"^2.29.7"},"_npmOperationalInternal":{"tmp":"tmp/flutterwave-v3-ts_1.0.1_1759496726117_0.09535493414118146","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@adsesugh/flutterwave-v3-ts","version":"1.0.2","keywords":["flutterwave","payments","typescript","nodejs","api","sdk"],"author":{"name":"Sesugh Agbadu","email":"sesughagbadu@yahoo.com"},"license":"MIT","_id":"@adsesugh/flutterwave-v3-ts@1.0.2","maintainers":[{"name":"adsesugh","email":"sesughagbadu@yahoo.com"}],"homepage":"https://github.com/adsesugh/flutterwave-v3-ts#readme","bugs":{"url":"https://github.com/adsesugh/flutterwave-v3-ts/issues"},"dist":{"shasum":"bb8915295471b4c77a390b7768a39731e47369b2","tarball":"https://registry.npmjs.org/@adsesugh/flutterwave-v3-ts/-/flutterwave-v3-ts-1.0.2.tgz","fileCount":35,"integrity":"sha512-L1eDn0/t7Vrdz+a9TMXh7chBT38uSSaTKIhYLMNC3UiYenN16SGQCfRc4BbDan8e0CRh48ONid2fkkpp0VCpiw==","signatures":[{"sig":"MEUCIDBOJEcCqWcgZfrnxTvTm0Mudu9QhmU0+cHJeqRIy63sAiEAxdXTPnHvftc3ITJamddC0lgfzxXJNlzoESaKEfhSXWo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":57097},"main":"dist/index.js","_from":"file:adsesugh-flutterwave-v3-ts-1.0.2.tgz","types":"dist/index.d.ts","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"tsc","release":"changeset publish","version-packages":"changeset version"},"_npmUser":{"name":"adsesugh","email":"sesughagbadu@yahoo.com"},"_resolved":"/private/var/folders/53/nmhr7t3s21n5rg7j05j7x7n00000gn/T/e61590fcdedd396e6878c8e97a433ae8/adsesugh-flutterwave-v3-ts-1.0.2.tgz","_integrity":"sha512-L1eDn0/t7Vrdz+a9TMXh7chBT38uSSaTKIhYLMNC3UiYenN16SGQCfRc4BbDan8e0CRh48ONid2fkkpp0VCpiw==","repository":{"url":"git+https://github.com/adsesugh/flutterwave-v3-ts.git","type":"git"},"_npmVersion":"10.9.3","description":"Flutterwave v3 Node SDK rewritten in TypeScript","directories":{},"_nodeVersion":"22.19.0","dependencies":{"axios":"^1.12.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.2.0","ts-jest":"^29.4.4","typescript":"^5.9.3","@types/jest":"^30.0.0","@types/node":"^24.6.2","@changesets/cli":"^2.29.7"},"_npmOperationalInternal":{"tmp":"tmp/flutterwave-v3-ts_1.0.2_1759496878336_0.9273777567052801","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@adsesugh/flutterwave-v3-ts","version":"1.0.3","description":"Flutterwave v3 Node SDK rewritten in TypeScript","main":"dist/index.js","types":"dist/index.d.ts","keywords":["flutterwave","payments","typescript","nodejs","api","sdk"],"author":{"name":"Sesugh Agbadu","email":"sesughagbadu@yahoo.com"},"repository":{"type":"git","url":"git+https://github.com/adsesugh/flutterwave-v3-ts.git"},"license":"MIT","dependencies":{"axios":"^1.12.2"},"devDependencies":{"@changesets/cli":"^2.29.7","@types/jest":"^30.0.0","@types/node":"^24.6.2","jest":"^30.2.0","ts-jest":"^29.4.4","typescript":"^5.9.3"},"scripts":{"build":"tsc","test":"echo \"No tests yet\" && exit 0","release":"changeset publish","version-packages":"changeset version"},"_id":"@adsesugh/flutterwave-v3-ts@1.0.3","bugs":{"url":"https://github.com/adsesugh/flutterwave-v3-ts/issues"},"homepage":"https://github.com/adsesugh/flutterwave-v3-ts#readme","_integrity":"sha512-a5dkj0I6IwUqQ2ao0+YlZmPz17B3hG8YCkgKVU0BiFv7yxRVtxA7/97X43+2SYmMK+nvFQZNF0dnFwN9UApzeg==","_resolved":"/private/var/folders/53/nmhr7t3s21n5rg7j05j7x7n00000gn/T/a68c2ed9661eff4b40084fbe02664ed1/adsesugh-flutterwave-v3-ts-1.0.3.tgz","_from":"file:adsesugh-flutterwave-v3-ts-1.0.3.tgz","_nodeVersion":"22.19.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-a5dkj0I6IwUqQ2ao0+YlZmPz17B3hG8YCkgKVU0BiFv7yxRVtxA7/97X43+2SYmMK+nvFQZNF0dnFwN9UApzeg==","shasum":"7ca8545cc06c8feb6f2209c075287f03e2739d8a","tarball":"https://registry.npmjs.org/@adsesugh/flutterwave-v3-ts/-/flutterwave-v3-ts-1.0.3.tgz","fileCount":35,"unpackedSize":57484,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCzDQX4D8ozqDxOZ1IUQWyLm40KJjsYQFKrx9nFN7wMYAIgQNh3tXtBMeCvQQ48NeyaVs08HmIZ24HOpIwEUAoxgJU="}]},"_npmUser":{"name":"adsesugh","email":"sesughagbadu@yahoo.com"},"directories":{},"maintainers":[{"name":"adsesugh","email":"sesughagbadu@yahoo.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/flutterwave-v3-ts_1.0.3_1759588104429_0.7575663904401442"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-03T12:57:50.579Z","modified":"2025-10-04T14:28:24.859Z","1.0.0":"2025-10-03T12:57:50.861Z","1.0.1":"2025-10-03T13:05:26.309Z","1.0.2":"2025-10-03T13:07:58.513Z","1.0.3":"2025-10-04T14:28:24.635Z"},"bugs":{"url":"https://github.com/adsesugh/flutterwave-v3-ts/issues"},"author":{"name":"Sesugh Agbadu","email":"sesughagbadu@yahoo.com"},"license":"MIT","homepage":"https://github.com/adsesugh/flutterwave-v3-ts#readme","keywords":["flutterwave","payments","typescript","nodejs","api","sdk"],"repository":{"type":"git","url":"git+https://github.com/adsesugh/flutterwave-v3-ts.git"},"description":"Flutterwave v3 Node SDK rewritten in TypeScript","maintainers":[{"name":"adsesugh","email":"sesughagbadu@yahoo.com"}],"readme":"# Flutterwave Node v3 (TypeScript SDK)\n\n[![npm version](https://img.shields.io/npm/v/flutterwave-v3-ts.svg)](https://www.npmjs.com/package/@adsesugh/flutterwave-v3-ts)\n[![npm downloads](https://img.shields.io/npm/dm/flutterwave-v3-ts.svg)](https://www.npmjs.com/package/@adsesugh/flutterwave-v3-ts)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/adsesugh/flutterwave-v3-ts/ci.yml?branch=main)](https://github.com/adsesugh/flutterwave-v3-ts/actions)\n\nA fully typed **TypeScript SDK** for the [Flutterwave v3 API](https://developer.flutterwave.com/).  \nThis library simplifies integrating payments, transfers, card issuing, and more with Flutterwave in your Node.js/TypeScript applications.\n\n---\n\n## 📦 Installation\n\n```bash\nnpm install flutterwave-v3-ts\n```\nor \n```bash\nyarn add flutterwave-v3-ts\n```\n\n## 🚀 Usage\n\n```typescript\nimport { Flutterwave } from \"flutterwave-v3-ts\";\n\nconst flw = new Flutterwave({\n  publicKey: process.env.FLW_PUBLIC_KEY!,\n  secretKey: process.env.FLW_SECRET_KEY!\n});\n\n// Example: Verify a transaction\n(async () => {\n  const response = await flw.transactions.verify({ id: \"1234567890\" });\n  console.log(response);\n})();\n```\n\n## 🔑 Configuration\nSet your Flutterwave API keys in environment variables:\n\n```env \nFLW_PUBLIC_KEY=your_public_key\nFLW_SECRET_KEY=your_secret_key\nBASE_URL=api_base_url\nFLW_ENCRYPTION_KEY=your_encryption_key\n```\n\nPass your public and secret keys when initializing:\n```typescript\nconst flw = new Flutterwave({\n  publicKey: \"FLWPUBK_TEST-xxxxxxxxxxxxxxxxxxxxx\",\n  secretKey: \"FLWSECK_TEST-xxxxxxxxxxxxxxxxxxxxx\",\n  baseUrl: \"https://api.flutterwave.com/v3\", // Optional, defaults to Flutterwave's API URL\n  encryptionKey: \"your encryption_key\"\n});\n\n```\n\n## 📚 Features\n- Collections (Card, Bank, Mobile Money, USSD, etc.)\n- Tokenization\n- Split payments\n- Scheduled payments\n- Transfers\n- Card Issuing\n- Virtual Accounts\n- Bill Payments\n- Transactions & Reporting\n- Beneficiaries\n- Banks\n- Settlements\n- OTP\n- eBills\n- Miscellaneous Endpoints\n\n## 🔍 Usage Examples\nSee the [examples](./examples) directory for more usage examples.\n### Collections\n```typescript\nconst response = await flw.collections.cardCharge({\n  card_number: \"5531886652142950\",\n  cvv: \"564\",\n  expiry_month: \"09\",\n  expiry_year: \"32\",\n  currency: \"NGN\",\n  amount: \"100\",\n  fullname: \"Flutterwave Developer\",\n  email: \"developers@flutterwavego.com\",\n  tx_ref: \"MC-3243e\"\n});\nconsole.log(response);\n```\n\n### Tokenization\n```typescript\nconst response = await flw.tokenization.chargeToken({\n  token: \"CARD_TOKEN\",\n  currency: \"NGN\",\n  country: \"NG\",\n  amount: 5000,\n  email: \"user@example.com\",\n  tx_ref: \"ref-1234\"\n});\nconsole.log(response);\n```\n\n### Transfers\n```typescript\nconst response = await flw.transfers.initiate({\n  account_bank: \"044\",\n  account_number: \"0690000031\",\n  amount: 5500,\n  narration: \"Test transfer\",\n  currency: \"NGN\",\n  reference: \"transfer-12345\",\n  debit_currency: \"NGN\"\n});\nconsole.log(response);\n```\n\n### Card Issuing\n```typescript\nconst response = await flw.cardIssuing.createCard({\n  currency: \"NGN\",\n  amount: 1000,\n  billing_name: \"John Doe\",\n  billing_address: \"123, Test Street\",\n  billing_city: \"Lagos\",\n  billing_state: \"LA\",\n  billing_postal_code: \"100001\",\n  billing_country: \"NG\"\n});\nconsole.log(response);\n```\n\n### Virtual Accounts\n```typescript\nconst response = await flw.virtualAccounts.create({\n  email: \"newcustomer@example.com\",\n  is_permanent: true,\n  bvn: \"12345678901\",\n  tx_ref: \"VA-12345\"\n});\nconsole.log(response);\n``` \n\n### Bill Payments\n```typescript\nconst response = await flw.bills.pay({\n  country: \"NG\",\n  customer: \"08012345678\",\n  amount: 1000,\n  recurrence: \"ONCE\",\n  type: \"AIRTIME\",\n  reference: \"bill-1234\"\n});\nconsole.log(response);\n```\n\n### Transactions\n```typescript\nconst response = await flw.transactions.verify({ id: \"123456789\" });\n\nconsole.log(response);\n```\n\n### Banks\n```typescript\nconst response = await flw.banks.list({ country: \"NG\" });\nconsole.log(response);\n```\n\n### Settlements\n```typescript\nconst response = await flw.settlements.fetch({ from: \"2023-01-01\", to: \"2023-02-01\" });\nconsole.log(response);\n```\n\n### OTP\n```typescript\nconst response = await flw.otp.create({ length: 6, customer: \"user@example.com\", send: true });\nconsole.log(response);\n```\n\n### eBills\n```typescript\nconst response = await flw.ebills.create({\n  currency: \"NGN\",\n  amount: 5000,\n  email: \"customer@example.com\",\n  tx_ref: \"EBILL-12345\"\n});\nconsole.log(response);\n```\n\n### Miscellaneous\n```typescript\nconst response = await flw.misc.fetchBalance({ currency: \"NGN\" });\nconsole.log(response);\n```\n\n## 📜 License\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.","readmeFilename":"README.md"}