{"id":47809713,"url":"https://github.com/godaddy/poynt-node","last_synced_at":"2026-04-03T18:05:21.830Z","repository":{"id":341828005,"uuid":"1161226771","full_name":"godaddy/poynt-node","owner":"godaddy","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-03T13:18:20.000Z","size":60,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-03T17:38:09.892Z","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/godaddy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-18T21:50:51.000Z","updated_at":"2026-03-03T13:17:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/godaddy/poynt-node","commit_stats":null,"previous_names":["godaddy/poynt-node"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/godaddy/poynt-node","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpoynt-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpoynt-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpoynt-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpoynt-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godaddy","download_url":"https://codeload.github.com/godaddy/poynt-node/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpoynt-node/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31368157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T17:53:18.093Z","status":"ssl_error","status_checked_at":"2026-04-03T17:53:17.617Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2026-04-03T18:05:21.137Z","updated_at":"2026-04-03T18:05:21.825Z","avatar_url":"https://github.com/godaddy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Poynt Node.js SDK\n\nThis SDK helps you connect to the Poynt API from your Node.js apps. You can easily get/create business information, subscribe to webhooks, and send cloud messages to your terminal app.\n\n## Documentation\n\nAfter you've [signed up for a Poynt developer account](https://poynt.net/auth/signup/developer), check out our [API reference](https://poynt.com/docs/api/) or our [developer guides](https://poynt.com/tag/guides/)!\n\n## Installation\n\nInstall this package:\n\n```\nnpm install poynt --save\n```\n\n## Usage\n\nYou can connect to the Poynt API by passing either a filename or a string containing your PEM-encoded private key you downloaded from Poynt.net. If `region` param is not set, the SDK uses `services.poynt.net` endpoint. If you need to hit `services-eu.poynt.net`, you need to pass `region: 'eu'`.\n\n```javascript\nvar poynt = require(\"poynt\")({\n  // region: 'eu',\n  applicationId: \"urn:aid:your-application-id\",\n  filename: __dirname + \"/key.pem\",\n});\n```\n\nor\n\n```javascript\nvar poynt = require(\"poynt\")({\n  applicationId: \"urn:aid:your-application-id\",\n  key: \"-----BEGIN RSA PRIVATE KEY-----\\n.....\\n-----END RSA PRIVATE KEY-----\",\n});\n```\n\nThen, make a request signed with your app private key:\n\n```javascript\npoynt.getBusiness(\n  {\n    businessId: \"00000000-0000-0000-0000-000000000000\",\n  },\n  function (err, business) {\n    if (err) {\n      // deal with your error\n    } else {\n      // do something with business\n    }\n  }\n);\n```\n\nWe'll handle all the request signing, token refresh, etc. for you!\n\n## Namespaces and methods\n\n### [Poynt Collect](https://docs.poynt.com/app-integration/poynt-collect/)\n\n- `tokenizeCard`\n- `charge`\n\n### [CloudMessages](https://poynt.com/docs/api/#cloudmessages-index)\n\n- `sendCloudMessage`\n- `sendRawCloudMessage`\n- `sendPaymentBridgeMessage`\n\n### [Hooks](https://poynt.com/docs/api/#hooks-index)\n\n- `getHooks`\n- `createHook`\n- `getHook`\n- `deleteHook`\n\n### [Businesses](https://poynt.com/docs/api/#businesses-index)\n\n- `getBusiness`\n- `getBusinessByDeviceId`\n- `getMerchantPaymentAccount`\n\n### [Stores](https://poynt.com/docs/api/#stores-index)\n\n- `getStore`\n\n### [Orders](https://poynt.com/docs/api/#orders-index)\n\n- `getOrders`\n- `getOrder`\n- `createOrder`\n- `completeOrder`\n\n### [Transactions](https://poynt.com/docs/api/#transactions-index)\n\n- `getTransactions`\n- `getTransaction`\n- `voidTransaction`\n- `refundTransaction`\n- `createTransaction`\n\n### [Customers](https://poynt.com/docs/api/#customers-index)\n\n- `getCustomers`\n- `getCustomer`\n\n### [Catalogs](https://poynt.com/docs/api/#catalogs-index)\n\n- `getCatalogs`\n- `getCatalog`\n- `getFullCatalog`\n- `createCatalog`\n- `createFullCatalog`\n- `updateCatalog`\n- `deleteCatalog`\n- `getCategory`\n- `createCategory`\n- `lookupCategories`\n- `deleteCategory`\n- `updateCategory`\n\n### Invoices\n\n- `getInvoices`\n- `getInvoice`\n- `createInvoice`\n- `sendInvoiceReminder`\n- `cancelInvoice`\n\n### [Products](https://poynt.com/docs/api/#products-index)\n\n- `getProducts`\n- `getProductsSummary`\n- `lookupProducts`\n- `getProduct`\n- `createProduct`\n- `deleteProduct`\n- `updateProduct`\n\n### Reports\n\n- `getReports`\n- `createReport`\n\n### [Taxes](https://poynt.com/docs/api/#taxes-index)\n\n- `getTaxes`\n- `getTax`\n- `createTax`\n- `deleteTax`\n- `updateTax`\n\n### [Business Users](https://poynt.com/docs/api/#business-users-index)\n\n- `getBusinessUsers`\n- `getBusinessUser`\n\n### Business Applications\n\n- `getBusinessApplication`\n- `getBusinessApplicationStatus`\n- `getBusinessApplicationAccount`\n- `getBusinessApplicationOrders`\n- `getBusinessApplicationProfile`\n\n## Examples\n\n### Charging a token from [Poynt Collect V2](https://sellbot.co/collect)\n\nThe most basic use case is just entering an amount and charging:\n\n```\npoynt.charge(\n  {\n    action: \"SALE\",\n    amounts: {\n      currency: \"USD\",\n      transactionAmount: 500,\n      orderAmount: 500,\n    },\n    businessId: \"84fa5bf5-bd51-4653-80de-ce46348f7659\",\n    token: \"...token...\",\n  },\n  function (err, transaction) {\n    if (err) {\n      // deal with your error\n      console.log(err);\n    } else {\n      // do something with transaction\n      console.log(transaction);\n    }\n  }\n);\n```\n\nMany other fields are accepted – including address, phone, and references. The following code makes a charge, fetches the full transaction, and then voids it.\n\n```\npoynt.charge(\n  {\n    action: \"SALE\",\n    address: {\n      line1: \"858 University Ave\",\n      line2: \"\",\n      city: \"Palo Alto\",\n      territory: \"CA\",\n      countryCode: \"US\",\n      postalCode: \"94301\",\n    },\n    amounts: {\n      currency: \"USD\",\n      transactionAmount: 500,\n      orderAmount: 500,\n    },\n    businessId: \"84fa5bf5-bd51-4653-80de-ce46348f7659\",\n    emailReceipt: true,\n    phone: {\n      ituCountryCode: \"1\",\n      areaCode: \"234\",\n      localPhoneNumber: \"5678901\",\n    },\n    receiptEmailAddress: \"charles@example.com\",\n    references: [\n      {\n        customType: \"WEBSITE_ID\",\n        id: \"123456\",\n        type: \"CUSTOM\",\n      },\n      {\n        customType: \"CHANNEL_ORDER_ID\",\n        id: \"abcdef\",\n        type: \"CUSTOM\",\n      },\n    ],\n    sourceApp: \"Online Store\",\n    token: \"...token...\",\n  },\n  function (err, transaction) {\n    if (err) {\n      // deal with your error\n      return console.log(err);\n    }\n\n    console.log(\"Transaction processed\", JSON.stringify(transaction, null, 2));\n\n    // get the transaction\n    poynt.getTransaction(\n      {\n        businessId: \"84fa5bf5-bd51-4653-80de-ce46348f7659\",\n        transactionId: transaction.id,\n      },\n      function (err, transaction) {\n        if (err) {\n          // deal with your error\n          return console.log(err);\n        }\n\n        console.log(\n          \"Transaction fetched\",\n          JSON.stringify(transaction, null, 2)\n        );\n\n        // void the transaction\n        poynt.voidTransaction(\n          {\n            businessId: \"84fa5bf5-bd51-4653-80de-ce46348f7659\",\n            transactionId: transaction.id,\n          },\n          function (err, voidedTransaction) {\n            if (err) {\n              // deal with your error\n              return console.log(err);\n            }\n\n            console.log(\n              \"Transaction voided\",\n              JSON.stringify(voidedTransaction, null, 2)\n            );\n          }\n        );\n      }\n    );\n  }\n);\n```\n\n### Apple Pay Registration\n\n- `registerApplePayMerchant`\n- `unregisterApplePayMerchant`\n- `getApplePayMerchant`\n- `getApplePayDomainAssociationFile`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodaddy%2Fpoynt-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodaddy%2Fpoynt-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodaddy%2Fpoynt-node/lists"}