Skip to main content
DELETE
/
api
/
user-api
/
address
/
payee
/
delete
Delete Payee Address
curl --request DELETE \
  --url https://api.sandbox.paywint.com/api/user-api/address/payee/delete \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Api-Secret: <x-api-secret>' \
  --data '
{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "address_id": "2d8c5ca1-98cb-42f7-8c1e-70a2b0b8e8f1",
  "new_default_address_id": "<string>"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": "<unknown>",
  "queryGeneratedTime": 1718006400
}

Headers

​
X-Api-Key
string
required

Your API Key (UUID format). Required to identify and authorize each request

​
X-Api-Secret
string
required

Secret associated with your API Key. Used for authenticating requests. Keep this secure.

Body

application/json
​
payee_id
string<uuid4>
required

Unique identifier for the payee whose addresses are being managed.

Example:

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

​
address_id
string<uuid4>
required

Unique identifier for the payee address record.

Example:

"2d8c5ca1-98cb-42f7-8c1e-70a2b0b8e8f1"

​
new_default_address_id
string<uuid4> | null

Optional address_id to mark as default if the requested address was defaulted.

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:1771679555.638735

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

Example:

1718006400