curl --request PATCH \
--url https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001"
}
'import requests
url = "https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_id}"
payload = {
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001"
}
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({
name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
city: 'New York',
state: 'NY',
zipcode: '10001'
})
};
fetch('https://api.paywint.com/api/platform/cross-border/payee/address/{user_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.paywint.com/api/platform/cross-border/payee/address/{user_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([
'name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001'
]),
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/cross-border/payee/address/{user_id}/{address_id}"
payload := strings.NewReader("{\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\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/cross-border/payee/address/{user_id}/{address_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_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 \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Edit a Payee Address
Edits a cross-border payee address.
Send only the address fields to change — recipient name, address line, city, state or zipcode. Each
field only accepts values within the maximum length allowed by the payee rules for the destination
country — see GET /cross-border/payee-rules. The country cannot be changed (it is fixed when the
address is created). Returns the updated address.
curl --request PATCH \
--url https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001"
}
'import requests
url = "https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_id}"
payload = {
"name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001"
}
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({
name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
city: 'New York',
state: 'NY',
zipcode: '10001'
})
};
fetch('https://api.paywint.com/api/platform/cross-border/payee/address/{user_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.paywint.com/api/platform/cross-border/payee/address/{user_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([
'name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001'
]),
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/cross-border/payee/address/{user_id}/{address_id}"
payload := strings.NewReader("{\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\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/cross-border/payee/address/{user_id}/{address_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/cross-border/payee/address/{user_id}/{address_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 \"name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_line_1\": \"123 Main Street, Apt 4B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10001\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"address_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"zipcode": "<string>",
"country": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"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 platform user.
Unique identifier (UUID) of the cross-border address.
Body
Cross-border payee address edit — the recipient/address fields are replaced.
Deliberately excludes country (it is fixed at creation and stays the same on an edit) and the
payee identity (an address cannot be re-pointed to another payee). Every field is required on an
edit: the full recipient/address must be supplied, and blank/whitespace-only values are rejected.
Recipient's first name.
2 - 100"John"
Recipient's last name.
1 - 100"Smith"
Street address including apartment, suite, or unit number.
1 - 100"123 Main Street, Apt 4B"
City name.
1 - 40"New York"
State, province, or region.
1 - 30"NY"
Postal code or ZIP code.
1 - 10"10001"
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

