Skip to main content
GET
/
v1
/
payouts
/
{id}
Get Payout
curl --request GET \
  --url https://api.monime.io/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "source": {
      "financialAccountId": "<string>",
      "transactionReference": "<string>"
    },
    "destination": {
      "type": "bank",
      "providerId": "slb001",
      "accountNumber": "<string>",
      "transactionReference": "<string>"
    },
    "fees": [
      {
        "code": "<string>",
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "metadata": {}
      }
    ],
    "failureDetail": {
      "code": "unknown",
      "message": "<string>"
    },
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "ownershipGraph": {
      "owner": {
        "id": "<string>",
        "type": "<string>",
        "metadata": {},
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": "<unknown>"
        }
      }
    },
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Monime-Version
enum<string> | null

Specifies which version of the Monime API will handle this request. Specifies which version of the Monime API will handle this request.

Available options:
caph.2025-08-23,
caph.2025-06-20
​
Monime-Space-Id
string
required

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

Maximum string length: 64

Path Parameters

​
id
string
required

Unique identifier of the payout to retrieve. Unique identifier of the payout 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
Payout · object

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.