OTC Trades DVP

Get OTC DVP Trades

get

Retrieve a list of OTC DVP Trades

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

orderanyOptional

Array of fields and directions to order. Supported fields: createdAt, status, initiatorSendAmount, acceptorSendAmount

Responses

200

Successfully retrieved a list of items.

application/json

get

/otc-trades-dvp

HTTPcURLJavaScriptPython

GET /otc-trades-dvp HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2025-12-13T22:07:04.139Z",
      "updatedAt": "2025-12-13T22:07:04.139Z",
      "id": "c1f5a632-e1b6-40ee-9fff-7b3b6914c218",
      "status": "initiated",
      "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "initiatorSendAssetId": "7abc300c-8793-497f-b72a-0849f67735d2",
      "initiatorSendAmount": 200,
      "initiatorBrokerId": "6172395e-c878-447d-91a8-857c7c107bd4",
      "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "acceptorSendAssetId": "97ff8db4-d3e4-4c8f-a921-2e2ef8f32025",
      "acceptorSendAmount": 100,
      "acceptorBrokerId": "503ca9a3-1871-48fb-95fc-f057c12dbb70",
      "tradedAt": "2025-12-13T22:07:04.139Z"
    }
  ]
}

Initiate DVP OTC trade

post

Initiate a Delivery-Versus-Payment Over-The-Counter trade, between two accounts

Body

application/json

initiatorAccountAddressstring · xrp-addressRequired

Initiator account address

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

initiatorSendAssetIdstring · uuidRequired

Initiator sending asset id

Example: e1445aa4-0d26-49ce-9807-c490027672dd

initiatorSendAmountinteger · int64Required

Initiator sending asset amount in units

Example: 200

acceptorAccountAddressstring · xrp-addressRequired

Accepter account address

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

acceptorSendAssetIdstring · uuidRequired

Acceptor sending asset id

Example: d7b0e2fa-f0fe-4d7f-930f-2c5278b95e8b

acceptorSendAmountinteger · int64Required

Accepter sending asset amount in units

Example: 100

tradedAtstring · date-timeRequired

Trade day in ISO 8601 format YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ

Example: 2037-10-01

Responses

201

Initiated DVP OTC trade

application/json

post

/otc-trades-dvp

HTTPcURLJavaScriptPython

POST /otc-trades-dvp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorSendAssetId": "e1445aa4-0d26-49ce-9807-c490027672dd",
  "initiatorSendAmount": 200,
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorSendAssetId": "d7b0e2fa-f0fe-4d7f-930f-2c5278b95e8b",
  "acceptorSendAmount": 100,
  "tradedAt": "2037-10-01"
}

201

Initiated DVP OTC trade

{
  "createdAt": "2025-12-13T22:07:04.139Z",
  "updatedAt": "2025-12-13T22:07:04.139Z",
  "id": "c1f5a632-e1b6-40ee-9fff-7b3b6914c218",
  "status": "initiated",
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorSendAssetId": "7abc300c-8793-497f-b72a-0849f67735d2",
  "initiatorSendAmount": 200,
  "initiatorBrokerId": "6172395e-c878-447d-91a8-857c7c107bd4",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorSendAssetId": "97ff8db4-d3e4-4c8f-a921-2e2ef8f32025",
  "acceptorSendAmount": 100,
  "acceptorBrokerId": "503ca9a3-1871-48fb-95fc-f057c12dbb70",
  "tradedAt": "2025-12-13T22:07:04.139Z"
}

Get OTC DVP Trade

get

Get OTC DVP Trade by its unique identifier

Path parameters

otcTradeDvpIdstring · uuidRequired

OTC DVP Trade UUID identifier, unique in scope of this node

Example: ce534269-0fac-4ac0-b3ec-a89bc8b9048d

Responses

200

Retrieve full information about a single OTC Trade DVP

application/json

get

/otc-trades-dvp/{otcTradeDvpId}

HTTPcURLJavaScriptPython

GET /otc-trades-dvp/{otcTradeDvpId} HTTP/1.1
Host: 
Accept: */*

200

Retrieve full information about a single OTC Trade DVP

{
  "createdAt": "2025-12-13T22:07:04.139Z",
  "updatedAt": "2025-12-13T22:07:04.139Z",
  "id": "c1f5a632-e1b6-40ee-9fff-7b3b6914c218",
  "status": "initiated",
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorSendAssetId": "7abc300c-8793-497f-b72a-0849f67735d2",
  "initiatorSendAmount": 200,
  "initiatorBrokerId": "6172395e-c878-447d-91a8-857c7c107bd4",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorSendAssetId": "97ff8db4-d3e4-4c8f-a921-2e2ef8f32025",
  "acceptorSendAmount": 100,
  "acceptorBrokerId": "503ca9a3-1871-48fb-95fc-f057c12dbb70",
  "tradedAt": "2025-12-13T22:07:04.139Z"
}

Change DVP OTC trade

patch

Accept/Cancel/Reject a Free-Of-Payment Over-The-Counter trade

Path parameters

otcTradeDvpIdstring · uuidRequired

OTC DVP Trade UUID identifier, unique in scope of this node

Example: ce534269-0fac-4ac0-b3ec-a89bc8b9048d

Body

application/json

statusall ofRequired

Update OTC DVP trade status:

• completed - (destination investor agent) complete OTC DVP trade
• cancelled - (source investor agent) cancel OTC DVP trade
• rejected - (destination investor agent) reject OTC DVP trade

Example: completed

string · enumOptional

Status of the trade

Possible values:

Responses

200

Changed DVP OTC trade

application/json

patch

/otc-trades-dvp/{otcTradeDvpId}

HTTPcURLJavaScriptPython

PATCH /otc-trades-dvp/{otcTradeDvpId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "completed"
}

200

Changed DVP OTC trade

{
  "createdAt": "2025-12-13T22:07:04.139Z",
  "updatedAt": "2025-12-13T22:07:04.139Z",
  "id": "c1f5a632-e1b6-40ee-9fff-7b3b6914c218",
  "status": "initiated",
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorSendAssetId": "7abc300c-8793-497f-b72a-0849f67735d2",
  "initiatorSendAmount": 200,
  "initiatorBrokerId": "6172395e-c878-447d-91a8-857c7c107bd4",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorSendAssetId": "97ff8db4-d3e4-4c8f-a921-2e2ef8f32025",
  "acceptorSendAmount": 100,
  "acceptorBrokerId": "503ca9a3-1871-48fb-95fc-f057c12dbb70",
  "tradedAt": "2025-12-13T22:07:04.139Z"
}