# rapyd v1.0.0 - Table of Contents

> Production-grade Elixir SDK for the Rapyd fintech-as-a-service platform.
Covers Collect, Disburse, Wallet, Issuing, Partner, Webhook, and Resource APIs
with HMAC-SHA256 auth, full-jitter retry, structured errors, and typed responses.

## Pages

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

## Modules

- [Rapyd.HTTP.Behaviour](Rapyd.HTTP.Behaviour.md): Contract that every HTTP client implementation must satisfy.
- [Rapyd.Types.BusinessDetails](Rapyd.Types.BusinessDetails.md): Company-level fields for a business wallet contact.
- [Rapyd.Types.CardDetails](Rapyd.Types.CardDetails.md): Sensitive PAN/CVV card data for cardholder display (PCI scope).
- [Rapyd.Types.CheckoutPage](Rapyd.Types.CheckoutPage.md): A Rapyd-hosted checkout page.
- [Rapyd.Types.Coupon](Rapyd.Types.Coupon.md): A discount coupon.
- [Rapyd.Types.EWalletSplit](Rapyd.Types.EWalletSplit.md): One wallet's share in a split or group payment.
- [Rapyd.Types.Fee](Rapyd.Types.Fee.md): A single fee rule (percentage or absolute) applied to a payment.
- [Rapyd.Types.Invoice](Rapyd.Types.Invoice.md): A billing invoice.
- [Rapyd.Types.IssuedCardTransaction](Rapyd.Types.IssuedCardTransaction.md): A SALE/REFUND/REVERSAL event on an issued card.
- [Rapyd.Types.Order](Rapyd.Types.Order.md): A commerce order.
- [Rapyd.Types.Pagination](Rapyd.Types.Pagination.md): Cursor-based pagination parameters for list endpoints.
- [Rapyd.Types.PaymentFees](Rapyd.Types.PaymentFees.md): Transaction and FX fee configuration for a payment.
- [Rapyd.Types.PayoutMethodType](Rapyd.Types.PayoutMethodType.md): An available payout method for a sender/beneficiary country+currency combination.
- [Rapyd.Types.Plan](Rapyd.Types.Plan.md): A recurring billing plan.
- [Rapyd.Types.SKU](Rapyd.Types.SKU.md): A product inventory unit (SKU).
- [Rapyd.Types.SavedPaymentMethod](Rapyd.Types.SavedPaymentMethod.md): A payment method stored against a Rapyd customer.
- [Rapyd.Types.Subscription](Rapyd.Types.Subscription.md): A recurring billing subscription.
- [Rapyd.Types.WalletAccount](Rapyd.Types.WalletAccount.md): A currency-denominated balance account within a wallet.

- Entry Point
  - [Rapyd](Rapyd.md): Production-grade Elixir SDK for the [Rapyd](https://www.rapyd.net/)
fintech-as-a-service platform.
  - [Rapyd.Client](Rapyd.Client.md): Immutable configuration struct passed to every service call.

- Services
  - [Rapyd.Services.Collect](Rapyd.Services.Collect.md): Rapyd Collect — accept payments globally.
  - [Rapyd.Services.Disburse](Rapyd.Services.Disburse.md): Rapyd Disburse — send payouts to beneficiaries worldwide.
  - [Rapyd.Services.Issuing](Rapyd.Services.Issuing.md): Rapyd Issuing — issue and manage physical and virtual payment cards.
  - [Rapyd.Services.Partner](Rapyd.Services.Partner.md): Rapyd Partner / PayFac — KYB onboarding and sub-merchant management.
  - [Rapyd.Services.Resource](Rapyd.Services.Resource.md): Rapyd Reference Data — countries, currencies, payment methods, FX rates.

  - [Rapyd.Services.Wallet](Rapyd.Services.Wallet.md): Rapyd Wallet — manage eWallets, contacts, virtual accounts, KYC/KYB.
  - [Rapyd.Services.Webhook](Rapyd.Services.Webhook.md): Rapyd Webhooks — verify inbound events and route to handlers.

- Types — Payments
  - [Rapyd.Types.Dispute](Rapyd.Types.Dispute.md): A card chargeback dispute.
  - [Rapyd.Types.GroupPayment](Rapyd.Types.GroupPayment.md): A group payment that collects funds from multiple payers.
  - [Rapyd.Types.Payment](Rapyd.Types.Payment.md): A Rapyd Collect payment object.
  - [Rapyd.Types.PaymentLink](Rapyd.Types.PaymentLink.md): A reusable, shareable Rapyd payment URL.
  - [Rapyd.Types.Refund](Rapyd.Types.Refund.md): A Rapyd payment refund.

- Types — Disburse
  - [Rapyd.Types.Beneficiary](Rapyd.Types.Beneficiary.md): The recipient of a Rapyd payout.
  - [Rapyd.Types.Payout](Rapyd.Types.Payout.md): A Rapyd Disburse payout object.
  - [Rapyd.Types.Sender](Rapyd.Types.Sender.md): The originator of a Rapyd payout on behalf of the merchant.

- Types — Wallet
  - [Rapyd.Types.Contact](Rapyd.Types.Contact.md): A person or business associated with a Rapyd wallet.
  - [Rapyd.Types.Identity](Rapyd.Types.Identity.md): A KYC identity verification record.
  - [Rapyd.Types.Transfer](Rapyd.Types.Transfer.md): A wallet-to-wallet fund transfer.
  - [Rapyd.Types.VirtualAccount](Rapyd.Types.VirtualAccount.md): An issued bank account number tied to a Rapyd wallet.
  - [Rapyd.Types.Wallet](Rapyd.Types.Wallet.md): A Rapyd eWallet.
  - [Rapyd.Types.WalletTransaction](Rapyd.Types.WalletTransaction.md): A single financial event on a wallet.

- Types — Issuing
  - [Rapyd.Types.CardToken](Rapyd.Types.CardToken.md): A digital wallet provisioning token (Google Pay / Apple Pay).
  - [Rapyd.Types.IssuedCard](Rapyd.Types.IssuedCard.md): A Rapyd-issued physical or virtual payment card.

- Types — Partner
  - [Rapyd.Types.Application](Rapyd.Types.Application.md): A KYB application for a sub-merchant.
  - [Rapyd.Types.Organization](Rapyd.Types.Organization.md): A partner-created merchant organization.
  - [Rapyd.Types.SettlementBankAccount](Rapyd.Types.SettlementBankAccount.md): A merchant bank account linked for settlements.

- Types — Webhooks
  - [Rapyd.Types.WebhookEvent](Rapyd.Types.WebhookEvent.md): A decoded and verified Rapyd webhook event.

- Types — Shared
  - [Rapyd.Types.Address](Rapyd.Types.Address.md): Physical address used across multiple Rapyd domains.
  - [Rapyd.Types.Customer](Rapyd.Types.Customer.md): A Rapyd customer profile.
  - [Rapyd.Types.FXRate](Rapyd.Types.FXRate.md): Foreign-exchange rate returned by the Get FX Rate endpoint.

- Infrastructure
  - [Rapyd.HTTP.Client](Rapyd.HTTP.Client.md): Default HTTP transport for the Rapyd SDK.
  - [Rapyd.Signing](Rapyd.Signing.md): Generates and verifies Rapyd HMAC-SHA256 request signatures.

- Errors
  - [Rapyd.Error](Rapyd.Error.md): Structured error returned by every failed SDK operation.