Update a Payee
curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/payees/{payee_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"maiden_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"state": "<string>",
"city": "<string>",
"street": "<string>",
"postal_code": "<string>",
"business_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"metadata": {}
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
payload = {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"maiden_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"state": "<string>",
"city": "<string>",
"street": "<string>",
"postal_code": "<string>",
"business_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
maiden_name: '<string>',
date_of_birth: '<string>',
nationality: '<string>',
gender: '<string>',
doc_number: '<string>',
doc_type: '<string>',
doc_issue_country: '<string>',
doc_issue_date: '<string>',
doc_due_date: '<string>',
doc_issuer: '<string>',
state: '<string>',
city: '<string>',
street: '<string>',
postal_code: '<string>',
business_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
metadata: {}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'maiden_name' => '<string>',
'date_of_birth' => '<string>',
'nationality' => '<string>',
'gender' => '<string>',
'doc_number' => '<string>',
'doc_type' => '<string>',
'doc_issue_country' => '<string>',
'doc_issue_date' => '<string>',
'doc_due_date' => '<string>',
'doc_issuer' => '<string>',
'state' => '<string>',
'city' => '<string>',
'street' => '<string>',
'postal_code' => '<string>',
'business_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}"
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": "billing@acme-supplier.com",
"phone": "+14155550199",
"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-12T11:02:17.000Z"
},
"query_generated_time": 1712847600000
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update Payee
Change the details of an existing payee.
PATCH
/
v1
/
platform
/
payees
/
{payee_id}
Update a Payee
curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/payees/{payee_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"maiden_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"state": "<string>",
"city": "<string>",
"street": "<string>",
"postal_code": "<string>",
"business_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"metadata": {}
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
payload = {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"maiden_name": "<string>",
"date_of_birth": "<string>",
"nationality": "<string>",
"gender": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"state": "<string>",
"city": "<string>",
"street": "<string>",
"postal_code": "<string>",
"business_name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
maiden_name: '<string>',
date_of_birth: '<string>',
nationality: '<string>',
gender: '<string>',
doc_number: '<string>',
doc_type: '<string>',
doc_issue_country: '<string>',
doc_issue_date: '<string>',
doc_due_date: '<string>',
doc_issuer: '<string>',
state: '<string>',
city: '<string>',
street: '<string>',
postal_code: '<string>',
business_name: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
metadata: {}
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'maiden_name' => '<string>',
'date_of_birth' => '<string>',
'nationality' => '<string>',
'gender' => '<string>',
'doc_number' => '<string>',
'doc_type' => '<string>',
'doc_issue_country' => '<string>',
'doc_issue_date' => '<string>',
'doc_due_date' => '<string>',
'doc_issuer' => '<string>',
'state' => '<string>',
'city' => '<string>',
'street' => '<string>',
'postal_code' => '<string>',
'business_name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-sandbox.finogates.com/v1/platform/payees/{payee_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}")
.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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"maiden_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality\": \"<string>\",\n \"gender\": \"<string>\",\n \"doc_number\": \"<string>\",\n \"doc_type\": \"<string>\",\n \"doc_issue_country\": \"<string>\",\n \"doc_issue_date\": \"<string>\",\n \"doc_due_date\": \"<string>\",\n \"doc_issuer\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"street\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"business_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"metadata\": {}\n}"
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": "billing@acme-supplier.com",
"phone": "+14155550199",
"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-12T11:02:17.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"
Body
application/json
Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
20Maximum string length:
10Maximum string length:
1Maximum string length:
100Maximum string length:
50Maximum string length:
10Maximum string length:
20Maximum string length:
20Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
500Recipient's ZIP / postal code. Required by some payout corridors (e.g. US) — the payout is rejected without it.
Maximum string length:
20Maximum string length:
255Maximum string length:
40
