Skip to main content
GET
/
payouts
List Payouts
curl --request GET \
  --url https://api.monime.io/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "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": {}
    }
  ],
  "pagination": {
    "count": 1,
    "total": 1,
    "next": "<string>"
  }
}

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.

Maximum length: 100

Query Parameters

​
after
string | null

This identifier retrieves the next items in the total result list that come just after it. Use it to get items that follows the object having this identifier in the overall list. This takes precedence over 'before'.

Maximum length: 100
​
before
string | null

This identifier retrieves the next items in the total result list that comes just before it. Use it to get items that precede the object having this identifier in the overall list.

Maximum length: 100
​
limit
integer
default:10

The maximum number of items per page that should be retrieved from the result list.

Required range: 1 <= x <= 50

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[] | null

The list of items in the response

​
pagination
object

The pagination info associated with the response