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 platform provides its own capital to businesses while finmid provides the infrastructure (e.g. underwriting model). After reporting collections via Report Payment API or Add Sales Statements API, the platform collects the funds from businesses and then calls this endpoint to confirm the collection.
The batch_id must match a batch previously used in Report Payment API or Add Sales Statements API. The amount and currency should correspond to the total collected for that batch (excluding the platform commission).
Integration models
There are two integration models for handling collections:
- Platform-funded: The platform provides its own capital. After collecting from businesses, use this endpoint to report the collection to finmid.
- finmid-funded: finmid provides the capital. After collecting from businesses, the platform sends the funds to finmid's bank account via bank transfer (simulated via Sales statements batch payment API in sandbox).
Typical flow (platform-funded)
- Report collections using Report Payment API or Add Sales Statements API, grouped by
batch_id. - Optionally retrieve aggregated batch data using Get Payment Batch API or Get Sales Statements API.
- Collect the funds from your businesses.
- Call this endpoint to confirm the collection to finmid (using
batch_idandpayment_amountfrom 2nd step, withoutplatform_commission_amount).
