Pular para o conteúdo

Get transfers

Requisição

Gets a list of transfers.

Segurança
Bearer
Consulta
pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

Padrão:0
sizeinteger, [ 1 .. 100 ]

Number of objects to return per page.

Padrão:20
with_labelsArray of strings

Returns transfers that contain any of the specified labels.

Example - ?with_labels=LABEL1,LABEL2

without_labelsArray of strings

Returns transfers that do not contain any of the specified labels.

include_labelsboolean

Returns labels added to each Transfer object. By default labels are not returned.

Example - ?with_labels=LABEL1&include_labels=true

Padrão:false
statestring

Filter by transfer states.

Enum:"PREPARED""EXECUTED""COMPLETED""FAILED""PENDING"
internal_idstring

Optional parameter for filtering with internalId.

sender_end_to_end_idstring

Optional parameter for filtering with sender end to end id.

sort_fieldstring

Field used to sort the results.

Enum:"CREATED_AT""MODIFIED_AT"
sort_directionstring

Sort direction.

Enum:"ASC""DESC"
accountstring

RippleNet account which is involved in transfer

transfer_account_rolestring

by default account parameter would search both sender and receiver of transfer and bring the results. This is to restrict the account search to sender or receiver of a transfer

Enum:"SENDING""RECEIVING"
curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/transfers?page=0&size=20&with_labels=string&without_labels=string&include_labels=false&state=PREPARED&internal_id=string&sender_end_to_end_id=string&sort_field=CREATED_AT&sort_direction=ASC&account=string&transfer_account_role=SENDING' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successfully returned transfers.

Corpoapplication/json
firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger, (int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

contentArray of objects

Provides an array of transfer objects.

Resposta
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}