{"id":37996608,"url":"https://github.com/pariola/paystack","last_synced_at":"2026-01-16T18:55:56.102Z","repository":{"id":32441633,"uuid":"126475283","full_name":"pariola/paystack","owner":"pariola","description":"Paystack API wrapper","archived":false,"fork":false,"pushed_at":"2022-11-02T07:11:51.000Z","size":43,"stargazers_count":110,"open_issues_count":9,"forks_count":45,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-29T17:14:59.619Z","etag":null,"topics":["api-wrapper","nigeria","paystack","promise"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pariola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-23T11:19:49.000Z","updated_at":"2025-05-11T10:11:56.000Z","dependencies_parsed_at":"2022-09-01T10:20:45.598Z","dependency_job_id":null,"html_url":"https://github.com/pariola/paystack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pariola/paystack","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pariola%2Fpaystack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pariola%2Fpaystack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pariola%2Fpaystack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pariola%2Fpaystack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pariola","download_url":"https://codeload.github.com/pariola/paystack/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pariola%2Fpaystack/sbom","scorecard":{"id":720408,"data":{"date":"2025-08-11","repo":{"name":"github.com/pariola/paystack","commit":"4ecdbcec6ebb851394c322f16c8c426a8b0453a1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"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":"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":"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":"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":"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":"Code-Review","score":2,"reason":"Found 8/29 approved changesets -- score normalized to 2","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":"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":"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":"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":"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":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"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 9 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-22T11:08:28.330Z","repository_id":32441633,"created_at":"2025-08-22T11:08:28.330Z","updated_at":"2025-08-22T11:08:28.330Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28481302,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-wrapper","nigeria","paystack","promise"],"created_at":"2026-01-16T18:55:55.446Z","updated_at":"2026-01-16T18:55:56.092Z","avatar_url":"https://github.com/pariola.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# paystack\n\nYet a new [Paystack](https://paystack.co/) API wrapper 😉\n\n### Installation\n\nFor Yarn\n```\nyarn add paystack-api\n```\nFor NPM\n```\nnpm install paystack-api --save\n```\n\n### Usage\n\n```js\n// Require the library\nvar paystack = require(\"paystack-api\")(\"secret_key\");\n```\n\n#### Making calls\n\nThe resource methods promisified\n\nFormat → `paystack.{resource}.{method}`\n\n```js\n// paystack.{resource}.{method}\npaystack.customer\n  .list()\n  .then(function(body) {\n    console.log(body);\n  })\n  .catch(function(error) {\n    console.log(error);\n  });\n```\n\nAll Resource methods parameters are provided as the only argument\n\n```js\npaystack.plan\n  .create({\n    name: \"API demo\",\n    amount: 10000,\n    interval: \"monthly\"\n  })\n  .then(function(error, body) {\n    console.log(error);\n    console.log(body);\n  });\n```\n\n```js\npaystack.transactions.list({ perPage: 20 }).then(function(error, body) {\n  console.log(error);\n  console.log(body);\n});\n```\n\n### Extras\n\n#### I\n\nA function to add Paystack's fee to your charging fee\n\n```js\nconst helper = new paystack.FeeHelper();\nconsole.log(helper.addFeesTo(5000));\n```\n\nOutputs → `5077` which includes Paystack's fee upfront\n\nOR set your desired parameters\n\n```js\nconst helper = new paystack.FeeHelper({\npercentage: ...,\n  cap: ...,\n  threshold: ...,\n  additionalCharge: ....\n});\nconsole.log(helper.addFeesTo(5000));\n```\n\n#### II\n\nA Paystack Events helper (Express Middleware)\n```js\nconst paystack = require(\"paystack-api\")(\"secret_key\");\nconst events = paystack.Events;\n\nevents.on(\"event_name\", data =\u003e {\n    // Act\n  console.log(\"hola!\");\n});\n\n// Hooks with Express\napp.post(\"/my/webhook/url\", events.middleware);\n```\n\n### Extend resources/methods\n\n```js\nconst PaystackAPI = require(\"paystack-api\")\n\nclass Paystack extends PaystackApi {\n  constructor(key) {\n    super(key);\n    // Update BVN match method with the new route\n    this.verification.matchBVN = this.extend({\n      method: 'post',\n      route: `/bvn/match`,\n      args: ['account_number*', 'bank_code*', 'bvn*'],\n    });\n  }\n}\n\nconst paystack = new Paystack(\"secret_key\");\n```\n\n### Resources\n\n* customer\n  * create\n  * get\n  * list\n  * update\n  * validate\n  * setRiskAction\n  * deactivateAuth\n* transaction\n  * initialize\n  * verify\n  * list\n  * get\n  * chargeAuth\n  * viewTimeline\n  * viewTimelineRef\n  * totals\n  * export\n  * reAuthorize\n  * checkAuth\n* plan\n  * create\n  * get\n  * list\n  * update\n* page\n  * create\n  * get\n  * list\n  * update\n  * slugAvailable\n* charge\n  * tokenize\n  * charge\n  * submitPIN\n  * submitOTP\n  * submitPhone\n  * submitBirthday\n  * checkCharge\n* bulk_charge\n  * create\n  * list\n  * get\n  * getCharges\n  * pause\n  * resume\n* invoice\n  * create\n  * list\n  * get\n  * verify\n  * notify\n  * invoiceMetrics\n  * draftInvoice\n  * updateInvoice\n  * archiveInvoice\n* control_panel\n  * getSessionTimeout\n  * updateSessionTimeout\n* refund\n  * create\n  * list\n  * get\n* settlement\n  * list\n* subaccount\n  * create\n  * list\n  * get\n  * update\n* subscription\n  * create\n  * disable\n  * enable\n  * get\n  * list\n* transfer_control\n  * balance\n  * resendOTP\n  * enableOTP\n  * disableOTP\n  * finalizeDisableOTP\n* transfer_recipient\n  * create\n  * list\n  * update\n  * remove\n* transfer\n  * create\n  * list\n  * get\n  * finalize\n  * bulkTransfer\n  * verify\n* verification\n  * resolveBVN\n  * matchBVN\n  * resolveAccount\n  * resolveBIN\n  * resolvePhone\n* nuban\n  * create\n  * list\n  * get\n  * deactivate\n* misc\n  * list_banks\n* feeHelper\n\n### Contributing\n\n* Please do 🧡\n\n### TODO\n\n* [X] Create a Paystack Events `express` middleware\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpariola%2Fpaystack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpariola%2Fpaystack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpariola%2Fpaystack/lists"}