{"id":22533494,"url":"https://github.com/vectormike/cyberpay","last_synced_at":"2025-03-28T05:43:08.488Z","repository":{"id":37881571,"uuid":"261327876","full_name":"Vectormike/cyberpay","owner":"Vectormike","description":"Nodejs API wrapper for CyberPay","archived":false,"fork":false,"pushed_at":"2023-03-04T16:14:19.000Z","size":567,"stargazers_count":1,"open_issues_count":17,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-02T12:16:52.703Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/Vectormike.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-05T00:40:00.000Z","updated_at":"2023-03-17T12:24:51.000Z","dependencies_parsed_at":"2025-02-02T06:40:46.084Z","dependency_job_id":"1d85a315-3c66-4213-9082-940917e5c749","html_url":"https://github.com/Vectormike/cyberpay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vectormike%2Fcyberpay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vectormike%2Fcyberpay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vectormike%2Fcyberpay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vectormike%2Fcyberpay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vectormike","download_url":"https://codeload.github.com/Vectormike/cyberpay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245978230,"owners_count":20703677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-12-07T09:08:30.063Z","updated_at":"2025-03-28T05:43:08.466Z","avatar_url":"https://github.com/Vectormike.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CyberPay Node.js Library\n\n[![CircleCI](https://circleci.com/gh/circleci/circleci-docs.svg?style=shield)](https://circleci.com/gh/circleci/circleci-docs)\n![GitHub repo size](https://img.shields.io/github/repo-size/Vectormike/cyberpay)\n![GitHub contributors](https://img.shields.io/github/contributors/Vectormike/cyberpay)\n![Twitter Follow](https://img.shields.io/twitter/follow/Vectormike_?style=social)\n\n\u003ca href=\"https://www.npmjs.com/package/cyberpay\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/cyberpay.svg\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/cyberpay\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/cyberpay.svg\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e\n\nNodejs API wrapper for [CyberPay](https://cyberpay.net.ng/).\n\nThis library provides access to the CyberPay API from applications written in server-side JavaScript.\n\n## CyberPay Endpoints/Services exposed by the library\n\n- Bank\n- BankUSSD\n- BillByWallet\n- Biller\n- BillPayment\n- Business\n- Channels\n- Dashboard\n- DirectDebit\n- FundTransfer\n- Integration\n- MandateProduct\n- NibssPaPlus\n- Nip\n- Partner\n- Payment\n- Payout\n- Provider\n- Transaction\n- TSA\n- WalletTopUp\n\n## Installation\n\n```sh\nnpm install cyberpay --save\n#or \nyarn add cyberpay\n```\n\n## Usage\n\nThis package requires configuration with your account's secret key in the [CyberPay Dahboard](https://cyberpay.net.ng/)\n\nUsing ES modules and `async`/`await`:\n\n```js\nimport CyberPay from 'cyberpay';\n\nconst cyberpay = new CyberPay({\n    integrationKey: process.env.INTEGRATION_KEY,\n});\n\ntry {\n    const res = await cyberpay.payment.verify(transactionReference);\n    // Verify payment\n    if (res.status === 200) {\n        // Successful\n    }\n} catch (err) {\n    if (!err.response) {\n        // No response from the server\n        // Bad network\n    } else {\n        //  Response was returned from the server\n        // ...\n    }\n}\n```\n\n### Payment\n\nOperations relating to payment\n\n#### Payment with token\n\n`const response = await cyberpay.payment.paywithtoken(options);`\n\n#### Payment with card\n\n`const response = await cyberpay.payment.paywithtoken(options);`\n\n### Bank\n\nActivities has to do with basic information about banks integrated\n\n#### Get all integrated banks\n\n`const response = await cyberpay.bank();`\n\n### Channels\n\nChannels associated\n\n#### Retrieves active channels\n\n`const response = await cyberpay.fetchActiveChannels();`\n\n### Dashboard\n\nDisplay transactions on dashboard\n\n#### Display transactions by date\n\n`const response = await cyberpay.fetchTransactionsToDashboard(options);`\n\n\n## Contributing\n\n- You can contribute by extending the README file to contain more examples and explanations of how to use the package.\n\n## Authors\n\n- [Victor Jonah](https://www.linkedin.com/in/victor-jonah/) \n\n## License\n\nThe code is available as open source under the terms of the\n[MIT License](https://opensource.org/licenses/MIT)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvectormike%2Fcyberpay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvectormike%2Fcyberpay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvectormike%2Fcyberpay/lists"}