Skip to main content
DELETE
/
api
/
platform
/
address
/
delete-payee-address
/
{user_id}
Delete Payee Mailing Address
curl --request DELETE \
  --url http://localhost:8001/api/platform/address/delete-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",
  "address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": "<unknown>",
  "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"

​
address_id
string<uuid4>
required

Unique identifier (UUID) of the payee's address record.

Example:

"a1b2c3d4-****-****-****-e5f6g7h8i9j0"

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
any | null

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