OTC Trades FOP

Get FOP OTC trades

get

Retrieve a list of Free of Payment Over the Counter 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, amount

Responses

200

Successfully retrieved a list of items.

application/json

get

/otc-trades-fop

HTTPcURLJavaScriptPython

GET /otc-trades-fop 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-13T16:47:18.031Z",
      "updatedAt": "2025-12-13T16:47:18.031Z",
      "id": "9b34abf5-e655-40de-a98e-0bd1976294a3",
      "status": "initiated",
      "assetId": "75e53a88-676a-4e53-bd3f-3b937a370075",
      "amount": 200,
      "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "initiatorBrokerId": "abe4fba9-f445-4190-ad6e-0971b14be4aa",
      "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "acceptorBrokerId": "62168fde-45f7-48ef-a67a-35b15cfd34a1",
      "reason": "internal",
      "tradedAt": "2025-12-13T16:47:18.031Z"
    }
  ]
}

Initiate FOP OTC trade

post

Initiate a Free-of-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}

assetIdstring · uuidRequired

Initiator sending asset id

Example: 035f9fd0-e88c-47ea-8250-a526f75e3b03

amountinteger · int64Required

Initiator sending asset amount in units

Example: 200

acceptorAccountAddressstring · xrp-addressRequired

Accepter account address

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

reasonall ofOptional

Reason for initiating OTC FOP trade:

• error - initiate error correcting trade
• restriction - initiate trade due to restriction

Required for currency transactions

Example: restriction

string · enumOptional

Reason for the trade

Possible values:

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 FOP OTC trade

application/json

post

/otc-trades-fop

HTTPcURLJavaScriptPython

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

{
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "assetId": "035f9fd0-e88c-47ea-8250-a526f75e3b03",
  "amount": 200,
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "reason": "restriction",
  "tradedAt": "2037-10-01"
}

201

Initiated FOP OTC trade

{
  "createdAt": "2025-12-13T16:47:18.031Z",
  "updatedAt": "2025-12-13T16:47:18.031Z",
  "id": "9b34abf5-e655-40de-a98e-0bd1976294a3",
  "status": "initiated",
  "assetId": "75e53a88-676a-4e53-bd3f-3b937a370075",
  "amount": 200,
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorBrokerId": "abe4fba9-f445-4190-ad6e-0971b14be4aa",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorBrokerId": "62168fde-45f7-48ef-a67a-35b15cfd34a1",
  "reason": "internal",
  "tradedAt": "2025-12-13T16:47:18.031Z"
}

Get FOP OTC trade

get

Get Free of Payment Over the Counter trade by its unique identifier

Path parameters

otcTradeFopIdstring · uuidRequired

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

Example: aa70f8b7-38d5-41d2-864b-d281ab6cfec2

Responses

200

Retrieve full information about a single Free of Payment Over the Counter Trade

application/json

get

/otc-trades-fop/{otcTradeFopId}

HTTPcURLJavaScriptPython

GET /otc-trades-fop/{otcTradeFopId} HTTP/1.1
Host: 
Accept: */*

200

Retrieve full information about a single Free of Payment Over the Counter Trade

{
  "createdAt": "2025-12-13T16:47:18.031Z",
  "updatedAt": "2025-12-13T16:47:18.031Z",
  "id": "9b34abf5-e655-40de-a98e-0bd1976294a3",
  "status": "initiated",
  "assetId": "75e53a88-676a-4e53-bd3f-3b937a370075",
  "amount": 200,
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorBrokerId": "abe4fba9-f445-4190-ad6e-0971b14be4aa",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorBrokerId": "62168fde-45f7-48ef-a67a-35b15cfd34a1",
  "reason": "internal",
  "tradedAt": "2025-12-13T16:47:18.031Z"
}

Change FOP OTC trade

patch

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

Path parameters

otcTradeFopIdstring · uuidRequired

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

Example: aa70f8b7-38d5-41d2-864b-d281ab6cfec2

Body

application/json

statusall ofRequired

OTC Trade FOP status:

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

Example: completed

string · enumOptional

Status of the trade

Possible values:

Responses

200

Changed FOP OTC trade

application/json

patch

/otc-trades-fop/{otcTradeFopId}

HTTPcURLJavaScriptPython

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

{
  "status": "completed"
}

200

Changed FOP OTC trade

{
  "createdAt": "2025-12-13T16:47:18.031Z",
  "updatedAt": "2025-12-13T16:47:18.031Z",
  "id": "9b34abf5-e655-40de-a98e-0bd1976294a3",
  "status": "initiated",
  "assetId": "75e53a88-676a-4e53-bd3f-3b937a370075",
  "amount": 200,
  "initiatorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "initiatorBrokerId": "abe4fba9-f445-4190-ad6e-0971b14be4aa",
  "acceptorAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "acceptorBrokerId": "62168fde-45f7-48ef-a67a-35b15cfd34a1",
  "reason": "internal",
  "tradedAt": "2025-12-13T16:47:18.031Z"
}