Create Payee Address
curl --request POST \
--url https://api.sandbox.paywint.com/api/user-api/address/payee/create \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--header 'X-Api-Secret: <x-api-secret>' \
--data '
{
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"first_name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"is_default": false
}
'import requests
url = "https://api.sandbox.paywint.com/api/user-api/address/payee/create"
payload = {
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"first_name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"is_default": False
}
headers = {
"X-Api-Key": "<x-api-key>",
"X-Api-Secret": "<x-api-secret>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'X-Api-Secret': '<x-api-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
first_name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
city: 'New York',
state: 'NY',
zipcode: '10001',
country: 'United States',
address_line_2: '123 Main Street, Apt 4B',
company_name: 'Meta Corp',
is_default: false
})
};
fetch('https://api.sandbox.paywint.com/api/user-api/address/payee/create', 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.paywint.com/api/user-api/address/payee/create",
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([
'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
'first_name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001',
'country' => 'United States',
'address_line_2' => '123 Main Street, Apt 4B',
'company_name' => 'Meta Corp',
'is_default' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <x-api-key>",
"X-Api-Secret: <x-api-secret>"
],
]);
$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.paywint.com/api/user-api/address/payee/create"
payload := strings.NewReader("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("X-Api-Secret", "<x-api-secret>")
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.sandbox.paywint.com/api/user-api/address/payee/create")
.header("X-Api-Key", "<x-api-key>")
.header("X-Api-Secret", "<x-api-secret>")
.header("Content-Type", "application/json")
.body("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.paywint.com/api/user-api/address/payee/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["X-Api-Secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\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>"
}
]
}Create Payee Address
Create an address record for a payee.
An address represents a location associated with a payee and may be used across multiple Paywint services.
This endpoint allows you to:
- Store billing or delivery address details
- Support paywint card issuance workflows
- Associate a location with future payment products
- Maintain structured address records
- Designate a primary (default) address
A payee may have multiple addresses, but only one can be marked as default.
POST
/
api
/
user-api
/
address
/
payee
/
create
Create Payee Address
curl --request POST \
--url https://api.sandbox.paywint.com/api/user-api/address/payee/create \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--header 'X-Api-Secret: <x-api-secret>' \
--data '
{
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"first_name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"is_default": false
}
'import requests
url = "https://api.sandbox.paywint.com/api/user-api/address/payee/create"
payload = {
"payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
"first_name": "John",
"last_name": "Smith",
"address_line_1": "123 Main Street, Apt 4B",
"city": "New York",
"state": "NY",
"zipcode": "10001",
"country": "United States",
"address_line_2": "123 Main Street, Apt 4B",
"company_name": "Meta Corp",
"is_default": False
}
headers = {
"X-Api-Key": "<x-api-key>",
"X-Api-Secret": "<x-api-secret>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<x-api-key>',
'X-Api-Secret': '<x-api-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
first_name: 'John',
last_name: 'Smith',
address_line_1: '123 Main Street, Apt 4B',
city: 'New York',
state: 'NY',
zipcode: '10001',
country: 'United States',
address_line_2: '123 Main Street, Apt 4B',
company_name: 'Meta Corp',
is_default: false
})
};
fetch('https://api.sandbox.paywint.com/api/user-api/address/payee/create', 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.paywint.com/api/user-api/address/payee/create",
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([
'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
'first_name' => 'John',
'last_name' => 'Smith',
'address_line_1' => '123 Main Street, Apt 4B',
'city' => 'New York',
'state' => 'NY',
'zipcode' => '10001',
'country' => 'United States',
'address_line_2' => '123 Main Street, Apt 4B',
'company_name' => 'Meta Corp',
'is_default' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <x-api-key>",
"X-Api-Secret: <x-api-secret>"
],
]);
$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.paywint.com/api/user-api/address/payee/create"
payload := strings.NewReader("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<x-api-key>")
req.Header.Add("X-Api-Secret", "<x-api-secret>")
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.sandbox.paywint.com/api/user-api/address/payee/create")
.header("X-Api-Key", "<x-api-key>")
.header("X-Api-Secret", "<x-api-secret>")
.header("Content-Type", "application/json")
.body("{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.paywint.com/api/user-api/address/payee/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["X-Api-Secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n \"first_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 \"country\": \"United States\",\n \"address_line_2\": \"123 Main Street, Apt 4B\",\n \"company_name\": \"Meta Corp\",\n \"is_default\": false\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
Your API Key (UUID format). Required to identify and authorize each request
Secret associated with your API Key. Used for authenticating requests. Keep this secure.
Body
application/json
Unique identifier (UUID) of the payee for whom this address is being created.
Example:
"f47ac10b-****-****-****-0e02b2c3d479"
Recipient's first name.
Required string length:
2 - 100Example:
"John"
Recipient's last name.
Maximum string length:
100Example:
"Smith"
Street address including apartment, suite, or unit number.
Maximum string length:
100Example:
"123 Main Street, Apt 4B"
City name.
Maximum string length:
40Example:
"New York"
State, province, or region.
Maximum string length:
30Example:
"NY"
Postal code or ZIP code.
Maximum string length:
10Example:
"10001"
Country name.
Maximum string length:
40Example:
"United States"
Street address including apartment, suite, or unit number.
Maximum string length:
100Example:
"123 Main Street, Apt 4B"
Full name of the payee's company.
Maximum string length:
100Example:
"Meta Corp"
Set to true if this address should become the payee's default mailing address.
Response
Successful Response
Indicates whether the request was processed successfully.
Example:
true
A short, human-readable message describing the result of the request.
Example:
"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.
Example:
1718006400