Report Payment

Report Payment to finmid for a Business in a specific payment period, market or another grouping.

You can use this endpoint to notify finmid about Payments from Business. The currently active Funding for the Business will be automatically identified by finmid. Payments are grouped into batches representing payment periods, with the batch_id in the path serving as a payment reference.

The payment_id in the path serves as a unique identifier for this payment report and acts as an idempotency key to prevent duplicate submissions.

After reporting payments, you can retrieve the aggregated results for a batch using the Get Payment batch endpoint.

Appending Payments to a Batch

This API supports multiple submissions for the same batch_id. When you call this endpoint multiple times with the same batch_id, the reported payment amounts are appended to the existing batch, not replaced.

Similarly, if you report multiple payments for the same Business within a batch, all reported amounts will be appended and accumulated for that Business's active Funding.

📘

Example: Incremental Payment Reporting

First API call (batch_id: W4-2020-01, payment_id: report-1):

JSON

{
  "business_id": "business-123",
  "payment_amount": 1000.00,
  "reported_at": "2020-02-10T10:00:00.000Z"
}

Second API call (batch_id: W4-2020-01, payment_id: report-2):

JSON

{
  "business_id": "business-123",
  "payment_amount": 500.00,
  "reported_at": "2020-02-10T14:00:00.000Z"
}

Third API call (batch_id: W4-2020-01, payment_id: report-3):

JSON

{
  "business_id": "business-456",
  "payment_amount": 800.00,
  "reported_at": "2020-02-10T16:00:00.000Z"
}

Result: Batch W4-2020-01 now contains:

• business-123: 1500.00 (1000.00 + 500.00)
• business-456: 800.00