{"_id":"@deposits/payouts-sdk","name":"@deposits/payouts-sdk","dist-tags":{"latest":"0.0.0"},"versions":{"0.0.0":{"name":"@deposits/payouts-sdk","version":"0.0.0","description":"Deposits Payouts SDKs provides and embeddable payouts experience for your applications","main":"package/index.js","scripts":{"test":"npm run test"},"repository":{"type":"git","url":"git+https://github.com/DepositsTeam/payouts-sdk.git"},"keywords":["Deposits","payouts","fintecth","sdk"],"author":{"name":"Deposits"},"license":"BSL-1.0","bugs":{"url":"https://github.com/DepositsTeam/payouts-sdk/issues"},"homepage":"https://github.com/DepositsTeam/payouts-sdk#readme","devDependencies":{"prettier":"^2.8.4"},"gitHead":"3f3b819951c425b8bc29d0905219b082038eed3f","_id":"@deposits/payouts-sdk@0.0.0","_nodeVersion":"19.7.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-lsX//M+b4twfHouUNTTvLzsL/gCVJJWQAuEig2LzIOglzkVYO/vYRH4IjnHdUWArUJIDUM0uEIAhQzhhrFeGVg==","shasum":"ec909a53df77346b8baf6fca91769df7deba2fc0","tarball":"https://registry.npmjs.org/@deposits/payouts-sdk/-/payouts-sdk-0.0.0.tgz","fileCount":5,"unpackedSize":17405,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDneemR4php4N3c+c0I0bzT55bTVUdjy+D2vAgmyanEvwIgYTW/qpuEX+r9nXzNsl7nG9/ETMRKT0zm1iUcz+vXyvM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkBmAuACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrexg//TyFcZT/ztCuzsj5x3U4Ltyhx5irv/edjk3vH9ykkKdvMFRp9\r\ns+ADH25IEUb5f5WXnLCHduqLDrPHm45j0am738XirWozWn9YhGUmaZcTb6Z7\r\nCObME2ix37xA2OWAanGk1LrYcuMhzHoZrRF3Cx25w+lr1meNLfm+0DzIf74/\r\n3MdafO/W8DjjDkXvatMn8R3ZUqe1Zcx2+1loW8hlUc4WfhyUlo8nX5UE1D8N\r\nzzZcUwiZuJASaDe9oztldnWxNAguXbVKPVIltbJSzV0m4dbLDXyu3mTTncKa\r\n12PM1D4XsHT+u2mcJc6cHNkKELgvTUvNL/oww7DbUN0UPr9CNN6atcqrX+3X\r\nde482RHxobSqd7P5M9pIO25bImiLxLn0O/lSsDOCl0LI44geKCVHt8ZIE6vb\r\nWHYIb3p218CAlQPT/uXhs94GRYSG4E7bW9mip0OAkM+RwMnfShi1G3Z+6rAO\r\nYdNz+UvQ4iKU8MZzidSd77uh8vO7gzf5CuIntDP8+CtaMKFlTvTX5FCVJGd/\r\nd1L8yD5USxOtulyZMiAZtCCBiQfOJL1+CP2hmyRjtWyQV638ZR9iLjkihjL6\r\ntALYDz+3iajDDIyLbKtQ7gqgcKkbmE6UIh2NoUj+OsXleFWv5s0LxRd3z/d0\r\nzaI5QDCvblt7IwGr/FQVXp/mY9gEKeebQRs=\r\n=KG31\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ericmcwinner","email":"mcwinnerwebdeveloper@gmail.com"},"directories":{},"maintainers":[{"name":"ericmcwinner","email":"mcwinnerwebdeveloper@gmail.com"},{"name":"deposits_dev","email":"developers@deposits.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/payouts-sdk_0.0.0_1678139438031_0.7833718467021007"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-06T21:50:37.953Z","0.0.0":"2023-03-06T21:50:38.209Z","modified":"2023-03-06T21:50:38.448Z"},"maintainers":[{"name":"ericmcwinner","email":"mcwinnerwebdeveloper@gmail.com"},{"name":"deposits_dev","email":"developers@deposits.com"}],"description":"Deposits Payouts SDKs provides and embeddable payouts experience for your applications","homepage":"https://github.com/DepositsTeam/payouts-sdk#readme","keywords":["Deposits","payouts","fintecth","sdk"],"repository":{"type":"git","url":"git+https://github.com/DepositsTeam/payouts-sdk.git"},"author":{"name":"Deposits"},"bugs":{"url":"https://github.com/DepositsTeam/payouts-sdk/issues"},"license":"BSL-1.0","readme":"# Deposits Payouts Web SDK\nThe payouts SDK is Deposits' all-in-one, plug and play, mass payment management system.\n\n\n### Getting Started\nYou have to install the SDK via npm.\n```shell\n$ npm install @deposits/payouts-sdk\n```\n\n### Examples\nWe have created examples to guide you in sandbox and in production.\n\n##### Example in sandbox\n```sh\nhttps://api.deposits.dev/example/payouts\n```\n##### Example in production\n```sh\nhttps://api.ondeposits.com/example/payouts\n```\n\n### How to use\nThe SDK exports a function `DepositsPayouts` that can be used to initiate the Deposits balance experience.\n\n```js\nimport DepositsPayouts from \"@deposits/payouts-sdk\"\n\nDepositsPayouts({\n   public_key,\n   redirect_url: \"https://ondeposits.com\",\n   callback: (data) => {\n        console.log(\"callback\", data);\n    },\n})\n```\n\nAfter importing the `DepositsPayouts` function, we can trigger it as show in the example above. When the function is called, it triggers the Deposits Payouts experience and initiates it on your application.\n\n#### The `DepositsPayouts` Object Argument\nThe `DepositsPayouts` function accepts an argument, which is an object containing information needed to run the Payouts experience.\n\n| Property         | Description                                                                                                                      |\n|------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| `public_key`     | The public key of your teanant that can be found on the [console](https://dev.launch.new).                                       |\n| `callback`       | A function that gets called when various events happen. The function would accept an object containing the event type and action |\n| `production_env` | A boolean flag that determines whether the SDK would run in our production or sandbox environment.                               |\n\n\n## Contributing\n\nOnly members of the deposits team can contribute to this. You can create an issue if you find a bug or have any challenge using this SDK.\n","readmeFilename":"README.md"}