curl --request POST \
--url https://api.paywint.com/api/platform/check/add-address/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"name": "John Doe",
"address_line_2": "123 Market St, Suite 500"
}
'import requests
url = "https://api.paywint.com/api/platform/check/add-address/{user_id}"
payload = {
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"name": "John Doe",
"address_line_2": "123 Market St, Suite 500"
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
address_line_1: 'Building B, Floor 3',
city: 'San Francisco',
state: 'CA',
zipcode: '94103',
country: 'United States',
name: 'John Doe',
address_line_2: '123 Market St, Suite 500'
})
};
fetch('https://api.paywint.com/api/platform/check/add-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/check/add-address/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address_line_1' => 'Building B, Floor 3',
'city' => 'San Francisco',
'state' => 'CA',
'zipcode' => '94103',
'country' => 'United States',
'name' => 'John Doe',
'address_line_2' => '123 Market St, Suite 500'
]),
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/check/add-address/{user_id}"
payload := strings.NewReader("{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.paywint.com/api/platform/check/add-address/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/check/add-address/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"created_at": "2024-01-15T10:30:00Z",
"name": "John Smith",
"address_line_2": "123 Market St, Suite 500",
"updated_at": "2024-02-10T14:05:22Z"
},
"queryGeneratedTime": 1718006400
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Add Check Address
Create and store a mailing address used for sending physical checks on behalf of a specific user.
This endpoint:
- Creates a check mailing address for the user
- Returns the newly created address in a standardized response
curl --request POST \
--url https://api.paywint.com/api/platform/check/add-address/{user_id} \
--header 'Content-Type: application/json' \
--header 'X-Platform-ID: <x-platform-id>' \
--header 'X-Signature: <x-signature>' \
--data '
{
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"name": "John Doe",
"address_line_2": "123 Market St, Suite 500"
}
'import requests
url = "https://api.paywint.com/api/platform/check/add-address/{user_id}"
payload = {
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"name": "John Doe",
"address_line_2": "123 Market St, Suite 500"
}
headers = {
"X-Platform-ID": "<x-platform-id>",
"X-Signature": "<x-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Platform-ID': '<x-platform-id>',
'X-Signature': '<x-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
address_line_1: 'Building B, Floor 3',
city: 'San Francisco',
state: 'CA',
zipcode: '94103',
country: 'United States',
name: 'John Doe',
address_line_2: '123 Market St, Suite 500'
})
};
fetch('https://api.paywint.com/api/platform/check/add-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/check/add-address/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address_line_1' => 'Building B, Floor 3',
'city' => 'San Francisco',
'state' => 'CA',
'zipcode' => '94103',
'country' => 'United States',
'name' => 'John Doe',
'address_line_2' => '123 Market St, Suite 500'
]),
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/check/add-address/{user_id}"
payload := strings.NewReader("{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.paywint.com/api/platform/check/add-address/{user_id}")
.header("X-Platform-ID", "<x-platform-id>")
.header("X-Signature", "<x-signature>")
.header("Content-Type", "application/json")
.body("{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywint.com/api/platform/check/add-address/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Platform-ID"] = '<x-platform-id>'
request["X-Signature"] = '<x-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address_line_1\": \"Building B, Floor 3\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipcode\": \"94103\",\n \"country\": \"United States\",\n \"name\": \"John Doe\",\n \"address_line_2\": \"123 Market St, Suite 500\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed.",
"data": {
"address_line_1": "Building B, Floor 3",
"city": "San Francisco",
"state": "CA",
"zipcode": "94103",
"country": "United States",
"address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
"created_at": "2024-01-15T10:30:00Z",
"name": "John Smith",
"address_line_2": "123 Market St, Suite 500",
"updated_at": "2024-02-10T14:05:22Z"
},
"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 whose check address is being created.
Body
Secondary address line (optional).
64"Building B, Floor 3"
City name.
40"San Francisco"
State, province, or region.
30"CA"
Postal or ZIP code.
5 - 10"94103"
Country name.
40"United States"
Display name shown on checks (e.g., company or account label).
2 - 180"John Doe"
Primary street address, including suite/apartment if applicable.
64"123 Market St, Suite 500"
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

