# FinConnect

## Docs

- [azampay-provider](https://finconnect.mintlify.app/api/azampay-provider.md): Reference for AzampayProvider: JWT token generation via authenticate() and USSD push payment initiation via initiateUssdPushRequest() for  Azampay.
- [BaseProvider interface reference](https://finconnect.mintlify.app/api/base-provider.md): Reference for the abstract baseProvider class that all FinConnect provider implementations must extend, defining the core payment methods.
- [ClickpesaProvider API reference](https://finconnect.mintlify.app/api/clickpesa-provider.md): Reference for ClickpesaProvider: JWT token generation via authenticate() and USSD push payment initiation via initiateUssdPushRequest() for ClickPesa.
- [FintechSDK class reference](https://finconnect.mintlify.app/api/fintech-sdk.md): Complete reference for FintechSDK: constructor options, the pay() method for USSD push payments, and registerIpn() for webhook registration with PesaPal.
- [PesapalProvider API reference](https://finconnect.mintlify.app/api/pesapal-provider.md): Reference for PesapalProvider: OAuth2 token exchange via authenticate(), IPN registration via registerIpn(), and order submission via initiateUssdPushRequest().
- [Authentication with FinConnect providers](https://finconnect.mintlify.app/concepts/authentication.md): FinConnect handles OAuth2 token exchange for PesaPal and JWT generation for ClickPesa automatically, so you never need to manage authentication tokens manually.
- [How payment processing works in FinConnect](https://finconnect.mintlify.app/concepts/payments.md): Learn the USSD push payment lifecycle in FinConnect: how sdk.pay() works, per-provider payload differences, and how IPN notifications complete the flow.
- [Payment providers in FinConnect](https://finconnect.mintlify.app/concepts/providers.md): Understand how FinConnect abstracts PesaPal ,ClickPesa and Azampay behind one interface, and learn what config each provider requires and how provider selection works.
- [Configure FinConnect for your environment](https://finconnect.mintlify.app/configuration.md): Set up PesaPal and ClickPesa credentials in FinConnect using environment variables, and switch between sandbox and production with one config change.
- [AzamPay](https://finconnect.mintlify.app/guides/azampay.md)
- [Accept payments with ClickPesa](https://finconnect.mintlify.app/guides/clickpesa.md): Integrate ClickPesa USSD push payments with FinConnect in three steps: configure JWT credentials, initialize the SDK, and call sdk.pay() with your payload.
- [Handle errors and troubleshoot FinConnect](https://finconnect.mintlify.app/guides/error-handling.md): Learn how FinConnect surfaces provider errors and how to handle configuration failures, authentication errors, payment rejections, and unsupported operations.
- [Set up IPN webhooks for payment notifications](https://finconnect.mintlify.app/guides/ipn-webhooks.md): Register an IPN URL with PesaPal through FinConnect, set up an Express handler to receive payment notifications, and connect the ipnId to your pay() calls.
- [Accept payments with PesaPal](https://finconnect.mintlify.app/guides/pesapal.md): Walk through a complete PesaPal integration with FinConnect: configure OAuth2 credentials, register an IPN URL, submit a payment order, and handle the callback.
- [FinConnect: Unified East African Payments SDK](https://finconnect.mintlify.app/introduction.md): FinConnect is a TypeScript SDK that unifies East Africa fintech companies' mobile payment services behind a single API, eliminating per-provider auth flows and payload differences for Node.js apps.
- [Get started with FinConnect](https://finconnect.mintlify.app/quickstart.md): Install FinConnect, set up your PesaPal credentials, register an IPN URL, and submit your first payment order in under five minutes.
- [Secure your FinConnect integration](https://finconnect.mintlify.app/security/best-practices.md): Secure your FinConnect integration with environment-variable credentials, separate sandbox and production keys, input validation, and server-side error logging.

## OpenAPI Specs

- [openapi](https://finconnect.mintlify.app/api-reference/openapi.json)