Get One Payee
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payees/{payee_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
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/{payee_id}', 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/{payee_id}",
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/{payee_id}"
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/{payee_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}")
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",
"is_business": false,
"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",
"destinations": [
{
"id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
"payee_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"method_type": "bank",
"rail_code": "ach",
"currency": "USD",
"status": 1,
"nickname": "Operating account",
"bank_name": "Example Bank",
"account_mask": "******6789",
"routing_last4": "0021",
"account_type": "checking",
"country": "US",
"created_at": "2025-06-10T18:12:00.000Z",
"updated_at": "2025-06-10T18:12:00.000Z"
}
]
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get Payee
Get the full details of a single payee, looked up by their unique ID. You can also ask for the payee’s payout destinations to be included in the response.
GET
/
v1
/
platform
/
payees
/
{payee_id}
Get One Payee
curl --request GET \
--url https://api-sandbox.finogates.com/v1/platform/payees/{payee_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
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/{payee_id}', 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/{payee_id}",
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/{payee_id}"
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/{payee_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}")
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",
"is_business": false,
"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",
"destinations": [
{
"id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
"payee_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
"method_type": "bank",
"rail_code": "ach",
"currency": "USD",
"status": 1,
"nickname": "Operating account",
"bank_name": "Example Bank",
"account_mask": "******6789",
"routing_last4": "0021",
"account_type": "checking",
"country": "US",
"created_at": "2025-06-10T18:12:00.000Z",
"updated_at": "2025-06-10T18:12:00.000Z"
}
]
},
"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.
Path Parameters
Query Parameters
Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.
Example:
"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"
Set to true to also include the payee's payout destinations in the response.
Set to true to also include the payee's payout destinations in the response.
Response
The requested payee. The destinations array is included only when includeDestinations=true is passed.

