curl --request PATCH \
--url https://api.paywint.com/api/platform/address/update-payee-address/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States"
}
'import requests
url = "https://api.paywint.com/api/platform/address/update-payee-address/{user_id}"
payload = {
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States"
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
address_id: 'a1b2c3d4-****-****-****-e5f6g7h8i9j0',
name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
address_line_2: '123 Main Street, Apt 4B',
company_name: 'Meta Corp',
city: 'New York',
state: 'NY',
zipcode: '10001',
country: 'United States'
})
};
fetch('https://api.paywint.com/api/platform/address/update-payee-address/{user_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.paywint.com/api/platform/address/update-payee-address/{user_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([
'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
'address_id' => 'a1b2c3d4-****-****-****-e5f6g7h8i9j0',
'name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'address_line_2' => '123 Main Street, Apt 4B',
'company_name' => 'Meta Corp',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001',
'country' => 'United States'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/address/update-payee-address/{user_id}"
payload := strings.NewReader("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/address/update-payee-address/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/address/update-payee-address/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"fist_name": "John",
"last_name": "Doe",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"is_default": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update Payee Address
curl --request PATCH \
--url https://api.paywint.com/api/platform/address/update-payee-address/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States"
}
'import requests
url = "https://api.paywint.com/api/platform/address/update-payee-address/{user_id}"
payload = {
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States"
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
address_id: 'a1b2c3d4-****-****-****-e5f6g7h8i9j0',
name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
address_line_2: '123 Main Street, Apt 4B',
company_name: 'Meta Corp',
city: 'New York',
state: 'NY',
zipcode: '10001',
country: 'United States'
})
};
fetch('https://api.paywint.com/api/platform/address/update-payee-address/{user_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.paywint.com/api/platform/address/update-payee-address/{user_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([
'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
'address_id' => 'a1b2c3d4-****-****-****-e5f6g7h8i9j0',
'name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'address_line_2' => '123 Main Street, Apt 4B',
'company_name' => 'Meta Corp',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001',
'country' => 'United States'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Platform-ID: <x-platform-id>",
"X-Signature: <x-signature>"
],
]);
$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.paywint.com/api/platform/address/update-payee-address/{user_id}"
payload := strings.NewReader("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Platform-ID", "<x-platform-id>")
req.Header.Add("X-Signature", "<x-signature>")
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.paywint.com/api/platform/address/update-payee-address/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/address/update-payee-address/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"address_id\": \"a1b2c3d4-****-****-****-e5f6g7h8i9j0\",\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\",\n \"country\": \"United States\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"fist_name": "John",
"last_name": "Doe",
"address_line_1": "123 Main Street, Apt 4B",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"is_default": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.
HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.
Path Parameters
Unique identifier (UUID) of the user
Body
Unique identifier (UUID) of the payee for whom this address is being created.
"f47ac10b-****-****-****-0e02b2c3d479"
Unique identifier (UUID) of the payee's address record.
"a1b2c3d4-****-****-****-e5f6g7h8i9j0"
Recipient's first name.
2 - 100"John"
Recipient's last name (optional).
100"Smith"
Street address including apartment, suite, or unit number.
100"123 Main Street, Apt 4B"
Street address including apartment, suite, or unit number.
100"123 Main Street, Apt 4B"
Full name of the payee's company.
100"Meta Corp"
City name.
40"New York"
State, province, or region.
30"NY"
Postal code or ZIP code.
10"10001"
Country name.
40"United States"
Response
Successful Response
Indicates whether the request was processed successfully.
true
A short, human-readable message describing the result of the request.
"Operation completed."
The main response payload, if applicable
Show child attributes
Show child attributes
The Unix timestamp (in seconds) indicating when the response was generated.
1718006400

