curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/payees', 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-sandbox.finogates.com/v1/platform/payees",
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>"
],
]);
$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-sandbox.finogates.com/v1/platform/payees"
req, _ := http.NewRequest("GET", url, nil)
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-sandbox.finogates.com/v1/platform/payees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": [
{
"id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"display_name": "Acme Supplier",
"first_name": "Acme",
"last_name": "Supplier",
"email": "payments@acme-supplier.com",
"phone": "+14155550123",
"status": "active",
"is_active": true,
"owner_user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"created_at": "2025-06-10T18:10:42.000Z",
"updated_at": "2025-06-10T18:10:42.000Z"
},
{
"id": "a7b8c9d0-e1f2-3456-7890-abcdef012345",
"display_name": "Jane Smith",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"status": "active",
"is_active": true,
"owner_user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"created_at": "2025-06-09T09:21:05.000Z",
"updated_at": "2025-06-09T09:21:05.000Z"
}
],
"row_count": 2,
"limit": 50,
"current_page": 1,
"total_page_number": 1,
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}List Payees
Get the list of payees (people or businesses that money can be sent to) belonging to one of your users.
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payees \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.finogates.com/v1/platform/payees', 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-sandbox.finogates.com/v1/platform/payees",
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>"
],
]);
$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-sandbox.finogates.com/v1/platform/payees"
req, _ := http.NewRequest("GET", url, nil)
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-sandbox.finogates.com/v1/platform/payees")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"data": [
{
"id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"display_name": "Acme Supplier",
"first_name": "Acme",
"last_name": "Supplier",
"email": "payments@acme-supplier.com",
"phone": "+14155550123",
"status": "active",
"is_active": true,
"owner_user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"created_at": "2025-06-10T18:10:42.000Z",
"updated_at": "2025-06-10T18:10:42.000Z"
},
{
"id": "a7b8c9d0-e1f2-3456-7890-abcdef012345",
"display_name": "Jane Smith",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"status": "active",
"is_active": true,
"owner_user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
"created_at": "2025-06-09T09:21:05.000Z",
"updated_at": "2025-06-09T09:21:05.000Z"
}
],
"row_count": 2,
"limit": 50,
"current_page": 1,
"total_page_number": 1,
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Optional. The unique ID of the user who owns these payees. Omit to list every payee in your tenant.
"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"
Show only payees in this state: active or archived. Omit to return all.
"active"
How many payees to return per page (1 to 200).
1 <= x <= 200How many payees to skip before this page starts.
x >= 0Response
A page of payees.
HTTP status code for the response.
Payload or error details.
Show child attributes
Show child attributes
UTC timestamp (milliseconds since epoch) when response was generated.
Total rows matching the request filters (not just this page).
x >= 0Page size used for this response. Null for cursor-paginated endpoints.
x >= 11-indexed page number for this response. Null for cursor-paginated endpoints.
x >= 1Total number of pages given the current limit. Null for cursor-paginated endpoints.
x >= 0Cursor for the next page, if available.

