Update a Payee's Address
curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": false,
"country": "<string>"
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_id}"
payload = {
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": False,
"country": "<string>"
}
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({
label: '<string>',
address_type: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
phone: '<string>',
doc_number: '<string>',
doc_type: '<string>',
doc_issue_country: '<string>',
doc_issue_date: '<string>',
doc_due_date: '<string>',
doc_issuer: '<string>',
is_default: false,
country: '<string>'
})
};
fetch('https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_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/addresses/{payee_id}/{address_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([
'label' => '<string>',
'address_type' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'phone' => '<string>',
'doc_number' => '<string>',
'doc_type' => '<string>',
'doc_issue_country' => '<string>',
'doc_issue_date' => '<string>',
'doc_due_date' => '<string>',
'doc_issuer' => '<string>',
'is_default' => false,
'country' => '<string>'
]),
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/addresses/{payee_id}/{address_id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\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/addresses/{payee_id}/{address_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_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 \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status_code": 123,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"query_generated_time": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update a Payee's Address
Change an address. Send only the fields you want to update — the rest are kept.
PATCH
/
v1
/
platform
/
payees
/
addresses
/
{payee_id}
/
{address_id}
Update a Payee's Address
curl --request PATCH \
--url https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": false,
"country": "<string>"
}
'import requests
url = "https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_id}"
payload = {
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": False,
"country": "<string>"
}
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({
label: '<string>',
address_type: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
phone: '<string>',
doc_number: '<string>',
doc_type: '<string>',
doc_issue_country: '<string>',
doc_issue_date: '<string>',
doc_due_date: '<string>',
doc_issuer: '<string>',
is_default: false,
country: '<string>'
})
};
fetch('https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_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/addresses/{payee_id}/{address_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([
'label' => '<string>',
'address_type' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'phone' => '<string>',
'doc_number' => '<string>',
'doc_type' => '<string>',
'doc_issue_country' => '<string>',
'doc_issue_date' => '<string>',
'doc_due_date' => '<string>',
'doc_issuer' => '<string>',
'is_default' => false,
'country' => '<string>'
]),
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/addresses/{payee_id}/{address_id}"
payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\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/addresses/{payee_id}/{address_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.finogates.com/v1/platform/payees/addresses/{payee_id}/{address_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 \"label\": \"<string>\",\n \"address_type\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"phone\": \"<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 \"is_default\": false,\n \"country\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status_code": 123,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"label": "<string>",
"address_type": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"phone": "<string>",
"doc_number": "<string>",
"doc_type": "<string>",
"doc_issue_country": "<string>",
"doc_issue_date": "<string>",
"doc_due_date": "<string>",
"doc_issuer": "<string>",
"is_default": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"query_generated_time": 123
}{
"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 this payee. Omit to look the payee up by its ID within your tenant.
Example:
"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"
Body
application/json
Update a payee address (PATCH — only provided fields change).
The service applies model_dump(exclude_unset=True) so an omitted field
is left untouched (including is_default, which carries a default here).
Maximum string length:
120Maximum string length:
30Maximum string length:
255Maximum string length:
255Maximum string length:
120Maximum string length:
120Maximum string length:
20Maximum string length:
40Maximum string length:
100Maximum string length:
50Maximum string length:
10Maximum string length:
20Maximum string length:
20Maximum string length:
255
