v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Transactions

List transfers

get/v1/domains/{domainId}/transactions/transfers

Path parameters

domainIdstring uuid required

Unique identifier for the domain.

Query parameters

limitinteger

The number of entities to return.

startingAfterstring uuid

Entity id used to the determine beginning of query results.

sortBy'id' | 'transactionId' | 'tickerId' | 'quarantined' | 'value' | 'kind' | 'registeredAt'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

transactionIdstring uuid

Return entities matching given transactionId.

tickerIdstring uuid

Return entities matching given tickerId.

quarantinedboolean

Deprecated: use quarantineStatus instead. Return entities matching given quarantined status.

quarantineStatus'Quarantined' | 'Released' | 'Skipped'

Return entities matching given quarantine status. Values: Quarantined, Released, Skipped.

kind'Transfer' | 'Fee' | 'Recovery'

Return entities matching given kind.

accountIdstring uuid

Return entities matching given accountId.

recipient.accountIdstring[]

Return entities matching given recipient accountIds.

registeredAt.ltstring date-time

Return only results registered before the given date/time (lt=less than)

registeredAt.gtstring date-time

Return only results registered after the given date/time (gt=greater than)

recipient.addressDetails.addressstring[]

Return results where recipient's address contains or equals provided address.

ticker.ledgerIdstring[]

Return entities matching given ledger.

ticker.validationStatus'Validated' | 'NonValidated'

Return transfers with ticker matching the requested validation status

ticker.lockCoreLockStatus[]

Return transfers with ticker matching given lock status.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring