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 payout instruction via Execute Payment Transaction, the platform must notify finmid of the outcome by calling this endpoint.
The platform sends a confirmation with either:
SETTLED: the payment was successfully deposited into the beneficiary's bank account, including the settlement timestamp.FAILED: the payment could not be completed, including the failure reason.
Correlation
The finmid_idempotency_key in the request body is the same idempotency_key that finmid provided in the original Execute Payment Transaction request. It is used to match this confirmation to the original payout instruction.
Idempotency
This endpoint is idempotent on the pair (finmid_idempotency_key, type).
Retransmitting the same confirmation (same key, same type) any number of times returns 200 and does not cause duplicate processing. Platforms can therefore safely retry on network failures, timeouts, or 5xx responses without special handling.
A 409 - CONFLICT is returned only when the platform sends an outcome (SETTLED or FAILED) that contradicts a terminal state already recorded for that finmid_idempotency_key — for example, SETTLED after finmid has already marked the payment as FAILED, or vice versa. 409 is therefore a state-conflict signal, not a duplicate-detection signal: it indicates a real divergence between the platform's view and finmid's view of the payment that requires investigation.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
200Payout confirmation received successfully. Returned both for the first successful processing
and for any subsequent retransmission of the same (finmid_idempotency_key, type) pair.
401Missing or invalid API key. Could not authenticate API request.
