Pular para o conteúdo

List transfers

Requisição

Segurança
httpAuth
Caminho
domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

Consulta
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""transactionId""tickerId""quarantined""value""kind""registeredAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
transactionIdstring, (uuid)

Return entities matching given transactionId.

Exemplo:transactionId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
tickerIdstring, (uuid)

Return entities matching given tickerId.

Exemplo:tickerId=fdeeeb4b-f987-4ec4-9880-1eb280581d49
quarantinedboolean

Return entities matching given quarantined status.

Exemplo:quarantined=true
kindstring

Return entities matching given kind.

Enum:"Transfer""Fee""Recovery"
Exemplo:kind=Fee
accountIdstring, (uuid)

Return entities matching given accountId.

Exemplo:accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
recipient.accountIdArray of strings, (uuid)

Return entities matching given recipient accountIds.

Exemplo:recipient.accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&recipient.accountId=f2dd81b0-374f-41b1-800e-b18dff241e3a
registeredAt.ltstring, (date-time)

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

Exemplo:registeredAt.lt=2022-11-22T14:06:00.0000000+00:00
registeredAt.gtstring, (date-time)

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

Exemplo:registeredAt.gt=2022-11-22T14:06:00.0000000+00:00
recipient.addressDetails.addressArray of strings

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

Exemplo:recipient.addressDetails.address=mnRxKt2zGV89qJ9rG9SLCbzD6ZMsbGvU6Z&recipient.addressDetails.address=mtMNbaxSdWMYRjmkwumCykV7x5kVVtjGhH
ticker.ledgerIdArray of strings

Return entities matching given ledger.

Exemplo:ticker.ledgerId=1234567&ticker.ledgerId=abcdefg
ticker.validationStatusstring

Return transfers with ticker matching the requested validation status

Enum:"Validated""NonValidated"
Exemplo:ticker.validationStatus=Validated
ticker.lockArray of strings

Return transfers with ticker matching given lock status.

Items Enum:"Unlocked""Locked""Archived"
Exemplo:ticker.lock=Locked&ticker.lock=Archived
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/v1.34/devbox/v1/domains/{domainId}/transactions/transfers?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&transactionId=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&tickerId=fdeeeb4b-f987-4ec4-9880-1eb280581d49&quarantined=true&kind=Fee&accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&recipient.accountId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be%2Cf2dd81b0-374f-41b1-800e-b18dff241e3a&registeredAt.lt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&registeredAt.gt=2022-11-22T14%3A06%3A00.0000000%2B00%3A00&recipient.addressDetails.address=mnRxKt2zGV89qJ9rG9SLCbzD6ZMsbGvU6Z%2CmtMNbaxSdWMYRjmkwumCykV7x5kVVtjGhH&ticker.ledgerId=1234567%2Cabcdefg&ticker.validationStatus=Validated&ticker.lock=Locked%2CArchived' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json
itemsArray of objectsobrigatório
countinteger, (int32)obrigatório
currentStartingAfterstring
nextStartingAfterstring
Resposta
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}