Add Payee Address

Create Payee Mailing Address

curl --request POST \
  --url https://api.paywint.com/api/platform/address/create-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",
  "name": "John",
  "address_line_1": "123 Main Street, Apt 4B",
  "city": "New York",
  "state": "NY",
  "zipcode": "10001",
  "country": "United States",
  "last_name": "Smith",
  "address_line_2": "123 Main Street, Apt 4B",
  "company_name": "Meta Corp"
}
'

import requests

url = "https://api.paywint.com/api/platform/address/create-payee-address/{user_id}"

payload = {
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "name": "John",
    "address_line_1": "123 Main Street, Apt 4B",
    "city": "New York",
    "state": "NY",
    "zipcode": "10001",
    "country": "United States",
    "last_name": "Smith",
    "address_line_2": "123 Main Street, Apt 4B",
    "company_name": "Meta Corp"
}
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({
    payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    name: 'John',
    address_line_1: '123 Main Street, Apt 4B',
    city: 'New York',
    state: 'NY',
    zipcode: '10001',
    country: 'United States',
    last_name: 'Smith',
    address_line_2: '123 Main Street, Apt 4B',
    company_name: 'Meta Corp'
  })
};

fetch('https://api.paywint.com/api/platform/address/create-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/create-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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'name' => 'John',
    'address_line_1' => '123 Main Street, Apt 4B',
    'city' => 'New York',
    'state' => 'NY',
    'zipcode' => '10001',
    'country' => 'United States',
    'last_name' => 'Smith',
    'address_line_2' => '123 Main Street, Apt 4B',
    'company_name' => 'Meta Corp'
  ]),
  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/create-payee-address/{user_id}"

	payload := strings.NewReader("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\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/address/create-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  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/address/create-payee-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  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\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>"
    }
  ]
}

POST

api

platform

address

create-payee-address

{user_id}

Create Payee Mailing Address

curl --request POST \
  --url https://api.paywint.com/api/platform/address/create-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",
  "name": "John",
  "address_line_1": "123 Main Street, Apt 4B",
  "city": "New York",
  "state": "NY",
  "zipcode": "10001",
  "country": "United States",
  "last_name": "Smith",
  "address_line_2": "123 Main Street, Apt 4B",
  "company_name": "Meta Corp"
}
'

import requests

url = "https://api.paywint.com/api/platform/address/create-payee-address/{user_id}"

payload = {
    "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
    "name": "John",
    "address_line_1": "123 Main Street, Apt 4B",
    "city": "New York",
    "state": "NY",
    "zipcode": "10001",
    "country": "United States",
    "last_name": "Smith",
    "address_line_2": "123 Main Street, Apt 4B",
    "company_name": "Meta Corp"
}
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({
    payee_id: 'f47ac10b-****-****-****-0e02b2c3d479',
    name: 'John',
    address_line_1: '123 Main Street, Apt 4B',
    city: 'New York',
    state: 'NY',
    zipcode: '10001',
    country: 'United States',
    last_name: 'Smith',
    address_line_2: '123 Main Street, Apt 4B',
    company_name: 'Meta Corp'
  })
};

fetch('https://api.paywint.com/api/platform/address/create-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/create-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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payee_id' => 'f47ac10b-****-****-****-0e02b2c3d479',
    'name' => 'John',
    'address_line_1' => '123 Main Street, Apt 4B',
    'city' => 'New York',
    'state' => 'NY',
    'zipcode' => '10001',
    'country' => 'United States',
    'last_name' => 'Smith',
    'address_line_2' => '123 Main Street, Apt 4B',
    'company_name' => 'Meta Corp'
  ]),
  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/create-payee-address/{user_id}"

	payload := strings.NewReader("{\n  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\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/address/create-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  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paywint.com/api/platform/address/create-payee-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  \"payee_id\": \"f47ac10b-****-****-****-0e02b2c3d479\",\n  \"name\": \"John\",\n  \"address_line_1\": \"123 Main Street, Apt 4B\",\n  \"city\": \"New York\",\n  \"state\": \"NY\",\n  \"zipcode\": \"10001\",\n  \"country\": \"United States\",\n  \"last_name\": \"Smith\",\n  \"address_line_2\": \"123 Main Street, Apt 4B\",\n  \"company_name\": \"Meta Corp\"\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

X-Platform-ID

string<uuid>

required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature

string

required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id

string<uuid>

required

Unique identifier (UUID) of the user

Body

application/json

payee_id

string<uuid4>

required

Unique identifier (UUID) of the payee for whom this address is being created.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

name

string

required

Recipient's first name.

Required string length: 2 - 100

Example:

"John"

address_line_1

string

required

Street address including apartment, suite, or unit number.

Maximum string length: 100

Example:

"123 Main Street, Apt 4B"

city

string

required

City name.

Maximum string length: 40

Example:

"New York"

state

string

required

State, province, or region.

Maximum string length: 30

Example:

"NY"

zipcode

string

required

Postal code or ZIP code.

Maximum string length: 10

Example:

"10001"

country

string

required

Country name.

Maximum string length: 40

Example:

"United States"

last_name

string | null

Recipient's last name (optional).

Maximum string length: 100

Example:

"Smith"

address_line_2

string | null

Street address including apartment, suite, or unit number.

Maximum string length: 100

Example:

"123 Main Street, Apt 4B"

company_name

string | null

Full name of the payee's company.

Maximum string length: 100

Example:

"Meta Corp"

Response

Successful Response

success

boolean

default:true

Indicates whether the request was processed successfully.

Example:

true

message

string

default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data

ExternalContactAddressRead · object | null

The main response payload, if applicable

Show child attributes

queryGeneratedTime

number | null

default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400

Overview List Payee Address

Users

KYC & KYB

Wallet

Payments

Accept Payments

Cross Border Payments

Bank Accounts

Paywint Bank Accounts

Cards

Check

Payee Management

Payee Bank Accounts

Payee Cards

Payee Addresses

Headers

Path Parameters

Body

Response