---
title: "Get transfers"
method: GET
path: "/transfers"
tags: ["Transfers"]
---

# Get transfers

`GET /transfers`

Gets a list of transfers.

## Query parameters

- `page` integer
- `size` integer
- `with_labels` string[]
- `without_labels` string[]
- `include_labels` boolean
- `state` 'PREPARED' | 'EXECUTED' | 'COMPLETED' | 'FAILED' | 'PENDING'
- `internal_id` string
- `sender_end_to_end_id` string
- `sort_field` 'CREATED_AT' | 'MODIFIED_AT'
- `sort_direction` 'ASC' | 'DESC'
- `account` string
- `transfer_account_role` 'SENDING' | 'RECEIVING'

## Response `200`

Successfully returned transfers.

- Transfers — Provides a `content` array of transfer objects and a set of pagination information fields.
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` TransferResponse[] — Provides an array of transfer objects.
    - `transfer_id` string, uuid, required — Unique identifier of the transfer.
    - `state` 'PREPARED' | 'EXECUTED' | 'COMPLETED' | 'CANCELLED' | 'FAILED' | 'QUOTED' | 'PENDING' | 'OTHER', required — State of the transfer.<p>`QUOTED` and `PENDING` only apply when RippleNet is enabled to receive payments from xRapid. `QUOTED` represents an outbound transfer fee estimate. `PENDING` is the state of an outbound transfer executed by RippleNet (via xRapid) but not yet paid out by the digital exchange. If successfully paid out, the state becomes `COMPLETED`. If not successfully paid out by the digital exchange, the state becomes `FAILED`. </p>
    - `owner_address` string, required — Owner RippleNet address, if different from the RippleNet address of the `sender_address` and `receiver_address`.
    - `sender_address` string, required — RippleNet account name and address, in the format `accountname@ripplenetaddress`. For example, `new_york@rn.us.ny.new_york`.
    - `receiver_address` string, required — RippleNet account name and address, in the format `accountname@ripplenetaddress`. For example, `new_york@rn.us.ny.new_york`.
    - `amount` number, required — Amount transferred, expressed in the account's currency.
    - `internal_id` string — Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending RippleNet instance stores this ID.
    - `end_to_end_id` string — ID that the sender can optionally specify. Persisted on all RippleNet instances that participated in the transfer.
    - `sending_fee` number — Optional sending fee charged by a digital asset exchange for initiating an outbound transfer.
    - `created_at` string, date-time — The time when this transfer is created.
    - `user_info` TransferUserInfo[], required — Custom information set by a RippleNet address involved in the transfer.
      - `node_address` string, required — RippleNet address of the xCurrent instance that set the user information.
      - `state` 'PREPARED' | 'EXECUTED' | 'COMPLETED' | 'CANCELLED' | 'FAILED' | 'QUOTED', required — State of the transfer set when the RippleNet address set the user information.
      - `json` object, required — One or more arbitrary key/value pairs.
      - `created_at` string, date-time — timestamp of when this user info was created
    - `labels` string[] — List of labels associated with this transfer

## Other responses

- `400` — Bad request.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/revisions/7843f07ca150/schema)