Payout
Create Payout
Creates a new payout with a specified amount, destination, and optional source account.
/v1/payoutsAuthorization
Headers
This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.
length <= 64Specifies which version of the Monime API will handle this request.
The value is the tenancy parameter that Monime uses to determine which space the request is intended for.
^spc-.*$length <= 64Body
application/jsonThe amount to be paid out to the destination account.
Information about the destination account that will receive the payout.
Optional details of the source account to be debited. If omitted, the default 'main' account is used.
Optional metadata to associate additional business context with the payout.
properties <= 64Response
200 - application/jsonOK
Represents the status of the query operation, confirming if it was successful. This field is always true
Contains a list of messages providing relevant information or feedback related to the query or operation
A Payout is a disbursement of funds from a Financial Account to a designated destination such as a Bank Account or Mobile Money Wallet.
It represents outbound money flows and is commonly used for salary disbursements, vendor payments, and refunds in automated workflows.
Each payout records the amount, the source account, the destination details, and optional metadata.
It also tracks status changes throughout its lifecycle and may include provider-specific references for reconciliation.