Payout requests
List payout requests
Retrieve a paginated list of payout requests from all partners in your program
GET
/
v1
/
payout_requests
List payout requests
curl --request GET \
--url https://api.example.com/v1/payout_requestsimport requests
url = "https://api.example.com/v1/payout_requests"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/payout_requests', 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.example.com/v1/payout_requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/payout_requests"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/payout_requests")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payout_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 556,
"partner": "partner_456",
"status": "requested",
"amount": 50.0,
"amount_units": "usd",
"payout_gateway": "wise",
"created_by": "partner",
"created_at": "2026-09-29T11:02:10.000000Z",
"updated_at": "2026-09-29T11:02:10.000000Z"
},
{
"id": 555,
"partner": "partner_123",
"status": "approved",
"amount": 200.0,
"amount_units": "usd",
"payout_gateway": "paypal",
"created_by": "api",
"created_at": "2026-09-29T10:15:00.000000Z",
"updated_at": "2026-09-29T10:20:00.000000Z"
}
],
"links": {
"first": "https://api.partnero.com/v1/payout_requests?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/payout_requests",
"per_page": 10,
"to": 2
},
"status": 1
}
Endpoint
GET https://api.partnero.com/v1/payout_requests
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 10 | Number of results per page (10-100) |
page | integer | 1 | Page number for pagination |
sort | string | desc | Sort by creation date: desc (newest first) or asc |
Request
cURL
curl --location 'https://api.partnero.com/v1/payout_requests?limit=50' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'
Response
{
"data": [
{
"id": 556,
"partner": "partner_456",
"status": "requested",
"amount": 50.0,
"amount_units": "usd",
"payout_gateway": "wise",
"created_by": "partner",
"created_at": "2026-09-29T11:02:10.000000Z",
"updated_at": "2026-09-29T11:02:10.000000Z"
},
{
"id": 555,
"partner": "partner_123",
"status": "approved",
"amount": 200.0,
"amount_units": "usd",
"payout_gateway": "paypal",
"created_by": "api",
"created_at": "2026-09-29T10:15:00.000000Z",
"updated_at": "2026-09-29T10:20:00.000000Z"
}
],
"links": {
"first": "https://api.partnero.com/v1/payout_requests?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/payout_requests",
"per_page": 10,
"to": 2
},
"status": 1
}
Response fields
Payout requests — data[]
Payout requests — data[]
| Field | Type | Description |
|---|---|---|
id | integer | Payout request ID |
partner | string | Partner ID |
status | string | Current status |
amount | number | Payout amount |
amount_units | string | Payout currency, in lowercase |
payout_gateway | string | paypal, wise, crypto or venmo |
created_by | string | Where the request came from (api, partner, automated_partner_payouts and so on) |
created_at | string | ISO 8601 timestamp |
updated_at | string | ISO 8601 timestamp |
Pagination — links, meta
Pagination — links, meta
| Field | Type | Description |
|---|---|---|
links.first | string | URL to the first page |
links.last | string|null | Always null (no total count) |
links.prev | string|null | URL to the previous page |
links.next | string|null | URL to the next page |
meta.current_page | integer | Current page number |
meta.from | integer | First item number on this page |
meta.per_page | integer | Items per page |
meta.to | integer | Last item number on this page |
meta.path | string | Base URL for the endpoint |
Search payout requests
Use the search endpoint to filter payout requests by partner, status or currency:GET https://api.partnero.com/v1/payout_requests:search
limit, page and sort parameters as the list endpoint, plus these filters. When you combine filters, only payout requests matching all of them are returned.
| Parameter | Type | Description |
|---|---|---|
partner_id | string | Partner ID |
partner_key | string | Any referral key belonging to the partner |
partner_email | string | Partner’s email address |
status | string | One of the status values |
amount_units | string | Currency code (case-insensitive) |
curl --location 'https://api.partnero.com/v1/payout_requests:search?partner_id=partner_123&status=requested' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'
curl --location 'https://api.partnero.com/v1/payout_requests:[email protected]&amount_units=usd' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'
Error responses
| Status | Error | Solution |
|---|---|---|
| 422 | Validation error | Check limit (10-100), sort (asc or desc) and that status is a valid status value |
⌘I
List payout requests
curl --request GET \
--url https://api.example.com/v1/payout_requestsimport requests
url = "https://api.example.com/v1/payout_requests"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/payout_requests', 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.example.com/v1/payout_requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/payout_requests"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/payout_requests")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payout_requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 556,
"partner": "partner_456",
"status": "requested",
"amount": 50.0,
"amount_units": "usd",
"payout_gateway": "wise",
"created_by": "partner",
"created_at": "2026-09-29T11:02:10.000000Z",
"updated_at": "2026-09-29T11:02:10.000000Z"
},
{
"id": 555,
"partner": "partner_123",
"status": "approved",
"amount": 200.0,
"amount_units": "usd",
"payout_gateway": "paypal",
"created_by": "api",
"created_at": "2026-09-29T10:15:00.000000Z",
"updated_at": "2026-09-29T10:20:00.000000Z"
}
],
"links": {
"first": "https://api.partnero.com/v1/payout_requests?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/payout_requests",
"per_page": 10,
"to": 2
},
"status": 1
}
