# Cashful API Documentation

## Docs

- [Create API Key](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/api-key/create-api-key.md): Create a new API key
- [Delete API Key](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/api-key/delete-api-key.md): Delete an API key
- [List API Keys](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/api-key/list-api-keys.md): List all API keys for the current user
- [Update API Key](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/api-key/update-api-key.md): Update an API key's properties
- [Verify API Key](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/api-key/verify-api-key.md): Verify an API key to check validity and metadata
- [Forget Password](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/forget-password/forget-password.md): Send a password reset email to the user
- [Get Session](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/get-session/get-session.md): Retrieve the current user session
- [Create Organization](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/create/create-organization.md): Create a new organization
- [Delete Organization](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/delete/delete-organization.md): Delete an organization
- [List Organizations](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/list/list-organizations.md): List all organizations for the current user
- [Remove Member](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/remove-member/remove-member.md): Remove a member from an organization
- [Set Active Organization](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/set-active/set-active-organization.md): Set the active organization for the current session
- [Update Member Role](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/update-member-role/update-member-role.md): Update a member's role in an organization
- [Update Organization](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/organization/update/update-organization.md): Update an organization's details
- [Reset Password](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/reset-password/reset-password.md): Reset the user's password using a token
- [Sign in with Email](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/sign-in/email/sign-in-email.md): Authenticate a user using email and password
- [Sign out](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/sign-out/sign-out.md): Sign out the current user and invalidate the session
- [Sign up with Email](https://docs.cashful.africa/api-reference/endpoint/api/canary/authentication/sign-up/email/sign-up-email.md): Create a new user account using email and password
- [Get Merchant Balance](https://docs.cashful.africa/api-reference/endpoint/api/canary/balance/get-merchant-balance.md): Retrieves the merchant's master balance available for payouts
- [Create Hosted Checkout](https://docs.cashful.africa/api-reference/endpoint/api/canary/checkout/sessions/create-checkout-session.md): Creates a hosted payment page for e-commerce purchases or customer balance funding
- [Create Customer](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/create-customer.md): Creates a new customer and provisions their cash balance feature
- [Get Customer's Cash Balance](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/id/balance/get-customer-cash-balance.md): Retrieves the real-time balance for a customer's cash balance (wallet feature)
- [List Customer's Payment Methods](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/id/payment-methods/list-customer-payment-methods.md): Shows all saved payment methods (cards, etc.) for a customer
- [Retrieve Customer](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/id/retrieve-customer.md): Gets the details for a single customer
- [List Customer's Cash Transactions](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/id/transactions/list-customer-transactions.md): Retrieves the full transaction history for a customer's cash balance
- [Update Customer](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/id/update-customer.md): Updates a customer's details such as email or metadata
- [List Customers](https://docs.cashful.africa/api-reference/endpoint/api/canary/customers/list-customers.md): Retrieves a paginated list of all customers for the merchant
- [Create Payment Link](https://docs.cashful.africa/api-reference/endpoint/api/canary/payment-links/create-payment-link.md): Creates a re-usable hosted payment link
- [Update Payment Link](https://docs.cashful.africa/api-reference/endpoint/api/canary/payment-links/id/update-payment-link.md): Update an existing payment link
- [List Payment Links](https://docs.cashful.africa/api-reference/endpoint/api/canary/payment-links/list-payment-links.md): Retrieves all payment links created by the merchant
- [Delete Payment Method](https://docs.cashful.africa/api-reference/endpoint/api/canary/payment-methods/id/delete-payment-method.md): Detaches and deletes a saved payment method from a customer
- [Retrieve Payment Method](https://docs.cashful.africa/api-reference/endpoint/api/canary/payment-methods/id/retrieve-payment-method.md): Gets the non-sensitive details of a saved card
- [Create Product](https://docs.cashful.africa/api-reference/endpoint/api/canary/products/create-product.md): Defines a product in the merchant's catalog
- [Update Product](https://docs.cashful.africa/api-reference/endpoint/api/canary/products/id/update-product.md): Updates a product's name, description, or metadata
- [List Products](https://docs.cashful.africa/api-reference/endpoint/api/canary/products/list-products.md): Retrieves a paginated list of all products in the merchant's catalog
- [Create Webhook Endpoint](https://docs.cashful.africa/api-reference/endpoint/api/canary/webhook-endpoints/create-webhook-endpoint.md): Registers a URL to receive real-time events
- [Delete Webhook Endpoint](https://docs.cashful.africa/api-reference/endpoint/api/canary/webhook-endpoints/id/delete-webhook-endpoint.md): Stops sending events to a specific webhook URL
- [List Webhook Endpoints](https://docs.cashful.africa/api-reference/endpoint/api/canary/webhook-endpoints/list-webhook-endpoints.md): Lists all configured webhook endpoints
- [Authentication](https://docs.cashful.africa/guides/getting-started/authentication.md): How to sign in and obtain a session token for API requests.
- [Getting Started Overview](https://docs.cashful.africa/guides/getting-started/overview.md): A quick overview of the onboarding flow and recommended next steps for integrating with the Cashful API.
- [Create a Checkout Session](https://docs.cashful.africa/guides/tutorials/create-a-checkout-session.md): How to create and redirect a customer to a checkout session.
- [Manage Customers](https://docs.cashful.africa/guides/tutorials/manage-customers.md): Best practices and examples for creating and managing customers in Cashful.
- [Merchant Onboarding](https://docs.cashful.africa/guides/tutorials/merchant-onboarding.md): A step-by-step tutorial to sign up, create an organization, add a customer, and process a checkout session using the Cashful API.
- [Changelog](https://docs.cashful.africa/releases/index.md): All notable Cashful API releases and changes are documented in this changelog.
- [Code examples](https://docs.cashful.africa/sdks/dotnet/code-examples.md)
- [Getting started](https://docs.cashful.africa/sdks/dotnet/getting-started.md)
- [Flutter SDK Code Examples](https://docs.cashful.africa/sdks/flutter/code-examples.md): Use-cases implementation with the Flutter SDK.
- [Getting started with the Flutter SDK](https://docs.cashful.africa/sdks/flutter/getting-started.md): Learn how to work with the Cashful SDK for Flutter.
- [Code examples](https://docs.cashful.africa/sdks/java/code-examples.md)
- [Getting started](https://docs.cashful.africa/sdks/java/getting-started.md)
- [Code examples](https://docs.cashful.africa/sdks/kotlin/code-examples.md)
- [Getting started](https://docs.cashful.africa/sdks/kotlin/getting-started.md)
- [Getting Started with our SDKs](https://docs.cashful.africa/sdks/overview.md)
- [Code examples](https://docs.cashful.africa/sdks/python/code-examples.md)
- [Getting started](https://docs.cashful.africa/sdks/python/getting-started.md)
- [Code examples](https://docs.cashful.africa/sdks/typescript/code-examples.md)
- [Getting started](https://docs.cashful.africa/sdks/typescript/getting-started.md)

## OpenAPI Specs

- [openapi](https://docs.cashful.africa/openapi.json)