{"_id":"banksy-sdk","_rev":"66-0b233b44b52141e751374d2c51dfc395","name":"banksy-sdk","dist-tags":{"1.0.53-0":"1.0.53-0","1.0.54-0":"1.0.54-0","1.0.53-1":"1.0.53-1","1.0.54-1":"1.0.54-1","latest":"1.0.56","1.0.56-0":"1.0.56-0"},"versions":{"1.0.52":{"name":"banksy-sdk","version":"1.0.52","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.52","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"ef0e3fabdb693392e970097cf9dfc36d11c8cb02","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.52.tgz","fileCount":38,"integrity":"sha512-zbMCPS0a2xnihymBKqElUGOVsxXzj9N6ZsEduILdWm3vK+vh1c36g3saXhlQoGqqsErtBE4zxYQl6APUWLpJnA==","signatures":[{"sig":"MEYCIQCPzzIFnpzCFaQd2yt0KHJM8+B833696Zpod9dN48k49wIhAMplgbf1rFo+BbfpvienzphhKRLhbFELVCBFzlSNQo5/","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553553},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy :: banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.52_1727926561427_0.45053909385672","host":"s3://npm-registry-packages"}},"1.0.53":{"name":"banksy-sdk","version":"1.0.53","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.53","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"520cd6eaac28132680a2278609a070255a75ba6d","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.53.tgz","fileCount":38,"integrity":"sha512-HLADt+jpKyCfeuIUBGR9B5fG7NdGCP1wfX4o4AEOqCsX0cZsUehBHW8GQ/F7VB/n/bGPsqc8j/GQH4+Yro1Jfg==","signatures":[{"sig":"MEQCIAasEX1IJhD4uoUGG75JzGAGFvB9KsWvdlXqKfXyn8QqAiBiByT1B/jsmkn4S0fjAKoJMID02xklOXQqQoc6/NPgLQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553553},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy :: banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.53_1727926698899_0.33287242697756025","host":"s3://npm-registry-packages"}},"1.0.53-0":{"name":"banksy-sdk","version":"1.0.53-0","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.53-0","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"5e7f5d876d762602c033fc49a0d26ce872e2e9ad","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.53-0.tgz","fileCount":38,"integrity":"sha512-lB1Es5qSGCb1QIp9qLccKVcKwhtjlg32lglG6Yh8fOYb7R5hX1DGk2ZJacN25wthbwyiaR0spkroWk8/LilLng==","signatures":[{"sig":"MEQCIAOEGIXn1qFW1EerD4PqJHh4wb3Nb6G2YTSExOsNe5STAiBsv+0drjufDHeb2uQj2pl9N/HlMi/yIumafInycAvlfA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553555},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy :: banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.53-0_1727926786096_0.09906285641189538","host":"s3://npm-registry-packages"}},"1.0.54-0":{"name":"banksy-sdk","version":"1.0.54-0","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.54-0","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"a9415d0a8907d259ee656e5497a9cf7e3e139bb0","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.54-0.tgz","fileCount":38,"integrity":"sha512-nb2wj6aFWwWGG7TSdTxMj2eutG0MzziZYqRaCb0Vzy3K3+tFfcXz2yaK3SHitF8/1rp4jNjgW/7sYvhqvHsNwA==","signatures":[{"sig":"MEQCIBv1KHJ5PFNaq79NzP7jaMDc8unx6BseYuw10XabZ8WwAiBhInmGzezvIcNXTgi4bhUD6+tRNtASr/I9TMl4aRc3uw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553555},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy :: banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.54-0_1727926993427_0.8645622019696058","host":"s3://npm-registry-packages"}},"1.0.53-1":{"name":"banksy-sdk","version":"1.0.53-1","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.53-1","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"8b004e49aae33502d6404072fc1faef325f16824","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.53-1.tgz","fileCount":38,"integrity":"sha512-kqQ+9I9eWOo8cLXM1Qh0ckuEgDVLw26xrSTeebAmRylw8EikDih9XXJI5/aFFN5qe5czzIgmdVWrA+DNGuksrQ==","signatures":[{"sig":"MEQCIBZO0TCQ2yRkUOShncPi0rqT4sYhmcicrmkKTYs9H+mJAiAe3o0XgTq+ez+u70HgzeBObCwhpUVkbO2vflpRwPMgoQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553555},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy :: banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.53-1_1727927047035_0.7068630226278545","host":"s3://npm-registry-packages"}},"1.0.54-1":{"name":"banksy-sdk","version":"1.0.54-1","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.54-1","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"d104d01ec1d000272eeaa39612f34a23364dba48","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.54-1.tgz","fileCount":38,"integrity":"sha512-R0J7N+0ogRzOwe6knppQbjiO4sv6vHQdM/gVw4c8MdAAxF9Wr//dmRdKSn+Z/IOESiX3ddsvQEHkCIcI7SO+Jw==","signatures":[{"sig":"MEQCIEjO4xK0TndV0ZETgnrJTlI3vNZh8X+EPRyUI73hZO7pAiACn88WvCZbT906iOXLFoUAoJU3lLquRBVZ/ujFdm+8SQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553554},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy : banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.54-1_1727927305737_0.493303855459736","host":"s3://npm-registry-packages"}},"1.0.54":{"name":"banksy-sdk","version":"1.0.54","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.54","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"9cca9587f751f405336ec1861297631681f2c2db","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.54.tgz","fileCount":38,"integrity":"sha512-qux38Lvpb0snHZyUb+nKfD+rAQG2mkWzL0SmoaE7AJGA9uGMZrRCq+vwsEy6Nbz8OiXFmkDD9ru7vhqEt7XB1A==","signatures":[{"sig":"MEQCIDYa+QcU+m+wtB4geP1Xo+3D43TfzZ6i6WDk4h+8bhLuAiAHRcwVQXx6BnL5HNLpQ7jI82+2KEsCqzh0IjMhnqe1+Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553552},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy : banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.54_1727927474014_0.5614441789237339","host":"s3://npm-registry-packages"}},"1.0.56-0":{"name":"banksy-sdk","version":"1.0.56-0","author":{"name":"Sourav jana"},"license":"ISC","_id":"banksy-sdk@1.0.56-0","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"dist":{"shasum":"64ec8fe5d7730be20d1d8691a780bc70c3952c86","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.56-0.tgz","fileCount":42,"integrity":"sha512-IVsZ1IG8vCRo+5q0WlLRewBcRAkrJxL9seVhb3WLhJAiDVVXrThh4yRtQQQKz2iPjAh6qiaVA9l9P2jiMhyJcQ==","signatures":[{"sig":"MEUCIQDw/P3yq+dxuCkQZg0vMK2TEc8qXEsyfC0fEsFrKvm/KAIgO36/qKlUA4cuUdPDvVU3VxuZgHa+SLn8mYjuyWjMDWw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":11556322},"main":"dist/index.js","types":"dist/index.d.ts","unpkg":"dist/index.umd.js","module":"dist/index.m.js","scripts":{"dev":"npx nodemon","test":"echo \"Error: no test specified\" && exit 1","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap"},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"description":"Banksy : banksy-sdk","directories":{},"dependencies":{"axios":"^1.6.8"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nodemon":"^3.1.0","microbundle":"^0.15.1"},"_npmOperationalInternal":{"tmp":"tmp/banksy-sdk_1.0.56-0_1742974307879_0.04593890002104151","host":"s3://npm-registry-packages-npm-production"}},"1.0.56":{"name":"banksy-sdk","version":"1.0.56","description":"Banksy : banksy-sdk","main":"dist/index.js","module":"dist/index.m.js","unpkg":"dist/index.umd.js","types":"dist/index.d.ts","scripts":{"dev":"npx nodemon","build":"rm -rf dist && microbundle --tsconfig tsconfig.json --no-sourcemap","test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Sourav jana"},"license":"ISC","devDependencies":{"microbundle":"^0.15.1","nodemon":"^3.1.0"},"dependencies":{"axios":"^1.6.8"},"_id":"banksy-sdk@1.0.56","dist":{"shasum":"86b04335b20dd02e01a725a026ee6b6ab72aa9ad","integrity":"sha512-uIZldzD6yhopjecTxK1Qx4GBGfdaMMmK8aDveKKsBKLiZ04xsC7Dqu3Pz40JIUo0P/kt/366TKvSF3pwgyaywA==","tarball":"https://registry.npmjs.org/banksy-sdk/-/banksy-sdk-1.0.56.tgz","fileCount":42,"unpackedSize":11556320,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHod3zgcTLf6SuFq4HwEo+J/JaqiYAmvNt973nQ1tGWwAiEAvk3mNyHWlt2akuvOCviRDBqfj3AhQEwJqUSRVcKuDOM="}]},"_npmUser":{"name":"banksy_id","email":"dev@banksy.id"},"directories":{},"maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/banksy-sdk_1.0.56_1742974715287_0.6877771944529998"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-03T03:36:01.325Z","modified":"2025-03-26T07:38:35.838Z","1.0.3":"2024-04-23T07:22:47.820Z","1.0.48":"2024-08-19T12:58:09.293Z","1.0.70":"2024-08-20T14:55:08.186Z","1.0.81-0":"2024-08-20T15:02:29.859Z","1.0.81":"2024-08-20T15:03:42.620Z","1.0.81-1":"2024-10-01T06:34:14.521Z","1.0.81-2":"2024-10-01T06:51:11.095Z","1.0.81-3":"2024-10-01T07:05:27.026Z","1.0.81-4":"2024-10-01T08:10:28.445Z","1.0.81-5":"2024-10-01T08:19:25.217Z","1.0.81-6":"2024-10-01T08:24:02.644Z","1.0.81-7":"2024-10-01T09:08:07.737Z","1.0.81-8":"2024-10-01T09:08:55.757Z","1.0.81-9":"2024-10-01T09:09:40.183Z","1.0.81-10":"2024-10-01T09:10:18.610Z","1.0.81-11":"2024-10-01T09:11:01.114Z","1.0.81-12":"2024-10-01T09:11:48.463Z","1.0.81-13":"2024-10-01T09:12:30.533Z","1.0.81-14":"2024-10-01T09:13:11.799Z","1.0.81-15":"2024-10-01T09:14:06.358Z","1.0.81-16":"2024-10-01T09:14:56.129Z","1.0.81-17":"2024-10-01T09:15:39.809Z","1.0.81-18":"2024-10-01T09:16:23.315Z","1.0.81-19":"2024-10-01T09:17:05.725Z","1.0.81-20":"2024-10-01T09:17:50.748Z","1.0.81-21":"2024-10-01T09:18:38.360Z","1.0.82":"2024-10-01T09:19:17.765Z","1.0.81-22":"2024-10-01T09:19:35.511Z","1.0.81-23":"2024-10-01T09:20:17.452Z","1.0.81-24":"2024-10-01T09:21:01.672Z","1.0.81-25":"2024-10-01T09:21:45.110Z","1.0.81-26":"2024-10-01T09:22:28.342Z","1.0.81-27":"2024-10-01T09:23:09.220Z","1.0.81-28":"2024-10-01T09:23:51.520Z","1.0.81-29":"2024-10-01T09:24:34.324Z","1.0.81-30":"2024-10-01T09:25:18.694Z","1.0.81-31":"2024-10-01T09:25:59.638Z","1.0.81-32":"2024-10-01T10:59:36.083Z","1.0.81-33":"2024-10-01T11:00:25.195Z","1.0.83":"2024-10-01T11:00:50.962Z","1.0.81-34":"2024-10-01T11:01:11.268Z","1.0.81-35":"2024-10-01T11:01:57.154Z","1.0.81-36":"2024-10-01T11:02:41.258Z","1.0.81-37":"2024-10-01T11:26:22.169Z","1.0.84":"2024-10-01T11:27:49.955Z","1.0.81-38":"2024-10-01T11:37:54.146Z","1.0.85":"2024-10-01T11:39:14.567Z","1.0.81-39":"2024-10-01T11:54:03.052Z","1.0.86":"2024-10-01T11:57:31.976Z","1.0.81-40":"2024-10-01T12:05:13.319Z","1.0.81-41":"2024-10-01T12:12:55.796Z","1.0.87":"2024-10-01T12:14:21.551Z","1.0.52":"2024-10-03T03:36:01.873Z","1.0.53":"2024-10-03T03:38:19.209Z","1.0.53-0":"2024-10-03T03:39:46.378Z","1.0.54-0":"2024-10-03T03:43:13.843Z","1.0.53-1":"2024-10-03T03:44:07.332Z","1.0.54-1":"2024-10-03T03:48:26.165Z","1.0.54":"2024-10-03T03:51:14.450Z","1.0.56-0":"2025-03-26T07:31:48.534Z","1.0.56":"2025-03-26T07:38:35.638Z"},"author":{"name":"Sourav jana"},"license":"ISC","description":"Banksy : banksy-sdk","maintainers":[{"name":"banksy_id","email":"dev@banksy.id"}],"readme":"# BANKSY PAYMENT SDK\n\nThe Banksy Payment SDK is a unified payment gateway solution designed to simplify the integration of multiple payment methods into applications. It offers developers a comprehensive set of tools and APIs for seamless payment processing while ensuring security, compliance, and scalability.\n\n[[_TOC_]]\n\n\n## FEATURES\n\n1. **Unified Integration:** Easily incorporate multiple payment methods into applications using a single set of APIs and tools.\n2. **Multi-Payment Method Support:** Accept payments through various methods including credit/debit cards, PayPal, cryptocurrencies, digital wallets, and bank transfers.\n3. **Country-Specific Configuration:** Dynamically enable/disable payment methods based on the user's country to comply with regional regulations and optimize the payment experience.\n4. **Security and Compliance:** Adheres to industry-standard encryption protocols and compliance requirements (such as PCI-DSS) to ensure secure transactions and safeguard sensitive payment data.\n5. **Developer-Friendly:** Clear documentation, code samples, and resources to streamline the integration process for developers of all skill levels.\n6. **Customization Options:** Customize the payment flow, user interface, and error handling mechanisms to meet specific application requirements.\n\n## CONFIGURATION\n\nTo use the SDK, you need:\n1. **CLIENT_KEY**\n2. **CLIENT_SECRET**\n\nFollow these steps:\n\ni. Go to the [BANKSY-DASHBOARD ](https://dashboard.banksy.id/) portal to generate an API Key.\n\nii. Install the SDK in your frontend application:\n   ```javascript\n   npm install banksy-sdk --save\n   ```\n\niii. Initialize the SDK with your CLIENT_KEY:\n   ```javascript\n   import { Banksy } from \"banksy-sdk\";\n\n   const banksy = new Banksy(\"YOUR_CLIENT_KEY\");\n   export default banksy;\n   ```\n   (Note: To prevent multiple initializations, create a separate helper file.)\n\n## DATA FLOW\n\nThe SDK provides useful methods for processing payments across multiple providers.\n\n#### Create Payment with KYC\n\n* The diagram below illustrates the payment flow with KYC:\n\n5\n![Alt Text](https://gitlab.com/banksy/sdk/banksy-sdk/-/raw/main/Payment-kyc.gif?ref_type=heads)\n\n* The code below demonstrate the payment flow with KYC\n\n1. Select the product/service user want to purchase with proper ```amount: number``` and ```currency: string```\n2. Create a payment\n   ```javascript\n   const paymentPayload = {\n         amount: 100,\n         currency: 'USD',\n         successCallback: 'https://your-success-url.com',\n         failureCallback: 'https://your-failure-url.com',\n         isKycOptional: false,\n         externalClientId: 'client123',\n         currencyType: \"fiat\" // or \"crypto\",\n         crypto: { tokenName: \"MATIC\", blockchainSymbol: \"MATIC\" }\n      };\n\n   const paymentData = await banksy.createPayment(payload: JsonObject<PAYLOAD>);\n    ```\n3. Will return a payment link, open it to perform the payment.\n4. After successful payment the **successCallback** will be redirected automatically with ```paymentId: string``` on query parameter\n5. Same thing will happen on failure.\n6. After receiving the ```paymentId``` validate the status\n   ```javascript\n   const paymentData = await banksy.getPayment(paymentId);\n   ``` \n\n## PAYLOAD\n1. ```amount: number``` **required** | Amount to be charged\n2. ```currency: string``` **required** | Currency in which the amount to be charged\n3. ```successCallback: string``` **required** | On payment success portal will be redirected to this url\n4. ```failureCallback: string``` **required** | On payment failure portal will be redirected to this url\n5. ```externalClientId: string``` **optional** | External client id, you will receive this on webhook\n2. ```customerName: string``` **required** | Customer name\n6. ```context: any``` **optional** | Any extra context JSON data, you will receive this on webhook\n7. ```address: string``` **optional** | Crypto wallet address\n8. ```currencyType: \"crypto\" | \"fiat\"``` **either** | Currency type. valid **fiat** or **crypto** \n9. ```provider: string\"``` **or** | Specify payment provider\n10. ```isKycOptional: boolean``` **required** | Indicates if KYC is optional. Must be **false**\n11. ```crypto: { tokenName: string, blockchainSymbol: string } ``` **optional**\n\n\n#### Create Payment without KYC\n\n* The diagram below illustrates the payment flow without KYC:\n\n![Alt Text](https://gitlab.com/banksy/sdk/banksy-sdk/-/raw/main/Payment-without-kyc.gif)\n\n* The code below demonstrate the payment flow without KYC\n\n1. Select the product/service user want to purchase with proper ```amount: number``` and ```currency: string```\n2. Create a payment\n   ```javascript\n\n   const paymentPayload = {\n      amount: 100,\n      currency: 'USD',\n      successCallback: 'https://your-success-url.com',\n      failureCallback: 'https://your-failure-url.com',\n      isKycOptional: true,\n      customerEmail: 'fogeri6652@givehit.com', // At least one of customerEmail or customerPhone must be provided\n      // customerPhone: '1234567890', // Optional if customerEmail is provided\n      externalClientId: 'client123',\n      currencyType: \"fiat\" // or \"crypto\",\n      crypto: { tokenName: \"MATIC\", blockchainSymbol: \"MATIC\" }\n   };\n   \n\n   const paymentData = await banksy.createPayment(payload: JsonObject<PAYLOAD>);\n    ```\n3. Will return a payment link, open it to perform the payment.\n4. After successful payment the **successCallback** will be redirected automatically with ```paymentId: string``` on query parameter\n5. Same thing will happen on failure.\n6. After receiving the ```paymentId``` validate the status\n   ```javascript\n   const paymentData = await banksy.getPayment(paymentId);\n   ``` \n\n## PAYLOAD\n1. ```amount: number``` **required** | Amount to be charged\n2. ```currency: string``` **required** | Currency in which the amount to be charged\n3. ```successCallback: string``` **required** | On payment success portal will be redirected to this url\n4. ```failureCallback: string``` **required** | On payment failure portal will be redirected to this url\n5. ```externalClientId: string``` **optional** | External client id, you will receive this on webhook\n2. ```customerName: string``` **required** | Customer name\n6. ```context: any``` **optional** | Any extra context JSON data, you will receive this on webhook\n7. ```address: string``` **optional** | Crypto wallet address\n8. ```currencyType: \"crypto\" | \"fiat\"``` **either** | Currency type. valid **fiat** or **crypto**\n9. ```provider: string\"``` **or** | Specify payment provider\n10. ```isKycOptional: boolean``` **required** | Indicates if KYC is optional. Must be **true**\n11. ```customerEmail: string``` **optional** | Customer's email (required if isKycOptional is **true**).\n12. ```customerPhone: string``` **optional** | Customer's phone number (required if isKycOptional is **true**).\n13. ```crypto: { tokenName: string, blockchainSymbol: string } ``` **optional**\n\n\n## WEBHOOK\nConfigure your webhook urls on the [Dashboard/API keys](https://dashboard.banksy.id/)\nWebhooks will be triggered automatically once any transaction happens using the API key.\n\nWebhooks will accepts only ```POST``` methods\nAnd body will be\n```javascript\n{\n   \"paymentId\": string,\n   \"paymentRaw\": JSON Object // payment object\n}\n```\n","readmeFilename":"README.md"}