# GoCardlessClient v2.0.0 - Table of Contents

Production-ready Elixir client for the GoCardless API.

## Pages

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

## Modules

- [GoCardlessClient.Resource](GoCardlessClient.Resource.md): Shared HTTP helpers for GoCardlessClient resource modules.

- Core
  - [GoCardlessClient](GoCardlessClient.md): Production-ready Elixir client for the [GoCardlessClient API](https://developer.gocardless.com/api-reference/).
  - [GoCardlessClient.Client](GoCardlessClient.Client.md): GoCardlessClient API client struct. Build with `new/1` or `new!/1`.
  - [GoCardlessClient.Config](GoCardlessClient.Config.md): Validated configuration for the GoCardlessClient SDK.

- HTTP Layer
  - [GoCardlessClient.HTTP.Client](GoCardlessClient.HTTP.Client.md): Resilient HTTP client over Finch with retries, jitter backoff, and Telemetry.
  - [GoCardlessClient.HTTP.RateLimiter](GoCardlessClient.HTTP.RateLimiter.md): ETS-backed rate-limit state tracker.

- Billing Requests
  - [GoCardlessClient.Resources.BankAuthorisations](GoCardlessClient.Resources.BankAuthorisations.md): GoCardless Bank Authorisations API.
  - [GoCardlessClient.Resources.BillingRequestFlows](GoCardlessClient.Resources.BillingRequestFlows.md): GoCardless Billing Request Flows API.
  - [GoCardlessClient.Resources.BillingRequestTemplates](GoCardlessClient.Resources.BillingRequestTemplates.md): GoCardless Billing Request Templates API.
  - [GoCardlessClient.Resources.BillingRequestWithActions](GoCardlessClient.Resources.BillingRequestWithActions.md): GoCardless Billing Request with Actions API.
  - [GoCardlessClient.Resources.BillingRequests](GoCardlessClient.Resources.BillingRequests.md): GoCardlessClient Billing Requests API.
  - [GoCardlessClient.Resources.Institutions](GoCardlessClient.Resources.Institutions.md): GoCardless Institutions API.

- Core Resources
  - [GoCardlessClient.Resources.Balances](GoCardlessClient.Resources.Balances.md): GoCardless Balances API.
  - [GoCardlessClient.Resources.BankAccountDetails](GoCardlessClient.Resources.BankAccountDetails.md): GoCardless Bank Account Details API.
  - [GoCardlessClient.Resources.BankAccountHolderVerifications](GoCardlessClient.Resources.BankAccountHolderVerifications.md): GoCardless Bank Account Holder Verifications API (Confirmation of Payee).
  - [GoCardlessClient.Resources.BankDetailsLookups](GoCardlessClient.Resources.BankDetailsLookups.md): GoCardless Bank Details Lookups API.
  - [GoCardlessClient.Resources.Blocks](GoCardlessClient.Resources.Blocks.md): GoCardless Blocks API.
  - [GoCardlessClient.Resources.CreditorBankAccounts](GoCardlessClient.Resources.CreditorBankAccounts.md): GoCardlessClient Creditor Bank Accounts API.
  - [GoCardlessClient.Resources.Creditors](GoCardlessClient.Resources.Creditors.md): GoCardlessClient Creditors API.
  - [GoCardlessClient.Resources.CurrencyExchangeRates](GoCardlessClient.Resources.CurrencyExchangeRates.md): GoCardless Currency Exchange Rates API.
  - [GoCardlessClient.Resources.CustomerBankAccounts](GoCardlessClient.Resources.CustomerBankAccounts.md): GoCardlessClient Customer Bank Accounts API.
  - [GoCardlessClient.Resources.CustomerNotifications](GoCardlessClient.Resources.CustomerNotifications.md): GoCardless Customer Notifications API.
  - [GoCardlessClient.Resources.Customers](GoCardlessClient.Resources.Customers.md): GoCardlessClient Customers API.
  - [GoCardlessClient.Resources.Events](GoCardlessClient.Resources.Events.md): GoCardless Events API.
  - [GoCardlessClient.Resources.Exports](GoCardlessClient.Resources.Exports.md): GoCardless Exports API.
  - [GoCardlessClient.Resources.FundsAvailabilities](GoCardlessClient.Resources.FundsAvailabilities.md): GoCardless Funds Availabilities API.
  - [GoCardlessClient.Resources.InstalmentSchedules](GoCardlessClient.Resources.InstalmentSchedules.md): GoCardless Instalment Schedules API.
  - [GoCardlessClient.Resources.Logos](GoCardlessClient.Resources.Logos.md): GoCardless Logos API.
  - [GoCardlessClient.Resources.MandateImportEntries](GoCardlessClient.Resources.MandateImportEntries.md): GoCardless Mandate Import Entries API.
  - [GoCardlessClient.Resources.MandateImports](GoCardlessClient.Resources.MandateImports.md): GoCardless Mandate Imports API.
  - [GoCardlessClient.Resources.MandatePDFs](GoCardlessClient.Resources.MandatePDFs.md): GoCardless Mandate PDFs API.
  - [GoCardlessClient.Resources.Mandates](GoCardlessClient.Resources.Mandates.md): GoCardlessClient Mandates API.
  - [GoCardlessClient.Resources.NegativeBalanceLimits](GoCardlessClient.Resources.NegativeBalanceLimits.md): GoCardless Negative Balance Limits API.
  - [GoCardlessClient.Resources.OutboundPaymentImportEntries](GoCardlessClient.Resources.OutboundPaymentImportEntries.md): GoCardless Outbound Payment Import Entries API.
  - [GoCardlessClient.Resources.OutboundPaymentImports](GoCardlessClient.Resources.OutboundPaymentImports.md): GoCardless Outbound Payment Imports API.
  - [GoCardlessClient.Resources.OutboundPayments](GoCardlessClient.Resources.OutboundPayments.md): GoCardless Outbound Payments API.
  - [GoCardlessClient.Resources.PayerAuthorisations](GoCardlessClient.Resources.PayerAuthorisations.md): GoCardless Payer Authorisations API (Legacy).
  - [GoCardlessClient.Resources.PayerThemes](GoCardlessClient.Resources.PayerThemes.md): GoCardless Payer Themes API.
  - [GoCardlessClient.Resources.PaymentAccountTransactions](GoCardlessClient.Resources.PaymentAccountTransactions.md): GoCardless Payment Account Transactions API.
  - [GoCardlessClient.Resources.PaymentAccounts](GoCardlessClient.Resources.PaymentAccounts.md): GoCardless Payment Accounts API.
  - [GoCardlessClient.Resources.Payments](GoCardlessClient.Resources.Payments.md): GoCardlessClient Payments API.
  - [GoCardlessClient.Resources.PayoutItems](GoCardlessClient.Resources.PayoutItems.md): GoCardless Payout Items API.
  - [GoCardlessClient.Resources.Payouts](GoCardlessClient.Resources.Payouts.md): GoCardless Payouts API.
  - [GoCardlessClient.Resources.RedirectFlows](GoCardlessClient.Resources.RedirectFlows.md): GoCardless Redirect Flows API (Legacy).
  - [GoCardlessClient.Resources.Refunds](GoCardlessClient.Resources.Refunds.md): GoCardlessClient Refunds API.
  - [GoCardlessClient.Resources.ScenarioSimulators](GoCardlessClient.Resources.ScenarioSimulators.md): GoCardless Scenario Simulators API — **Sandbox only**.
  - [GoCardlessClient.Resources.SchemeIdentifiers](GoCardlessClient.Resources.SchemeIdentifiers.md): GoCardlessClient Scheme Identifiers API.
  - [GoCardlessClient.Resources.Subscriptions](GoCardlessClient.Resources.Subscriptions.md): GoCardlessClient Subscriptions API.
  - [GoCardlessClient.Resources.TaxRates](GoCardlessClient.Resources.TaxRates.md): GoCardless Tax Rates API.
  - [GoCardlessClient.Resources.TransferredMandates](GoCardlessClient.Resources.TransferredMandates.md): GoCardless Transferred Mandates API.
  - [GoCardlessClient.Resources.VerificationDetails](GoCardlessClient.Resources.VerificationDetails.md): GoCardless Verification Details API.
  - [GoCardlessClient.Resources.Webhooks](GoCardlessClient.Resources.Webhooks.md): GoCardless Webhooks API.

- Webhooks
  - [GoCardlessClient.Webhooks](GoCardlessClient.Webhooks.md): Webhook signature verification, event parsing, and helper predicates.
  - [GoCardlessClient.Webhooks.Plug](GoCardlessClient.Webhooks.Plug.md): A Plug that verifies GoCardlessClient webhook signatures and parses events.

- OAuth2
  - [GoCardlessClient.OAuth](GoCardlessClient.OAuth.md): GoCardlessClient OAuth2 partner integration.

- Request Signing
  - [GoCardlessClient.Signing](GoCardlessClient.Signing.md): GoCardlessClient API request signing for Outbound Payments.

- Pagination
  - [GoCardlessClient.Paginator](GoCardlessClient.Paginator.md): Cursor-based pagination for GoCardlessClient list endpoints.

- Errors
  - [GoCardlessClient.APIError](GoCardlessClient.APIError.md): Structured error returned by the GoCardlessClient API.
  - [GoCardlessClient.Error](GoCardlessClient.Error.md): Network-level and SDK-level errors (not API errors).
  - [GoCardlessClient.FieldError](GoCardlessClient.FieldError.md): Single field-level validation error within a `GoCardlessClient.APIError`.

