# Paysafe v1.0.0 - Table of Contents

> Production-grade Elixir client for the Paysafe API

## Pages

- [Paysafe](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- [Paysafe](Paysafe.md): Production-grade Elixir client for the Paysafe API.
- [Paysafe.AccountUpdater](Paysafe.AccountUpdater.md): Account Updater service — **not available as a REST API.**
- [Paysafe.BankAccountValidation](Paysafe.BankAccountValidation.md): Bank Account Validation API.
- [Paysafe.CustomerIdentity](Paysafe.CustomerIdentity.md): Customer Identity (KYC) API.
- [Paysafe.FxRates](Paysafe.FxRates.md): FX Rates API — guaranteed exchange rate quotes with expiry timestamps.
- [Paysafe.InteracVerificationService](Paysafe.InteracVerificationService.md): Interac® Verification Service (VerifiedMe).
- [Paysafe.ParamEncoder](Paysafe.ParamEncoder.md): Shared helpers for converting idiomatic Elixir param maps (snake_case atom
keys) into the camelCase JSON shape the Paysafe API expects, with `nil`
values stripped recursively.
- [Paysafe.Types](Paysafe.Types.md): Shared typespecs used across all Paysafe API modules.

- [Paysafe.Types.Application](Paysafe.Types.Application.md): Represents a merchant onboarding Application.
- [Paysafe.Types.BankVerification](Paysafe.Types.BankVerification.md): Represents a Bank Account Validation or Interac Verification Service
verification session. Both products share this redirect-based shape.

- [Paysafe.Types.Customer](Paysafe.Types.Customer.md): Represents a Customer Vault profile.
- [Paysafe.Types.FxRate](Paysafe.Types.FxRate.md): Represents an FX rate quote from the FX Rates API.
- [Paysafe.Types.IdentityProfile](Paysafe.Types.IdentityProfile.md): Represents a Customer Identity (KYC) check result.
- [Paysafe.Types.WebhookEvent](Paysafe.Types.WebhookEvent.md): Represents a decoded and verified Paysafe webhook event.

- Payments API
  - [Paysafe.Payments.Customers](Paysafe.Payments.Customers.md): Customer profile and multi-use token management for the Paysafe Payments API.
  - [Paysafe.Payments.PaymentHandles](Paysafe.Payments.PaymentHandles.md): Payment Handle operations for the Paysafe Payments API.
  - [Paysafe.Payments.Payments](Paysafe.Payments.Payments.md): Payment operations for the Paysafe Payments API.
  - [Paysafe.Payments.Payouts](Paysafe.Payments.Payouts.md): Payout (credit) operations for the Paysafe Payments API.
  - [Paysafe.Payments.Refunds](Paysafe.Payments.Refunds.md): Refund operations for the Paysafe Payments API.
  - [Paysafe.Payments.Settlements](Paysafe.Payments.Settlements.md): Settlement operations for the Paysafe Payments API.
  - [Paysafe.Payments.Verifications](Paysafe.Payments.Verifications.md): Card verification operations for the Paysafe Payments API.

- Scheduler API
  - [Paysafe.Scheduler.Plans](Paysafe.Scheduler.Plans.md): Plan operations for the Paysafe Payment Scheduler API.
  - [Paysafe.Scheduler.Subscriptions](Paysafe.Scheduler.Subscriptions.md): Subscription operations for the Paysafe Payment Scheduler API.

- Applications API
  - [Paysafe.Applications](Paysafe.Applications.md): Applications (Merchant Onboarding) API for platform partners.

- Webhooks
  - [Paysafe.Webhooks](Paysafe.Webhooks.md): Webhook verification and parsing for Paysafe event notifications.

- Types
  - [Paysafe.Types.Payment](Paysafe.Types.Payment.md): Represents a Paysafe Payment response.
  - [Paysafe.Types.PaymentHandle](Paysafe.Types.PaymentHandle.md): Represents a Paysafe Payment Handle response.
  - [Paysafe.Types.Plan](Paysafe.Types.Plan.md): Represents a Payment Scheduler Plan.
  - [Paysafe.Types.Refund](Paysafe.Types.Refund.md): Represents a Paysafe Refund response.
  - [Paysafe.Types.Settlement](Paysafe.Types.Settlement.md): Represents a Paysafe Settlement response.
  - [Paysafe.Types.Subscription](Paysafe.Types.Subscription.md): Represents a Payment Scheduler Subscription.

- Infrastructure
  - [Paysafe.Client](Paysafe.Client.md): Internal HTTP client for all Paysafe API calls.
  - [Paysafe.Config](Paysafe.Config.md): Configuration for the Paysafe client.
  - [Paysafe.Error](Paysafe.Error.md): Structured error type returned by all Paysafe API operations.
  - [Paysafe.RateLimiter](Paysafe.RateLimiter.md): Token-bucket rate limiter backed by `ExRated`.
  - [Paysafe.Telemetry](Paysafe.Telemetry.md): Telemetry instrumentation for all Paysafe API calls.

