{"id":31936459,"url":"https://github.com/stitchng/adonis-paystack","last_synced_at":"2026-04-17T08:31:24.248Z","repository":{"id":54280574,"uuid":"163864702","full_name":"stitchng/adonis-paystack","owner":"stitchng","description":"An addon/plugin package to provide PayStack payment services in AdonisJS 4.1+","archived":false,"fork":false,"pushed_at":"2021-03-23T22:21:43.000Z","size":62,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-23T04:57:16.146Z","etag":null,"topics":["adonis-framework","adonisjs","adonisjs-addon","api","payments","paystack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stitchng.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"coolcodes","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-01-02T16:31:18.000Z","updated_at":"2023-03-01T12:36:06.000Z","dependencies_parsed_at":"2022-08-13T10:50:39.979Z","dependency_job_id":null,"html_url":"https://github.com/stitchng/adonis-paystack","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/stitchng/adonis-paystack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchng%2Fadonis-paystack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchng%2Fadonis-paystack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchng%2Fadonis-paystack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchng%2Fadonis-paystack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stitchng","download_url":"https://codeload.github.com/stitchng/adonis-paystack/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchng%2Fadonis-paystack/sbom","scorecard":{"id":853481,"data":{"date":"2025-08-11","repo":{"name":"github.com/stitchng/adonis-paystack","commit":"cec460f16b38665cec7e4dd9538f1b0b8f8c8d4e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 1/20 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T23:10:39.935Z","repository_id":54280574,"created_at":"2025-08-23T23:10:39.935Z","updated_at":"2025-08-23T23:10:39.935Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31921773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonis-framework","adonisjs","adonisjs-addon","api","payments","paystack"],"created_at":"2025-10-14T07:42:49.904Z","updated_at":"2026-04-17T08:31:24.213Z","avatar_url":"https://github.com/stitchng.png","language":"JavaScript","funding_links":["https://patreon.com/coolcodes","https://www.patreon.com/coolcodes/"],"categories":[],"sub_categories":[],"readme":"# adonis-paystack\nAn addon/plugin package to provide PayStack payment services in AdonisJS 4.1+\n\n[![NPM Version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Coveralls][coveralls-image]][coveralls-url]\n\n\u003cimg src=\"http://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg\" width=\"200px\" align=\"right\" hspace=\"30px\" vspace=\"140px\"\u003e\n\n## Getting Started\n\n\u003eInstall from the NPM Registry\n\n```bash\n\n    $ adonis install adonisjs-paystack\n\n```\n\n\u003eMake use of it inside a HTTP/Web Socket Controller(s)\n\n```js\n\nconst Paystack = use('PayStack')\n\n/**\n * This class handles all requests for \n * the checkout flow of the app\n *\n * @class CheckOutController\n */\nclass CheckOutController {\n\t/**\n\t * Begin Transaction Process\n\t *\n\t * @method initTransaction\n\t *\n\t * @param  {Object} context.request\n\t * @param  {Object} context.response\n\t *\n\t * @return {Promise}\n\t */\n\tasync initTransaction({ request, response }) {\n\n\t\t    //.....\n\t\t\ttry {\n\t\t\t\tlet paystackResponse = await Paystack.initializeTransaction({\n\t\t\t\tcallback_url:\"https://locahost:3333/trans/hooks/paystack\", \n\t\t\t\tamount: 3000, \n\t\t\t\temail: \"xyz@abc.com\"\n\t\t\t\t})\n\t\t\t}catch(ex){\n\n\t\t\t\tconsole.error(ex.message);\n\n\t\t\t\treturn response.status(400).json({\n\t\t\t\t\tdata: null,\n\t\t\t\t\terror: true,\n\t\t\t\t\tmessage: ex.message\n\t\t\t\t}); \n\t\t\t}\n\n\t\t    return await response.status(200).json({\n\t\t      data: response.body.data\n\t\t\t});\n\t}\n\n\tasync fetchCustomer({ request, response }){\n\n\t\t\t//.....\n\t\t\ttry {\n\n\t\t\t\tlet paystackResponse = await Paystack.getCustomer({\n\t\t\t\t\tcustomer_id:'CUS_reu3738we993wsnqah'\n\t\t\t\t});\n\t\t\t}catch(ex){\n\n\t\t\t\tconsole.error(ex.message);\n\n\t\t\t\treturn response.status(400).json({\n\t\t\t\t\tdata: null,\n\t\t\t\t\terror: true,\n\t\t\t\t\tmessage: ex.message\n\t\t\t\t}); \n\t\t\t}finally{\n\n\t\t\t\treturn response.status(200).json({\n\t\t\t\t\tdata: response.body.data\n\t\t\t\t})\n\t\t\t}\n\t}\n\n}\n\nmodule.exports = CheckOutController\n\n```\n\n## Creating fakes (for Unit/Integration Testing in AdonisJS)\n\n\u003eIt's possible to fake the `PayStack` instance like so:\n\n```js\nconst PayStack = use('PayStack')\n\n//start faking the provider instance\nPayStack.fake()\n\n//stop faking the provider instance\nPayStack.restore()\n```\n\n## License\n\nMIT\n\n## Running Tests\n\n```bash\n\n    npm i\n\n```\n\n```bash\n\n\tnpm run lint\n\n    npm run test\n\n```\n\n## Credits\n\n- [Ifeora Okechukwu](https://twitter.com/isocroft)\n- [Ahmad Abdul-Aziz](https://twitter.com/dev_amaz)\n    \n## Contributing\n\nSee the [CONTRIBUTING.md](https://github.com/stitchng/adonis-paystack/blob/master/CONTRIBUTING.md) file for info\n\n## Support \n\n**Coolcodes** is a non-profit software foundation (collective) created by **Oparand** - parent company of StitchNG, Synergixe based in Abuja, Nigeria. You'll find an overview of all our work and supported open source projects on our [Facebook Page](https://www.facebook.com/coolcodes/).\n\n\u003eFollow us on facebook if you can to get the latest open source software/freeware news and infomation.\n\nDoes your business depend on our open projects? Reach out and support us on [Patreon](https://www.patreon.com/coolcodes/). All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.\n\n[npm-image]: https://img.shields.io/npm/v/adonisjs-paystack.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/adonisjs-paystack\n\n[travis-image]: https://img.shields.io/travis/stitchng/adonis-paystack/master.svg?style=flat-square\n[travis-url]: https://travis-ci.org/stitchng/adonis-paystack\n\n[coveralls-image]: https://img.shields.io/coveralls/stitchng/adonis-paystack/develop.svg?style=flat-square\n\n[coveralls-url]: https://coveralls.io/github/stitchng/adonis-paystack\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstitchng%2Fadonis-paystack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstitchng%2Fadonis-paystack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstitchng%2Fadonis-paystack/lists"}