{"id":51135288,"url":"https://github.com/whalestackhq/nodejs-sdk","last_synced_at":"2026-06-25T17:03:57.645Z","repository":{"id":38081573,"uuid":"253282330","full_name":"whalestackhq/nodejs-sdk","owner":"whalestackhq","description":"NodeJS SDK for Whalestack. Programmatically accept and settle payments in digital currencies.","archived":false,"fork":false,"pushed_at":"2023-11-07T22:01:30.000Z","size":42,"stargazers_count":11,"open_issues_count":0,"forks_count":12,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-12T17:25:55.549Z","etag":null,"topics":["cryptocurrencies","cryptocurrency","digital-currencies","payment-gateway","payment-integration","payment-processing","payment-processor"],"latest_commit_sha":null,"homepage":"https://www.whalestack.com/en/api-docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whalestackhq.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}},"created_at":"2020-04-05T16:40:07.000Z","updated_at":"2025-08-20T16:03:45.000Z","dependencies_parsed_at":"2023-11-08T05:01:55.951Z","dependency_job_id":null,"html_url":"https://github.com/whalestackhq/nodejs-sdk","commit_stats":{"total_commits":19,"total_committers":1,"mean_commits":19.0,"dds":0.0,"last_synced_commit":"afeb005aa18b41c1aeba375a590093459de44ab6"},"previous_names":["coinqvest/nodejs-merchant-sdk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/whalestackhq/nodejs-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whalestackhq%2Fnodejs-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whalestackhq%2Fnodejs-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whalestackhq%2Fnodejs-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whalestackhq%2Fnodejs-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whalestackhq","download_url":"https://codeload.github.com/whalestackhq/nodejs-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whalestackhq%2Fnodejs-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34784188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-25T02:00:05.521Z","response_time":101,"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":["cryptocurrencies","cryptocurrency","digital-currencies","payment-gateway","payment-integration","payment-processing","payment-processor"],"created_at":"2026-06-25T17:03:56.774Z","updated_at":"2026-06-25T17:03:57.640Z","avatar_url":"https://github.com/whalestackhq.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Whalestack Payments API SDK (NodeJS)\n\nOfficial Whalestack Payments API SDK for NodeJS by www.whalestack.com\n\nAccepting cryptocurrency payments using the Whalestack API is fast, secure, and easy. After you've signed up and obtained your [API key](https://www.whalestack.com/en/api-settings), all you need to do is create a checkout or blockchain deposit address on Bitcoin, Lightning, Litecoin, Stellar, or other supported networks to get paid. You can also use the API for fiat on- and off-ramping via SWIFT or SEPA.\n\nThis SDK implements the REST API documented at https://www.whalestack.com/en/api-docs\n\nFor SDKs in different programming languages, see https://www.whalestack.com/en/api-docs#sdks\n\nRequirements\n------------\n* NodeJS \u003e= 10.14.0\n* axios \u003e= 0.21.1\n\nInstallation with npm\n---------------------\n`npm install whalestack-sdk`\n\n**Usage Client**\n```javascript\nconst WsClient = require('whalestack-sdk');\n\nconst client = new WsClient(\n    'YOUR-API-KEY',\n    'YOUR-API-SECRET'\n);\n```\nGet your API key and secret here: https://www.whalestack.com/en/api-settings\n\nGuides\n------\n\n* [Using the Whalestack API](https://www.whalestack.com/en/api-docs#getting-started)\n* [Building Checkouts](https://www.whalestack.com/en/api-docs#building-checkouts)\n* [Authentication](https://www.whalestack.com/en/api-docs#authentication) (handled by SDK)\n* [Brand Connect](https://www.whalestack.com/en/api-docs#brand-connect) (white label checkouts on your own domain)\n\n## Wallets and Deposits\n\nYour Whalestack account comes equipped with dedicated deposit addresses for Bitcoin, Lightning, Litecoin, Stellar, SWIFT, SEPA, and other supported networks. You can receive blockchain payments within seconds after registering. The [GET /wallets](https://www.whalestack.com/en/api-docs#get-wallets) and [GET /deposit-address](https://www.whalestack.com/en/api-docs#deposit-address) endpoints return your blockchain addresses to start receiving custom deposits.\n\n**List Wallets and Deposit Addresses** (https://www.whalestack.com/en/api-docs#get-wallets)\n```javascript\nlet response = await client.get('/wallets');\n```\n\n## Checkouts\n\nWhalestack checkouts provide fast and convenient ways for your customers to complete payment. We built a great user experience with hosted checkouts that can be fully branded. If you're not into payment pages, you can take full control over the entire checkout process using our backend checkout APIs. Click [here](https://www.whalestack.com/en/api-docs#building-checkouts) to learn more about building checkouts.\n\n**Create a Hosted Checkout (Payment Link)** (https://www.whalestack.com/en/api-docs#post-checkout-hosted)\n```javascript\nlet response = await client.post('/checkout/hosted', {\n    charge:{\n        billingCurrency: 'EUR', // specifies the billing currency\n        lineItems: [{ // a list of line items included in this charge\n            description: 'PCI Graphics Card',\n            netAmount: 169.99,\n            quantity: 1\n        }],\n        shippingCostItems: [], // an optional list of shipping and handling costs\n        taxItems: []\n    },\n    settlementAsset: 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN' // your settlement asset as given by GET /assets (or ORIGIN to omit conversion)\n});\n```\n\n## Swaps And Transfers\n\nOnce funds arrive in your account, either via completed checkouts or custom deposits, you have instant access to them and the ability to swap them into other assets or transfer them to your bank account or other blockchain accounts (we recommend to always forward funds into self-custody on cold storage). The [POST /swap](https://www.whalestack.com/en/api-docs#post-swap) and [POST /transfer](https://www.whalestack.com/en/api-docs#post-transfer) endpoints will get you started on swaps and transfers.\n\n**Swap Bitcoin to USDC** (https://www.whalestack.com/en/api-docs#post-swap)\n```javascript\nlet response = await client.post('/swap', {\n    sourceAsset: 'BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT',\n    targetAsset: 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN',\n    targetAmount: 100\n});\n```\n\n**Transfer USDC to your SEPA Bank** (https://www.whalestack.com/en/api-docs#post-transfer)\n```javascript\nlet response = await client.post('/transfer', {\n    network: 'SEPA',\n    asset: 'USDC:GA5ZSEJYB37JRC5AVCIA5MOP4RHTM335X2KGX3IHOJAPP5RE34K4KZVN',\n    amount: 100,\n    targetAccount: 'A unique SEPA account label as previously specified in POST /target-account'\n});\n```\n\n## Supported Assets, Currencies, and Networks\n\n**List all available Networks** (https://www.whalestack.com/en/api-docs#get-networks)\n```javascript\nlet response = await client.get('/networks');\n```\n\n**List all available Assets** (https://www.whalestack.com/en/api-docs#get-assets)\n```javascript\nlet response = await client.get('/assets');\n```\n\n**List all available Billing Currencies** (https://www.whalestack.com/en/api-docs#get-currencies)\n```javascript\nlet response = await client.get('/currencies');\n```\n\n## Financial Reports and Accounting\n\nWe don't leave you hanging with an obscure and complicated blockchain payment trail to figure out by yourself. All transactions on Whalestack are aggregated into the Financial Reports section of your account and can even be associated with counter-parties, such as customers and beneficiaries. We provide CSV reports, charts, and beautiful analytics for all your in-house accounting needs.\n\nPlease inspect https://www.whalestack.com/en/api-docs for detailed API documentation or email us at service [at] whalestack.com.\n\nSupport and Feedback\n--------------------\nYour feedback is appreciated! If you have specific problems or bugs with this SDK, please file an issue on Github. For general feedback and support requests, email service [at] whalestack.com.\n\nContributing\n------------\n\n1. Fork it ( https://github.com/whalestackhq/nodejs-sdk/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhalestackhq%2Fnodejs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhalestackhq%2Fnodejs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhalestackhq%2Fnodejs-sdk/lists"}