Get Payout

GET /payouts/{id}

Try it

Get Payout

cURL

curl --request GET \
  --url https://api.monime.io/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'

200

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "source": {
      "financialAccountId": "<string>",
      "transactionReference": "<string>"
    },
    "destination": {
      "providerCode": "<string>",
      "accountId": "<string>",
      "transactionReference": "<string>"
    },
    "charges": [
      {
        "name": "<string>",
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "metadata": {}
      }
    ],
    "delayedReason": "<string>",
    "failureDetail": {
      "code": "unknown",
      "explanation": "<string>"
    },
    "createTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

Authorization · string · header · required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Space-Id · string · required

The value is the tenancy parameter that Monime used to determine which space the request is intended for. The value is the tenancy parameter that Monime used to determine which space the request is intended for.

Maximum string length: 100

Path Parameters

id · string · required

The ID for the payout object to retrieve The ID for the payout object to retrieve

Response

200 - application/json

OK

success · boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

messages · any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result · object

Show child attributes

result. id · string

The unique identifier for the payout object

result. status · enum<string>

The status of the payout object.

Available options: pending, processing, delayed, completed, failed

result. amount · object

The monetary amount to payout to the destination

Show child attributes

result.amount. currency · string

The 3-letter ISO currency code.

result.amount. value · 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.

result. source · object

The source of fund for the payout object.

Show child attributes

result.source. financialAccountId · string | null

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

result.source. transactionReference · string | null

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

result. destination · object

The destination for the fund of the payout object.

Show child attributes

result.destination. providerCode · string | null

The code for the provider as identified by Monime.

result.destination. accountId · string

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

result.destination. transactionReference · string | null

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

result. charges · object[] | null

The charges that applied to the payout.

Show child attributes

result.charges. name · string

The name of the charge object within Monime.

result.charges. amount · object

The amount of the charge that was applied on top of the payout amount.

Show child attributes

result.charges.amount. currency · string

The 3-letter ISO currency code.

result.charges.amount. value · 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.

result.charges. metadata · object

Further metadata describing the charge object.

result. delayedReason · string | null

The reason when the payout is being delayed.

result. failureDetail · object

The detail for the failed status.

Show child attributes

result.failureDetail. code · enum<string>

The failure code.

Available options: unknown, expired, providerUnknown, fundInsufficient, authorizationFailed, providerAccountBlocked, providerAccountMissing, providerAccountQuotaExhausted

result.failureDetail. explanation · string

An explanation of the failure code.

result. createTime · string<date-time>

The creation time of the payout object.

result. metadata · 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.