Receive Payout Outcome

⚠️

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The idempotency_key that finmid sent in the original Execute Payment Transaction request.
Used to correlate this confirmation with the original payout instruction.

string
required

The business_id that finmid sent in the original Execute Payment Transaction request.
Echoed back to allow finmid to correlate the confirmation with the business.

string
enum
required

Outcome of the payout execution:

  • SETTLED: the payment was successfully deposited into the beneficiary's bank account.
  • FAILED: the payment could not be completed.
Allowed:
date-time | null

Timestamp when the payment was settled (ISO 8601 datetime). Required when type is SETTLED, null otherwise.

string | null

Reason for the failure. Required when type is FAILED, null otherwise.

Responses
200

Payout confirmation received successfully. Returned both for the first successful processing
and for any subsequent retransmission of the same (finmid_idempotency_key, type) pair.

401

Missing or invalid API key. Could not authenticate API request.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json