# finmid

> Developer documentation for the finmid embedded finance API.

## API Reference

- [API Overview](https://docs.finmid.com/api/overview.md): Introduction to the finmid REST API: base URLs, authentication, and errors.

## Capital

- [Create Anonymous Business](https://docs.finmid.com/capital/api/businesses/create-business.md): Create and manage the merchants on your Platform through the Capital API.
- [Get Business](https://docs.finmid.com/capital/api/businesses/get-business.md): Create and manage the merchants on your Platform through the Capital API.
- [Submit Performance Data](https://docs.finmid.com/capital/api/businesses/submit-business-performance-data.md): Create and manage the merchants on your Platform through the Capital API.
- [Submit Business's KYB data](https://docs.finmid.com/capital/api/businesses/submit-businesss-kyb-data.md): Create and manage the merchants on your Platform through the Capital API.
- [Update Anonymous data](https://docs.finmid.com/capital/api/businesses/update-business-non-pi-data.md): Create and manage the merchants on your Platform through the Capital API.
- [Upload KYB Document](https://docs.finmid.com/capital/api/businesses/upload-kyb-document-for-a-business.md): Create and manage the merchants on your Platform through the Capital API.
- [Delete CSP Financial Document](https://docs.finmid.com/capital/api/csp-documents/delete-csp-financial-document.md): Upload and manage CSP financial documents for merchants.
- [Finalize CSP Financial Documents Submission](https://docs.finmid.com/capital/api/csp-documents/finalize-csp-financial-documents-submission.md): Upload and manage CSP financial documents for merchants.
- [List CSP Financial Documents](https://docs.finmid.com/capital/api/csp-documents/list-csp-financial-documents.md): Upload and manage CSP financial documents for merchants.
- [Upload CSP Financial Document](https://docs.finmid.com/capital/api/csp-documents/upload-csp-financial-document.md): Upload and manage CSP financial documents for merchants.
- [Get Document Download URL](https://docs.finmid.com/capital/api/documents/get-document-download-url.md): List and download credit-related documents.
- [List Funding Documents](https://docs.finmid.com/capital/api/documents/list-funding-documents.md): List and download credit-related documents.
- [Get Funding Applications](https://docs.finmid.com/capital/api/funding-applications/get-funding-applications.md): Retrieve funding application status for merchants.
- [Get Funding payments](https://docs.finmid.com/capital/api/fundings/get-funding-payments.md): Retrieve fundings and their payment schedules.
- [Get Fundings](https://docs.finmid.com/capital/api/fundings/get-fundings.md): Retrieve fundings and their payment schedules.
- [Receive Incoming Webhook](https://docs.finmid.com/capital/api/incoming-webhooks/receive-incoming-webhook.md): Receive incoming webhook notifications.
- [Receive Payout Outcome](https://docs.finmid.com/capital/api/incoming-webhooks/receive-payout-outcome.md): Receive incoming webhook notifications.
- [Get Capital Max State](https://docs.finmid.com/capital/api/max/get-capital-max-state.md): Retrieve Capital Max details for merchants.
- [Create Signature Link](https://docs.finmid.com/capital/api/offers/create-signature-link.md): Retrieve financing offers for merchants.
- [Get Active Offer Group](https://docs.finmid.com/capital/api/offers/get-active-offer-group.md): Retrieve financing offers for merchants.
- [Get current Offer](https://docs.finmid.com/capital/api/offers/get-current-offer.md): Retrieve financing offers for merchants.
- [Report Platform Check](https://docs.finmid.com/capital/api/offers/report-platform-check.md): Retrieve financing offers for merchants.
- [Execute Payment Transaction](https://docs.finmid.com/capital/api/payments/execute-payment-transaction.md): Retrieve and report payment batches.
- [Get Payment batch](https://docs.finmid.com/capital/api/payments/get-payment-batch.md): Retrieve and report payment batches.
- [Report Funds Collection](https://docs.finmid.com/capital/api/payments/report-funds-collection.md): Retrieve and report payment batches.
- [Report Payment](https://docs.finmid.com/capital/api/payments/report-payment.md): Retrieve and report payment batches.
- [Add Sales statements to a batch](https://docs.finmid.com/capital/api/sales-statements/add-sales-statements-to-a-batch.md): Report merchant sales when finmid calculates the flexible repayments, and get the amounts to withhold.
- [Get Sales statements of a batch](https://docs.finmid.com/capital/api/sales-statements/get-sales-statements-of-a-batch.md): Report merchant sales when finmid calculates the flexible repayments, and get the amounts to withhold.
- [Capital Max review outcome](https://docs.finmid.com/capital/api/simulation/capital-max-review-outcome.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding Application acceptance](https://docs.finmid.com/capital/api/simulation/funding-application-acceptance.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding Application cancellation](https://docs.finmid.com/capital/api/simulation/funding-application-cancellation.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding Application rejection](https://docs.finmid.com/capital/api/simulation/funding-application-rejection.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding creation](https://docs.finmid.com/capital/api/simulation/funding-creation.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding payout](https://docs.finmid.com/capital/api/simulation/funding-payout.md): Sandbox-only endpoints for simulating Capital API flows.
- [Funding rejection](https://docs.finmid.com/capital/api/simulation/funding-rejection.md): Sandbox-only endpoints for simulating Capital API flows.
- [Offer acceptance](https://docs.finmid.com/capital/api/simulation/offer-acceptance.md): Sandbox-only endpoints for simulating Capital API flows.
- [Offer creation](https://docs.finmid.com/capital/api/simulation/offer-creation.md): Sandbox-only endpoints for simulating Capital API flows.
- [Offer expiration](https://docs.finmid.com/capital/api/simulation/offer-expiration.md): Sandbox-only endpoints for simulating Capital API flows.
- [Overview](https://docs.finmid.com/capital/api/simulation/overview.md): Test your Capital integration in the sandbox: see the iframe, go through the full flow, and simulate the steps that finmid does.
- [Payment completion](https://docs.finmid.com/capital/api/simulation/payment-completion.md): Sandbox-only endpoints for simulating Capital API flows.
- [Payment failure](https://docs.finmid.com/capital/api/simulation/payment-failure.md): Sandbox-only endpoints for simulating Capital API flows.
- [Payment scheduling](https://docs.finmid.com/capital/api/simulation/payment-scheduling.md): Sandbox-only endpoints for simulating Capital API flows.
- [Sales statements batch payment](https://docs.finmid.com/capital/api/simulation/sales-statements-batch-payment.md): Sandbox-only endpoints for simulating Capital API flows.
- [Accepting offers](https://docs.finmid.com/capital/guides/accepting-offers.md): What happens when a merchant accepts an offer — signature, identity verification, and screening.
- [Beyond the first funding](https://docs.finmid.com/capital/guides/beyond-the-first-funding.md): What happens after a merchant completes their funding — renewals, refinancing, and novation.
- [Novation](https://docs.finmid.com/capital/guides/beyond-the-first-funding/novation.md): How an active funding moves to another merchant on your Platform: the receiving merchant accepts a dedicated offer and repays the balance.
- [Refinancing](https://docs.finmid.com/capital/guides/beyond-the-first-funding/refinancing.md): How merchants can access a new, larger funding before fully repaying the current one.
- [Renewals](https://docs.finmid.com/capital/guides/beyond-the-first-funding/renewals.md): How merchants become eligible for new funding offers after full repayment.
- [Fixed repayments](https://docs.finmid.com/capital/guides/collecting-repayments/fixed-repayments.md): How fixed repayments work — set amounts collected on a regular schedule regardless of sales volume.
- [Flexible repayments](https://docs.finmid.com/capital/guides/collecting-repayments/flexible-repayments.md): How flexible repayments work: a repayment percentage of the merchant's sales, collected until a fixed due date, and when it changes.
- [Collecting repayments](https://docs.finmid.com/capital/guides/collecting-repayments.md): How the funded amount is collected back — repayment types, collection methods, and your role in the process.
- [Displaying offers](https://docs.finmid.com/capital/guides/displaying-offers.md): Show funding offers to merchants using finmid's iframe or your own UI, with optional Capital Max.
- [Funding payouts](https://docs.finmid.com/capital/guides/funding-payouts.md): How funds are transferred to the merchant's bank account after screening approval.
- [How offers are created](https://docs.finmid.com/capital/guides/how-offers-are-created.md): How finmid evaluates merchants and creates personalized funding offers based on performance data.
- [Merchant communications](https://docs.finmid.com/capital/guides/merchant-communications.md): Which messages finmid sends your merchants, which webhooks tell you about the same moments, and where your Platform's messages fit in.
- [Onboarding anonymous merchants](https://docs.finmid.com/capital/guides/onboarding-anonymous-businesses.md): Tell finmid about the merchants on your Platform so they can become eligible for funding.
- [Overview and walkthrough](https://docs.finmid.com/capital/guides/overview.md): End-to-end overview of finmid Capital — from merchant onboarding to funding, collections, and renewals.
- [Sharing performance data](https://docs.finmid.com/capital/guides/sharing-performance-data.md): Send historical and ongoing merchant activity data so finmid can assess eligibility and create funding offers.
- [Funding Application Webhooks](https://docs.finmid.com/capital/webhooks/funding-application.md): Webhook events for the Capital funding application, from its creation at offer acceptance to its approval, rejection, or cancellation.
- [Funding Webhooks](https://docs.finmid.com/capital/webhooks/funding.md): Webhook events for the Capital funding lifecycle including creation, payout, rejection, refinancing, and collection.
- [KYB Webhooks](https://docs.finmid.com/capital/webhooks/kyb.md): Webhook event for KYB data consent granted by a merchant.
- [Offer Webhooks](https://docs.finmid.com/capital/webhooks/offers.md): Webhook events for Capital offer creation, opening, acceptance, expiration, and withdrawal.
- [Webhooks Overview](https://docs.finmid.com/capital/webhooks/overview.md): Setup, authentication, payload verification, and a complete catalog of Capital webhook event types.
- [Payment Webhooks](https://docs.finmid.com/capital/webhooks/payment.md): Webhook events for Capital payment creation, scheduling, completion, failure, and cancellation.

## Tools

- [CLI](https://docs.finmid.com/getting-started/cli.md): Install and use the finmid CLI (f4d) to interact with the API from your terminal.

## Infrastructure

- [Amazon Route 53 Setup](https://docs.finmid.com/infrastructure/amazon-route53.md): Step-by-step domain delegation setup using Amazon Route 53 as the domain registrar.
- [Domain Delegation](https://docs.finmid.com/infrastructure/domain-delegation.md): Delegate a domain or subdomain to finmid for white-label email notifications.
- [GoDaddy Setup](https://docs.finmid.com/infrastructure/godaddy.md): Step-by-step domain delegation setup using GoDaddy as the domain registrar.