Skip to main content
POST
/
api
/
platform
/
address
/
create-payee-address
/
{user_id}
Create Payee Mailing Address
curl --request POST \
  --url http://localhost:8001/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"
}
'
{
  "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
}

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

The main response payload, if applicable

​
queryGeneratedTime
number | null
default:1782303609.673092

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

Example:

1718006400