Ownership Changes

Deprecated

get

Get a paginated list of ownership changes information in the system

Query parameters

account_addressstring · xrp-addressOptional

Filter ownership changes by account address, unique for this gateway

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

bond_idstring · uuidOptional

Filter ownership changes by bond id, unique for this gateway

Example: 6f7fdbcd-e0d8-4bc4-accf-d296bd90e86c

Responses

200

Successfully retrieved a list of items.

application/json

get

/ownership-changes

HTTPcURLJavaScriptPython

GET /ownership-changes HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "created_at": "2025-12-14T00:33:56.419Z",
      "updated_at": "2025-12-14T00:33:56.419Z",
      "id": "79622350-bb66-4f48-b937-755b443e0c90",
      "asset_id": "c2c4ebe4-1a41-4d84-85d0-b09a437c284f",
      "amount": 10,
      "source_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "destination_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "status": "created",
      "description": "Assets were confiscated",
      "message": "Court order has been retracted",
      "cancelled_by_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "expires_at": "2025-12-11T08:55:12.957Z"
    }
  ]
}

Deprecated

post

Initiates an asset ownership change between accounts

Body

application/json

asset_idstring · uuidRequired

Asset identifier to be transferred ,unique to this gateway

Example: fd91ce75-8269-48b8-b5e2-dd75ba99cac1

source_account_addressstring · xrp-addressRequired

Source account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

destination_account_addressstring · xrp-addressRequired

Destination account address

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

amountinteger · int64Required

Amount of tokens to transfer ownership of

Example: 1000

descriptionstringOptional

Optional description of why this transfer was initiated

Example: Transferring to family as instructed in will

expires_atstring · date-timeOptional

Timestamp in the future when this transfer proposal will be available

Example: 2025-12-18T08:55:12.955Z

Responses

201

Created ownership change

application/json

post

/ownership-changes

HTTPcURLJavaScriptPython

POST /ownership-changes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "asset_id": "fd91ce75-8269-48b8-b5e2-dd75ba99cac1",
  "source_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "destination_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "amount": 1000,
  "description": "Transferring to family as instructed in will",
  "expires_at": "2025-12-18T08:55:12.955Z"
}

201

Created ownership change

{
  "created_at": "2025-12-14T00:33:56.419Z",
  "updated_at": "2025-12-14T00:33:56.419Z",
  "id": "79622350-bb66-4f48-b937-755b443e0c90",
  "asset_id": "c2c4ebe4-1a41-4d84-85d0-b09a437c284f",
  "amount": 10,
  "source_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "destination_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "status": "created",
  "description": "Assets were confiscated",
  "message": "Court order has been retracted",
  "cancelled_by_account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "expires_at": "2025-12-11T08:55:12.957Z"
}

Deprecated

patch

Accept or cancel ownershipChange

Path parameters

ownershipChangeIdstring · uuidRequired

Ownership Change UUID identifier, unique in scope of this node

Example: 046951d4-b664-44fd-b3ee-4e085e0b3177

Body

application/json

statusall ofRequired

Status to change ownership change to

Example: accepted

string · enumOptional

Status of an ownership change

Possible values:

account_addressstring · xrp-addressRequired

Address of a sender or receiver account, on whose behalf this change action is performed. (Receiver address for accepting)

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: r[0-9a-zA-Z]{24,34}

messagestringOptional

An optional message that will be attached to ownership change on cancellation

Example: Investor has been informed and declined ownership of these assets

Responses

200Success

No content

patch

/ownership-changes/{ownershipChangeId}

HTTPcURLJavaScriptPython

PATCH /ownership-changes/{ownershipChangeId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "status": "accepted",
  "account_address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "message": "Investor has been informed and declined ownership of these assets"
}

200Success

No content