v2

latestOpenAPI 3.1.02026-07-267085761.0 MB

Developer API Address

Delete Payee Address

Delete an address associated with a payee.

This endpoint allows you to:

Remove outdated or invalid location records
Maintain clean beneficiary records
Prevent incorrect billing or fulfillment usage
Promote another address as default if required

If the deleted address was marked as default, another saved address may automatically be promoted.

delete/api/user-api/address/payee/delete

Headers

X-Api-Keystring required

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

X-Api-Secretstring required

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

Request body

payee_idstring uuid4 required

Unique identifier for the payee whose addresses are being managed.

address_idstring uuid4 required

Unique identifier for the payee address record.

new_default_address_idstring uuid4 nullable

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

Example request

{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "address_id": "2d8c5ca1-98cb-42f7-8c1e-70a2b0b8e8f1"
}

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

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

{"stackTrail":"components:schemas:CommonResponse:properties:data:anyOf","oasType":"schema","type":"unknown","title":"Data","description":"The main response payload, if applicable","nullable":true}

queryGeneratedTimenumber nullable

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

Example response

{
  "success": true,
  "message": "Operation completed.",
  "queryGeneratedTime": 1718006400
}