Monime Documentation

{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "source": {
        "financialAccountId": null,
        "transactionReference": null
    },
    "destination": {
        "providerCode": null,
        "accountId": null,
        "transactionReference": null
    },
    "charges": [],
    "delayedReason": null,
    "failureDetail": {
        "code": "unknown",
        "explanation": null
    },
    "createTime": null,
    "metadata": null
}

Properties

string

The unique identifier for the payout object

enum<string>

The status of the payout object.Available options: pending processing delayed completed failed

object

The monetary amount to payout to the destination

Show properties

string

The 3-letter ISO currency code.

integer

The value representation in the currency’s minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.

object

The source of fund for the payout object.

Show properties

string

The ID of the financial account where the amount was disbursed from.’

string

The Monime transaction reference for describing the debiting of the amount and charges from the financial account.

object

The destination for the fund of the payout object.

Show properties

string

The code for the provider as identified by Monime.

string

The account ID of the account in the provider’s ecosystem that the payout amount was disbursed to.

string

The transaction reference from the provider’s ecosystem after the amount was disbursed.

array

The charges that applied to the payout.

string

The reason when the payout is being delayed.

object

The detail for the failed status.

Show properties

enum<string>

The failure code.Available options: unknown expired providerUnknown fundInsufficient authorizationFailed providerAccountBlocked providerAccountMissing providerAccountQuotaExhausted

string

An explanation of the failure code.

string

The creation time of the payout object.

object

This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Object Model