External account transactions

External account refers to account held at exchanges or sub-custodians. The transactions APIs allow to monitoring and listing of orders and transactions that are instructed to the sub-custodian.

Operations

/v1/domains/{domainId}/external-accounts/transactions/orders

Request

Get external account orders

Security

httpAuth

Path

domainIdstring, (uuid)required

Query

limitinteger, (int32)

externalAccountIdsArray of strings, (uuid)

intentIdstring, (uuid)

createdBystring, (uuid)

lastModifiedBystring, (uuid)

descriptionstring

customPropertiesArray of strings

startingAfterstring, (uuid)

sortOrderstring

Enum:"ASC""DESC"

sortBystring

Enum:"id""externalAccountId""createdAt""lastModifiedAt"

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/external-accounts/transactions/orders?limit=0&externalAccountIds=497f6eca-6276-4993-bfeb-53cbbbba6f08&intentId=497f6eca-6276-4993-bfeb-53cbbbba6f08&createdBy=497f6eca-6276-4993-bfeb-53cbbbba6f08&lastModifiedBy=497f6eca-6276-4993-bfeb-53cbbbba6f08&description=string&customProperties=string&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortOrder=ASC&sortBy=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

itemsArray of objectsrequired

countinteger, (int32)required

currentStartingAfterstring or null, (uuid)

nextStartingAfterstring or null, (uuid)

Response

{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "651be221-e717-4828-840c-fe29ed82c461",
  "nextStartingAfter": "2e35122f-8704-4d6f-b465-9a3a43a644e9"
}