Sign in

v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB
Transfers

Get transfers

Gets a list of transfers.

get/transfers

Query parameters

pageinteger

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

sizeinteger

Number of objects to return per page.

with_labelsstring[]

Returns transfers that contain any of the specified labels.<p>Example - ?with_labels=LABEL1,LABEL2</p>

without_labelsstring[]

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. <p>Example - ?with_labels=LABEL1&include_labels=true</p>

state'PREPARED' | 'EXECUTED' | 'COMPLETED' | 'FAILED' | 'PENDING'

Filter by transfer states.

internal_idstring

Optional parameter for filtering with internalId.

sender_end_to_end_idstring

Optional parameter for filtering with sender end to end id.

sort_field'CREATED_AT' | 'MODIFIED_AT'

Field used to sort the results.

sort_direction'ASC' | 'DESC'

Sort direction.

accountstring

RippleNet account which is involved in transfer

transfer_account_role'SENDING' | 'RECEIVING'

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

Response

Successfully returned transfers.

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

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

Example response

{
  "sort": [
    {
      "direction": "ASC",
      "nullHandling": "NULLS_FIRST",
      "ascending": true
    }
  ],
  "content": [
    {
      "transfer_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
      "state": "EXECUTED",
      "owner_address": "rn.us.ca.san_francisco",
      "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      "amount": 15,
      "internal_id": "9cf5aa4b-1e44-436a-ab7c-d399aec905da",
      "end_to_end_id": "fd7559be-aa85-433f-a283-0cd58681cdf0",
      "created_at": "2019-10-01T21:28:28.354Z",
      "user_info": [
        {
          "node_address": "rn.us.ca.san_francisco",
          "state": "EXECUTED",
          "created_at": "2019-10-01T21:28:28.357Z"
        }
      ],
      "labels": [
        "label1",
        "label2",
        "label3"
      ]
    }
  ]
}