{"id":27415802,"url":"https://github.com/zealous-tech/easy-payment-base","last_synced_at":"2025-07-09T22:33:40.719Z","repository":{"id":78902666,"uuid":"440901791","full_name":"zealous-tech/easy-payment-base","owner":"zealous-tech","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-08T08:58:47.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-14T09:50:25.791Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/zealous-tech.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,"zenodo":null}},"created_at":"2021-12-22T15:26:06.000Z","updated_at":"2023-08-10T12:22:51.000Z","dependencies_parsed_at":"2025-04-14T09:40:21.102Z","dependency_job_id":"92726065-00c1-4edf-bd95-3e031bcaed05","html_url":"https://github.com/zealous-tech/easy-payment-base","commit_stats":null,"previous_names":["zealous-tech/easy-payment-base"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zealous-tech/easy-payment-base","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealous-tech%2Feasy-payment-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealous-tech%2Feasy-payment-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealous-tech%2Feasy-payment-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealous-tech%2Feasy-payment-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zealous-tech","download_url":"https://codeload.github.com/zealous-tech/easy-payment-base/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealous-tech%2Feasy-payment-base/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264504611,"owners_count":23618830,"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":"2025-04-14T09:39:33.491Z","updated_at":"2025-07-09T22:33:40.671Z","avatar_url":"https://github.com/zealous-tech.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# easy-payment-base\n\n\u003e Node.js API abstraction for payment gateways.\n\nUsed by supported gateways listed in [easy-payment](https://github.com/instigateMobile/easy-payment-main).\n\n## BaseGateway API\n\n* \u003ca href=\"#ctor\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_attachCard\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#attachCard()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_removeCard\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#removeCard()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_getBindings\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#getBindings()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_payOrder\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#payOrder()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_getOrderStatus\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#getOrderStatus()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_freezeOrder\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#freezeOrder()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_reverseOrder\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#reverseOrderProfile()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_depositOrder\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#depositOrder()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n* \u003ca href=\"#BaseGateway_refundOrder\"\u003e\u003ccode\u003e\u003cb\u003eBaseGateway#refundOrder()\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e\n\n--------------------------------------------------------\n\u003ca name=\"ctor\"\u003e\u003c/a\u003e\n#### BaseGateway(options)\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_attachCard\"\u003e\u003c/a\u003e\n#### BaseGateway#attachCard()\n\nAllow to add new card in payment gateway merchant account.\n\n#### `parameters`\n\n`order` *(object)*\n* `'amount'` *(string)*: The amount of the transaction.\n* `'orderNumber'` *(string)*: The orderNumber of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'pageView'` *(string)*: The pageView of the transaction.\n* `'returnUrl'` *(string)*: The returnUrl of the transaction.\n* `'description'` *(string)*: The description of the transaction.\n* `'clientId'` *(string)*: The clientId of the transaction.\n* `'currency'` *(string)*: The currency code of the transaction.\n\n`other` *(object)*\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_removeCard\"\u003e\u003c/a\u003e\n#### BaseGateway#removeCard()\n\nRemoving added card from payment getaway merchant.\n\n#### `parameters`\n\n`bindingId` *(string)*: The bindingId of the transaction.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_getBindings\"\u003e\u003c/a\u003e\n#### BaseGateway#getBindings()\n\nReturned existed payment getaway merchant account bindings.\n\n#### `parameters`\n\n`clientId` *(string)*: The clientId of the transaction.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_payOrder\"\u003e\u003c/a\u003e\n#### BaseGateway#payOrder()\n\nPaying order.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderNumber'` *(string)*: The orderNumber of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'pageView'` *(string)*: The pageView of the transaction.\n* `'amount'` *(number)*: The amount of the transaction.\n* `'returnUrl'` *(string)*: The returnUrl of the transaction.\n* `'description'` *(string)*: The description of the transaction.\n* `'clientId'` *(string)*: The clientId of the transaction.\n* `'currency'` *(string)*: The currency of the transaction.\n* `'bindingId'` *(string)*: The bindingId of the transaction.\n* `'useBinding'` *(boolean)*: If true, the pay will use the bindingId of the transaction.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'orderId'`*(string)*: The created orderId response from the gateway.\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_getOrderStatus\"\u003e\u003c/a\u003e\n### BaseGateway#getOrderStatus()\n\nGetting order status.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderId'` *(string)*: The orderId of the transaction.\n* `'extended'` *(boolean)*: If true, get extended order status.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_freezeOrder\"\u003e\u003c/a\u003e\n#### BaseGateway#freezeOrder()\n\nFreezing order.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderNumber'` *(string)*: The orderNumber of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'pageView'` *(string)*: The pageView of the transaction.\n* `'amount'` *(number)*: The amount of the transaction.\n* `'returnUrl'` *(string)*: The returnUrl of the transaction.\n* `'description'` *(string)*: The description of the transaction.\n* `'clientId'` *(string)*: The clientId of the transaction.\n* `'currency'` *(string)*: The currency of the transaction.\n* `'bindingId'` *(string)*: The bindingId of the transaction.\n* `'useBinding'` *(boolean)*: If true, the freeze will use the bindingId of the transaction.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'orderId'`*(string)*: The frozen orderId response from the gateway.\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_reverseOrderProfile\"\u003e\u003c/a\u003e\n#### BaseGateway#reverseOrderProfile()\n\nCancellation order.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderId'` *(string)*: The orderId of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'currency'` *(string)*: The currency of the transaction.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_depositOrder\"\u003e\u003c/a\u003e\n#### BaseGateway#depositOrder()\n\nCompletion of order payment.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderId'` *(string)*: The orderId of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'currency'` *(string)*: The currency of the transaction.\n* `'pageView'` *(string)*: The pageView of the transaction.\n* `'amount'` *(number)*: The amount of the transaction.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.\n\n--------------------------------------------------------\n\u003ca name=\"BaseGateway_refundOrder\"\u003e\u003c/a\u003e\n#### BaseGateway#refundOrder()\n\nRefund of order payment.\n\n#### `parameters`\n\n`order` *(object)*\n* `'orderId'` *(string)*: The orderId of the transaction.\n* `'language'` *(string)*: The language of the transaction.\n* `'currency'` *(string)*: The currency of the transaction.\n* `'amount'` *(number)*: The amount of the transaction.\n\nOther fields specific to a gateway SDK implementation.\nRefer to specific SDK for more details.\n\n#### `return value`\n\nReturns a `Promise` with the following object as a result:\n\n* `'hasError'` *(boolean)*: Identifier of the transaction status.\n* `'errorStep'` *(string)*: Exist when error is happens for methods with many API/SDK requests\n* `'err'`: The original error response from the gateway.\n* `'data'`: The original response from the gateway.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzealous-tech%2Feasy-payment-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzealous-tech%2Feasy-payment-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzealous-tech%2Feasy-payment-base/lists"}