Skip to content

List transactions

Request

Security
httpAuth
Path
domainIdstring, (uuid)required

Unique identifier for the domain.

Query
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""ledgerId""processingStatus""registeredAt""ledgerTransactionData.ledgerStatus""ledgerTransactionData.statusLastUpdatedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
ledgerIdstring, non-empty

Return entities matching given ledger id.

Example:ledgerId=1234567
orderReference.Idstring, (uuid)

Return entities matching given order reference id.

Example:orderReference.Id=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
orderReference.domainIdstring, (uuid)

Return entities matching given order domain id.

Example:orderReference.domainId=fdeeeb4b-f987-4ec4-9880-1eb280581d49
accountIdstring, (uuid)

Return entities matching given accountId.

Example:accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
processing.statusstring

Return entities matching given processing status.

Enum:"Pending""Preparing""Reserved""Prepared""Broadcasting""Completed""Interrupted""Failed"
Example:processing.status=Prepared
ledgerTransactionData.ledgerStatusstring

Return entities matching given status of ledger transaction.

Enum:"Detected""Confirmed""Expired""Replaced"
Example:ledgerTransactionData.ledgerStatus=Confirmed
ledgerTransactionData.ledgerTransactionIdstring, non-empty

Return entities matching given ledger transaction id.

Example:ledgerTransactionData.ledgerTransactionId=tx1id
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.42/devbox/v1/domains/{domainId}/transactions?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&ledgerId=1234567&orderReference.Id=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&orderReference.domainId=fdeeeb4b-f987-4ec4-9880-1eb280581d49&accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&processing.status=Prepared&ledgerTransactionData.ledgerStatus=Confirmed&ledgerTransactionData.ledgerTransactionId=tx1id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
itemsArray of objectsrequired
countinteger, (int32)required
currentStartingAfterstring
nextStartingAfterstring
Response
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}