# TapRails

## Docs

- [PaymentFlowManager](https://docs.taprails.xyz/api-reference/components/payment-flow-manager.md): Full-screen payment UI component that handles both merchant and customer flows.
- [SessionKeySetupFlow](https://docs.taprails.xyz/api-reference/components/session-key-setup-flow.md): Standalone component to trigger the session key onboarding flow.
- [TapRailsThemeProvider](https://docs.taprails.xyz/api-reference/components/theme-provider.md): Root context provider for TapRails UI theming and automatic session key setup.
- [useNFCCustomer](https://docs.taprails.xyz/api-reference/hooks/use-nfc-customer.md): React hook for scanning NFC invoices and processing payments as a customer.
- [useNFCMerchant](https://docs.taprails.xyz/api-reference/hooks/use-nfc-merchant.md): React hook for creating NFC payment requests as a merchant.
- [usePayment](https://docs.taprails.xyz/api-reference/hooks/use-payment.md): Low-level hook for direct payment API calls without NFC.
- [usePaymentStatus](https://docs.taprails.xyz/api-reference/hooks/use-payment-status.md): React hook for polling and tracking payment confirmation status.
- [useSessionKey](https://docs.taprails.xyz/api-reference/hooks/use-session-key.md): React hook for managing session keys for non-custodial payments.
- [Merchants](https://docs.taprails.xyz/api-reference/management/merchants.md): Provision and list sub-merchants under your company.
- [Management API Overview](https://docs.taprails.xyz/api-reference/management/overview.md): Programmatic backend-to-backend access for fintech engineering teams.
- [Payments](https://docs.taprails.xyz/api-reference/management/payments.md): Monitor and audit payment transactions across all merchants.
- [Pool Management](https://docs.taprails.xyz/api-reference/management/pool.md): Monitor and manage your company's treasury pool.
- [readSignedInvoice](https://docs.taprails.xyz/api-reference/nfc/read-signed-invoice.md): Read and cryptographically verify a payment invoice from an NFC tag.
- [NFC Utilities](https://docs.taprails.xyz/api-reference/nfc/utilities.md): Low-level NFC control functions for checking support, enabling the reader, and cancelling sessions.
- [writeSignedInvoice](https://docs.taprails.xyz/api-reference/nfc/write-signed-invoice.md): Emit a cryptographically signed payment invoice via NFC HCE (merchant device).
- [Enums](https://docs.taprails.xyz/api-reference/types/enums.md): PaymentMode, PaymentStatus, and other enum types.
- [Error Types](https://docs.taprails.xyz/api-reference/types/errors.md): NFCPaymentError and APIError classes and their error code enums.
- [MerchantStatus](https://docs.taprails.xyz/api-reference/types/merchant-status.md): Operational status values for TapRails merchant accounts.
- [Payment Request Types](https://docs.taprails.xyz/api-reference/types/payment-request.md): TypeScript types for payment creation, processing, and status.
- [SDK Config Types](https://docs.taprails.xyz/api-reference/types/sdk-config.md): TypeScript types for SDK initialization and configuration.
- [Initialize](https://docs.taprails.xyz/configuration/initialize.md): Configure the TapRails SDK with your API credentials and payment mode.
- [Payment Modes](https://docs.taprails.xyz/configuration/payment-modes.md): Understand POOL (custodial) vs SESSION_KEY (non-custodial) payment modes.
- [Chains](https://docs.taprails.xyz/coverage/chains.md)
- [Currencies](https://docs.taprails.xyz/coverage/currencies.md)
- [Get Started](https://docs.taprails.xyz/get-started.md): Set up your TapRails account, obtain API keys, configure webhooks, and create your first merchant in 5 minutes.
- [Customer Flow](https://docs.taprails.xyz/guides/customer-flow.md): Make contactless USDC payments by tapping your phone to a merchant terminal.
- [Error Handling](https://docs.taprails.xyz/guides/errors.md): Handle NFC and API errors gracefully in the TapRails SDK.
- [Supported Frameworks](https://docs.taprails.xyz/guides/frameworks.md): Overview of TapRails SDK availability across different mobile platforms.
- [Merchant Flow](https://docs.taprails.xyz/guides/merchant-flow.md): Accept contactless USDC payments using NFC tap-to-pay on Android.
- [Security & Compliance](https://docs.taprails.xyz/guides/security.md): Technical deep-dive into TapRails production-grade security architecture for POS device signing, atomic settlement, and compliance screening.
- [Session Key Setup](https://docs.taprails.xyz/guides/session-key-setup.md): Let users authorize gasless tap-to-pay from their own wallet using session keys.
- [UI Customization](https://docs.taprails.xyz/guides/ui-customization.md): Customize TapRails branded UI with your own colors and integrate reusable components.
- [Webhooks](https://docs.taprails.xyz/guides/webhooks.md): Receive real-time event notifications for payments, pool activity, and session key lifecycle events — with automatic retries and a full delivery log.
- [Android Setup](https://docs.taprails.xyz/installation/android.md): Configure your Android project to support NFC tap-to-pay with the TapRails SDK.
- [iOS Setup](https://docs.taprails.xyz/installation/ios.md): Configure your iOS project to support NFC reading with the TapRails SDK.
- [React Native Installation](https://docs.taprails.xyz/installation/overview.md): Install @taprails/tap-to-pay and set up its native dependencies.
- [Quickstart (React Native)](https://docs.taprails.xyz/installation/sdk-integration.md): Install @taprails/tap-to-pay and process your first NFC payment in 5 minutes.
- [Introduction](https://docs.taprails.xyz/introduction.md): Welcome to the TapRails Developer Hub. Stablecoin NFC payment infrastructure for fintechs and neobanks.

## OpenAPI Specs

- [openapi](https://docs.taprails.xyz/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/taprails/)