{"_id":"@adonis-agora/payments-react","name":"@adonis-agora/payments-react","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@adonis-agora/payments-react","version":"0.1.0","description":"React hook for @adonis-agora/payments — poll a Pix or boleto charge until the gateway's webhook settles it, with backoff, a stop condition and no polling in a background tab. Part of the Agora ecosystem.","license":"MIT","repository":{"type":"git","url":"git+https://github.com/DavideCarvalho/adonis-agora-payments.git","directory":"packages/react"},"author":"Davi Carvalho <davi@goflip.ai>","type":"module","main":"./dist/src/index.js","types":"./dist/src/index.d.ts","exports":{".":{"types":"./dist/src/index.d.ts","import":"./dist/src/index.js","default":"./dist/src/index.js"}},"sideEffects":false,"peerDependencies":{"react":"^18.0.0 || ^19.0.0"},"devDependencies":{"@testing-library/react":"16.3.2","@types/node":"20.19.43","@types/react":"18.3.31","@types/react-dom":"18.3.7","jsdom":"25.0.1","react":"18.3.1","react-dom":"18.3.1","typescript":"5.9.3","vitest":"3.2.7"},"engines":{"node":">=20.6.0"},"keywords":["adonisjs","adonis","payments","billing","pix","boleto","react-hooks","polling","agora"],"scripts":{"build":"pnpm run clean && tsc -p tsconfig.build.json","clean":"rm -rf dist","test":"vitest run --passWithNoTests","test:watch":"vitest","typecheck":"tsc -p tsconfig.json --noEmit"},"_nodeVersion":"22.23.2","_id":"@adonis-agora/payments-react@0.1.0","dist":{"integrity":"sha512-iaB5yBxqmh1cB7KA0amFw7fdnuZDcTOjsVTvT0vefDmLwSs8Q770ZU/nYb4P/6FO+/gh4dSJO6Y3LQeCJAzwLQ==","shasum":"8c716869518ebd3c6cc96bb2c28385ad775f6f09","tarball":"https://registry.npmjs.org/@adonis-agora/payments-react/-/payments-react-0.1.0.tgz","fileCount":14,"unpackedSize":31703,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCf49I9acHfXzbZ5es6bDj4vGtQWk5yKIAHztZe0OCJfgIhAJE97Q85HwbyGS+tNH2xupA+JHICQ6r8UNYCGveFh7D3"}]},"_npmUser":{"name":"dudousxd","email":"davi_carvalho96@hotmail.com"},"directories":{},"maintainers":[{"name":"dudousxd","email":"davi_carvalho96@hotmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/payments-react_0.1.0_1788018758941_0.554374341018455"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-29T15:52:38.736Z","0.1.0":"2026-08-29T15:52:39.113Z","modified":"2026-08-29T15:52:39.392Z"},"maintainers":[{"name":"dudousxd","email":"davi_carvalho96@hotmail.com"}],"description":"React hook for @adonis-agora/payments — poll a Pix or boleto charge until the gateway's webhook settles it, with backoff, a stop condition and no polling in a background tab. Part of the Agora ecosystem.","keywords":["adonisjs","adonis","payments","billing","pix","boleto","react-hooks","polling","agora"],"repository":{"type":"git","url":"git+https://github.com/DavideCarvalho/adonis-agora-payments.git","directory":"packages/react"},"author":"Davi Carvalho <davi@goflip.ai>","license":"MIT","readme":"# @adonis-agora/payments-react\n\nReact hook for [`@adonis-agora/payments`](https://www.npmjs.com/package/@adonis-agora/payments).\n\nA Pix QR code (or a boleto) is not paid until the gateway's webhook confirms it, which lands\nseconds to days later. This is the polling loop every app that takes Pix otherwise writes by\nhand — with backoff, a stop condition, and no polling in a background tab.\n\n```tsx\nimport { usePaymentStatus } from '@adonis-agora/payments-react'\n\nfunction PixPanel({ reference }: { reference: string }) {\n  const { status, isSettled, error } = usePaymentStatus(reference)\n\n  if (error) return <p>{error.message}</p>\n  if (isSettled && status === 'paid') return <p>Paid.</p>\n  return <p>Waiting for the payment…</p>\n}\n```\n\nIt polls `GET /payments/client/status?reference=…`, mounted by\n`@adonis-agora/payments/payments_client_provider` from `config/payments_client.ts` — an\nopt-in endpoint that resolves the caller first and answers only for payments that caller\nowns. Point `path` at your own route to poll a hand-rolled endpoint instead.\n\nIt does **not** wrap any gateway's card SDK: Stripe, Mercado Pago and Adyen ship their own.\n\nFull documentation: <https://agora.goflip.ai/docs/payments/client>\n\nMIT © Davi Carvalho\n","readmeFilename":"","_rev":"1-7232cd9bf00bc351d9efa947a7d78d54"}