Skip to main content
GET
/
v1
/
payouts
List Payouts
curl --request GET \
  --url https://api.monime.io/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'
import requests

url = "https://api.monime.io/v1/payouts"

headers = {
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'Monime-Space-Id': '<monime-space-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.monime.io/v1/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/payouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.monime.io/v1/payouts")
  .header("Monime-Space-Id", "<monime-space-id>")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": [
    {
      "id": "<string>",
      "amount": {
        "currency": "<string>",
        "value": 123
      },
      "source": {
        "financialAccountId": "<string>",
        "transactionReference": "<string>"
      },
      "destination": {
        "type": "bank",
        "accountNumber": "<string>",
        "transactionReference": "<string>"
      },
      "fees": [
        {
          "code": "<string>",
          "amount": {
            "currency": "<string>",
            "value": 123
          },
          "metadata": {}
        }
      ],
      "failureDetail": {
        "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": {}
    }
  ],
  "pagination": {
    "count": 123,
    "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 uses to determine which space the request is intended for.

Maximum string length: 64
Pattern: ^spc-.*$
​
Monime-Version
enum<string> | null

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

Available options:
caph.2025-08-23,
caph.2025-06-20

Query Parameters

​
status
enum<string> | null

Filter payouts by status:

  • 'pending': Awaiting processing
  • 'processing': Currently being processed
  • 'failed': Processing failed
  • 'completed': Successfully disbursed
Available options:
pending,
processing,
failed,
completed
​
sourceFinancialAccountId
string | null

Filter payouts by the originating financial account. Useful for scoping to a specific wallet or reserve account.

​
sourceTransactionReference
string | null

Reference for the batch or group of financial transactions triggered as part of a payout. Enables traceability across related entries.

​
destinationTransactionReference
string | null

Filter by the transaction reference assigned by the destination provider (e.g., a bank or wallet system). Useful for reconciliation with third-party systems.

​
limit
integer
default:10

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Required range: 1 <= x <= 50
​
after
string | null

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Maximum string length: 2000

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

The list of items in the response

​
pagination
object

The pagination info associated with the response