# finmid Documentation > finmid's Developer Portal ## Guides: Getting started - [finmid products](https://docs.finmid.com/docs/finmid-products.md): Welcome to finmid products introduction! Dive into our API documentation to embed lending services into your product! ## Guides: B2B Payments API - [Core concepts](https://docs.finmid.com/docs/b2b-payments-core-concepts.md) - [End-to-end process](https://docs.finmid.com/docs/end-to-end.md) - [Fees configuration](https://docs.finmid.com/docs/fees-config.md) - [Buyer/Seller onboarding flow](https://docs.finmid.com/docs/buyer-seller-onboarding.md) - [Payment flow](https://docs.finmid.com/docs/payment-flow.md) - [Capture flow](https://docs.finmid.com/docs/capture-flow.md) - [Webhooks](https://docs.finmid.com/docs/webhooks.md): Webhooks are used to notify your platform about events on finmid side. finmid sends these notifications to an endpoint hosted in your environment configured to receive and process them. - [Errors](https://docs.finmid.com/docs/b2b-payments-errors.md): B2B Payments API error codes and descriptions ## Guides: Capital API - [Offer sharing & acceptance](https://docs.finmid.com/docs/capital-offer-sharing-and-acceptance-1.md): This section explains how Platforms can retrieve detailed Offer information and communicate Offers to Businesses. It also highlights how Businesses can accept Offers through an embedded widget. - [Capital core concepts](https://docs.finmid.com/docs/capital-core-concepts.md) - [Overview of Capital integration](https://docs.finmid.com/docs/capital-end-to-end.md) - [Pre-approved Offer generation](https://docs.finmid.com/docs/capital-preapproved-offer-generation.md): We generate pre-approved customizable Offers with over 95% payout certainty in real-time, and communicate results to the Platforms via webhook. - [Offer sharing & acceptance](https://docs.finmid.com/docs/capital-offer-sharing-and-acceptance.md): This section explains how Platforms can retrieve detailed Offer information and communicate Offers to Businesses. It also highlights how Businesses can accept Offers through an embedded widget. - [Business onboarding & payout](https://docs.finmid.com/docs/capital-business-onboarding-and-payout.md) - [Renewals](https://docs.finmid.com/docs/capital-renewals.md) - [Business payments](https://docs.finmid.com/docs/capital-business-payments.md): This section outlines how Business Payments are calculated as a percentage of sales and facilitated through Platform-managed flows or direct debit by finmid. - [Webhooks](https://docs.finmid.com/docs/capital-webhooks.md): Webhooks are used to notify your platform about events on finmid side. finmid sends these notifications to an endpoint hosted in your environment configured to receive and process them. ## Guides: CAPITAL API - [Widget integration](https://docs.finmid.com/docs/capital-iframe.md): Capital API iframe widget integration ## Guides: Infrastructure - [Domain Delegation](https://docs.finmid.com/docs/domain-delegation.md) - [Setup with GoDaddy Domain Registrar](https://docs.finmid.com/docs/godaddy-domain-registrar.md) - [Setup with Amazon Domain Registrar](https://docs.finmid.com/docs/amazon-registrar.md) ## Guides: General - [API introduction](https://docs.finmid.com/docs/api-introduction.md) ## API Reference: General - [API introduction](https://docs.finmid.com/reference/api-introduction.md) ## API Reference: B2B Payments API - Buyer - [Create Buyer](https://docs.finmid.com/reference/create-buyer-v2.md): Let's create/onboard a new buyer. For this you'll need 2 things: 1. Create a new ID for this buyer (should map to your internal identifier) 2. The buyer's legal information. ⚠️ Note that one of… - [Get Buyer](https://docs.finmid.com/reference/get-buyer-v2.md): For getting a certain buyer's details, you'll only need the buyer's ID specified on creation. - [Update Buyer](https://docs.finmid.com/reference/update-buyer-v2.md): Update a buyer if certain data changes on your platform. For this you'll need: 1. The buyer's ID specified on creation 2. The data you want to change - [Get Buyer Limit](https://docs.finmid.com/reference/get-buyer-limit-v2.md): Get estimated buyer limit in a target currency. > 📘 > > Note: this limit is an estimate and subject to change depending on a specific payment request parameters. To verify if specific purchase can be… - [Get Buyers](https://docs.finmid.com/reference/get-buyers-for-platform.md): Returns a list of buyers. Cursor-based pagination is supported and you can make use of filter parameters to change sorting or limit the results to only buyers with certain status.. - Seller - [Create Seller](https://docs.finmid.com/reference/create-seller-v2.md): Let's create/onboard a new seller. For this you'll need 2 things: 1. Create a new ID for this seller (should map to your internal identifier) 2. The seller's legal information. ⚠️ Note that one of… - [Get Seller](https://docs.finmid.com/reference/get-seller-v2.md): For getting a certain seller's details, you'll only need the seller's ID specified on creation. - [Update Seller](https://docs.finmid.com/reference/update-seller-v2.md): Update a seller if certain data changes on your platform. For this you'll need: 1. The seller's ID specified on creation 2. The data you want to change - [Update Seller Bank Account](https://docs.finmid.com/reference/update-seller-bank-account-v2.md): Update a seller's bank account details. For this you'll need: 1. The seller's ID specified on creation 2. The new bank account details. Note: This currently is only supported for sellers with a… - [Get Sellers](https://docs.finmid.com/reference/get-sellers-for-platform.md): Returns a list of sellers. Cursor-based pagination is supported and you can make use of filter parameters to change sorting or limit the results to only sellers with certain status.. - Payment Request - [Create Payment Request](https://docs.finmid.com/reference/create-payment-request-v2.md): The create payment request resource endpoint creates a loan and reserves the specified order amount. This process is called authorisations. When you authorise, finmid will generate a unique id that… - [Update Payment Request](https://docs.finmid.com/reference/update-payment-request-v2.md): Allows for the updating of invoice number and invoice due date fields. Invoice number must be provided to execute a payout. - [Cancel Payment Request](https://docs.finmid.com/reference/cancel-payment-request-v2.md): Cancels an existing payment request and releases the loan amount reserved for the payment. For this you'll only need the payment request ID specified on creation. > 📘 > > This operation is only… - [Get Payment Requests](https://docs.finmid.com/reference/get-payment-requests-v2.md): Returns a list of payment requests. Cursor-based pagination is supported and you can make use of filter parameters to change sorting or limit the results to only payment requests with certain status. - [Get Payment Request](https://docs.finmid.com/reference/get-payment-request-v2.md): For getting a certain payment request's details, you'll only need the payment request's ID specified on creation. - [Create Payout](https://docs.finmid.com/reference/create-payment-request-payout.md): The payout payment request endpoint triggers a payment to the seller associated with the loan initially reserved during the creation of the payment request. As soon as a payout is created, the… - Tasks - [Upload payment documents](https://docs.finmid.com/reference/upload-payment-request-documents.md): Upload a list of documents for a task with entity type: `PAYMENT_REQUEST_TASK` the documents will then be used for the approval of payment request payouts during the spot checks process. Some… - [Get tasks](https://docs.finmid.com/reference/get-tasks.md): For getting the platform tasks, normally a task is created when there is a payment request that requires additional documents or when a buyer increase limit is requested. tasks are ordered by… - Simulation - [Simulate Buyer](https://docs.finmid.com/reference/simulate-buyer-v2.md): This endpoint allows you to simulate onboarding of buyers in the sandbox environment. After creation buyers have the status of `PENDING`. In a production environment finmid runs certain checks before… - [Simulate Seller](https://docs.finmid.com/reference/simulate-seller-v2.md): This endpoint allows you to simulate onboarding of sellers in the sandbox environment. After creation sellers have the status of `PENDING`. In a production environment finmid runs certain checks… - [Simulate Repayment](https://docs.finmid.com/reference/simulate-payment-request-repayment-v2.md): This endpoint simulates repayment of a payment request. The payment request status must be `PENDING_REPAYMENT`. > 🚧 > > **Only available in sandbox environment.** ## API Reference: CAPITAL API - Funding Application - [Get Funding Applications](https://docs.finmid.com/reference/get-funding-applications.md): This endpoint returns the Funding Applications for a Business, newest first (sorted by `submitted_at`). A Funding Application represents the intermediate step in the financing lifecycle: **Offer →… - Capital Max - [Get Capital Max State](https://docs.finmid.com/reference/get-capital-max.md): This endpoint returns the Capital Max state for a Business. Capital Max allows a business to request additional capital beyond their standard funding. The response includes Capital Max… - Business - [Create Business](https://docs.finmid.com/reference/create-business.md): In order to access pre-approved Offers for Businesses, Platforms must first share non-PI data. This data is used to generate Offers, confirm receiving bank accounts with Businesses, and support the… - [Get Business](https://docs.finmid.com/reference/get-business.md): This endpoint allows Platforms to detect what data has been shared up to the current time for any specific Business. - [Update Business non-PI Data](https://docs.finmid.com/reference/update-business-non-pi.md): Update non-personally identifiable data for an existing Business. This endpoint can be used only for Businesses non-PI data updates. After KYB data is shared for a business this API will return an… - [Submit Business performance data](https://docs.finmid.com/reference/submit-business-performance-data.md): In order to generate Offers, finmid requires that Platforms share non-PI data on key Business performance indicators (e.g., goods sold, number of transactions, ratings, refund count, etc.). This data… - [Submit Business's KYB data](https://docs.finmid.com/reference/add-business-kyb-data.md): When a Business has accepted their Offer, the Platform is authorized to share their PI data with finmid. This data is necessary for finmid's KYB checks, which are required before the payout of the… - [Upload KYB Document for a Business](https://docs.finmid.com/reference/create-kyb-business-document-upload.md): Create a document upload to provide Know Your Business (KYB) files for a business. This is a two-step flow: 1. **Create Upload** (this endpoint): Provide file metadata and receive a temporary… - CSP Financial Document - [Upload CSP Financial Document](https://docs.finmid.com/reference/create-csp-document-upload.md): Create a presigned upload URL for a CSP financial document. **Prerequisites:** The business must have an accepted CSP offer and an active CSP funding that has not been paid out yet. Document uploads… - [List CSP Financial Documents](https://docs.finmid.com/reference/list-csp-documents.md): Retrieve the latest CSP financial documents for a Business. Returns the list of uploaded documents along with the submission status. Once documents have been submitted via the finalize endpoint,… - [Delete CSP Financial Document](https://docs.finmid.com/reference/delete-csp-document.md): Delete a previously uploaded CSP financial document. A document can only be deleted before the submission has been finalized. Once the submission is finalized, documents can no longer be deleted. - [Finalize CSP Financial Documents Submission](https://docs.finmid.com/reference/finalize-csp-document-submission.md): Finalize the submission of CSP financial documents for a Business. Once finalized, no further documents can be uploaded or deleted for the current submission. At least one document must have been… - Document - [List Funding Documents](https://docs.finmid.com/reference/list-funding-documents.md): Retrieve a list of all documents associated with a specific funding. Documents can include invoices, terms and conditions, and capital summaries related to the funding. - [Get Document Download URL](https://docs.finmid.com/reference/get-document-url.md): Retrieve a pre-signed URL for downloading a specific document. The URL is temporary and will expire after the specified timestamp. - Onboarding - [Get latest onboarding status](https://docs.finmid.com/reference/get-latest-onboarding.md): This endpoint retrieves the latest onboarding status for a business. The onboarding process collects information from the business to generate offers in cases when platform doesn't have enough data… - Offer - [Get current Offer](https://docs.finmid.com/reference/get-current-offer-state.md): This endpoint is used to access the status of the current Offer or Funding, as well as the embedding link for the Capital iframe. Depending on the presence and status of the current Offer and… - [Get Active Offer Group](https://docs.finmid.com/reference/get-active-offer-group.md): This endpoint returns the currently active Offer Group for a Business that can be accepted. An Offer Group contains multiple offers of the same type from which the Business can choose exactly one to… - [Report Platform Check](https://docs.finmid.com/reference/report-platform-check.md): > ⚠️ This API is relevant only for platforms that provide their own capital to businesses. Reports the outcome of a check your platform runs on a Business before its Funding is paid out, for… - [Create Signature Link](https://docs.finmid.com/reference/create-signature-link.md): Returns a link that opens finmid's signature screen for one Offer. Use it when your platform shows the Offers in its own UI. The Business always accepts an Offer in finmid's iframe. With this link… - Funding - [Get Fundings](https://docs.finmid.com/reference/get-fundings-for-business.md): The endpoint provides information about the Funding of the Business. Depending on the presence and status of the current Funding, Platforms can communicate different details to the Business [in… - [Get Funding payments](https://docs.finmid.com/reference/get-payments-for-credit.md): Retrieve all payments for a specific Funding. See also: - [`payment.scheduled` webhook](./capital-webhooks#paymentscheduled) - [`payment.completed` webhook](./capital-webhooks#paymentcompleted) -… - Payment - [Get Payment batch](https://docs.finmid.com/reference/get-payment-batch.md): Retrieve aggregated payment information for a specific payment batch. For every batch, it is possible to request information about the total batch payment amount and platform commission amount, as… - [Report Payment](https://docs.finmid.com/reference/report-payment.md): Report a payment collection from a Business to finmid, grouped by a specific payment period, market, or another grouping. Use this endpoint when the platform calculates the collection amounts… - [Report Funds Collection](https://docs.finmid.com/reference/report-funds-collection.md): **Applicable only to platform-funded integrations.** Use this endpoint to notify finmid that you have collected funds from your businesses for a specific batch. In a platform-funded integration, the… - [Execute Payment Transaction](https://docs.finmid.com/reference/execute-payment-transaction.md): This API must be implemented by platforms that provide their own capital to businesses. > ⚠️ Note that this endpoint is **not hosted by finmid**. It is called by finmid to instruct the platform to… - Sales statements - [Get Sales statements of a batch](https://docs.finmid.com/reference/get-sales-statements.md): Retrieve aggregated sales statement information for a specific batch. For every batch, it is possible to request information about the total payment amount, platform commission amount, and the… - [Add Sales statements to a batch](https://docs.finmid.com/reference/add-sales-statements.md): Share Business's sales data with finmid so that finmid calculates the collection amounts for you. Once a Funding Offer has been accepted, payment amounts can be calculated and collected. The… - Simulation - [Funding creation](https://docs.finmid.com/reference/simulate-create-funding.md): This endpoint creates a Business, generates an Offer (flexible or fixed repayments) based on the provided terms, and accepts it. This allows you to immediately begin sharing revenue information… - [Funding payout](https://docs.finmid.com/reference/payout-credit.md): This endpoint simulates updating the KYB information and marking the funding as paid out. Endpoint can be used only for `PENDING` fundings without `paid_out_at` timestamp. In the live environment,… - [Funding rejection](https://docs.finmid.com/reference/reject-credit.md): This endpoint simulates updating the KYB information with rejection details and marking the funding as rejected. Endpoint can be used only for `PENDING` fundings without `paid_out_at` timestamp. In… - [Sales statements batch payment](https://docs.finmid.com/reference/simulate-batch-payment.md): **Applicable only to finmid-funded integrations.** Simulates a bank transfer payment for a batch in the sandbox environment. In a finmid-funded integration, after collecting funds from businesses,… - [Offer creation](https://docs.finmid.com/reference/simulate-create-offers.md): While finmid creates Offers after conducting a risk assessment in the live environment, this API can be used to simulate the Offer creation process for testing purposes. > 🚧 > > **Only available in… - [Offer acceptance](https://docs.finmid.com/reference/simulate-accept-offers.md): This API allows you to accept an active Offer on behalf of a Business. While a Business representative would typically accept an Offer through the UI, this API enables you to bypass the UI flow for… - [Offer expiration](https://docs.finmid.com/reference/simulate-expire-offers.md): This API allows you to expire an active Offer, simulating the scenario where a Business does not accept the Offer within a specified time frame. > 🚧 > > **Only available in sandbox environment.** - [Payment scheduling](https://docs.finmid.com/reference/schedule-payment.md): In the live environment, payments are being scheduled automatically to be debited from the Business bank account, when their `scheduled_at` time comes. To simulate a similar event in the sandbox… - [Payment completion](https://docs.finmid.com/reference/complete-payment.md): In the live environment, payments are being completed once the Business bank account is debited and the payment amount is reconciled. To simulate a similar event in the sandbox environment, and… - [Payment failure](https://docs.finmid.com/reference/fail-payment.md): In the live environment, payments can fail when debit of Business bank account has failed, e.g. due to insufficient balance. To simulate a similar event in the sandbox environment, and bring the… - [Funding Application acceptance](https://docs.finmid.com/reference/accept-funding-application.md): This endpoint simulates successful completion of the KYB process for the Funding Application. The application is approved and the Funding is created and paid out. In the live environment, this… - [Funding Application rejection](https://docs.finmid.com/reference/reject-funding-application.md): This endpoint simulates the KYB process failing for the Funding Application. The application is rejected and no Funding is created. In the live environment, this happens when the Business fails the… - [Funding Application cancellation](https://docs.finmid.com/reference/cancel-funding-application.md): This endpoint simulates cancellation of the Funding Application (e.g. on business request). Any running KYB process is stopped. In the live environment, this happens when the application process is… - [Capital Max review outcome](https://docs.finmid.com/reference/simulate-capital-max-review.md): This endpoint simulates the end of the Capital Max review for a Business, with the outcome you choose. It applies to a Business that has submitted a Capital Max request and whose review has started.… - Incoming Webhook - [Receive Incoming Webhook](https://docs.finmid.com/reference/receive-incoming-webhook.md): Endpoint for receiving incoming webhooks with generic data payloads. It acts as an initial integration point for early-stage data adoption. Once a data flow is standardized, it will be implemented as… - [Receive Payout Outcome](https://docs.finmid.com/reference/receive-payout-outcome.md): > ⚠️ This webhook is relevant only for platforms that provide their own capital to businesses. Webhook endpoint for receiving payout execution outcome from the platform. After finmid sends a…