Skip to main content
GET
List transfer requests
Filter by status and page with limit + next. A request waiting for approval whose deadline passed is listed as EXPIRED. Send x-environment: LIVE for production wallets. Organization admins can list every wallet’s requests; other users only those of the wallets shared with them, in any role.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST requests; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the wallet belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the wallet whose transfer requests you list (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

status
enum<string>

Only requests in this status (case-insensitive). EXPIRED includes requests whose approval deadline passed while they waited for approval.

Available options:
PENDING_APPROVAL,
REQUESTED,
CONFIRMED,
CANCELLED,
EXPIRED,
FAILED,
SCHEDULED
next
string

Cursor returned as next by the previous page. Omit it for the first page.

limit
integer

Page size. Defaults to 15.

Required range: x > 0

Response

Successful response

A page of transfer requests.

items
object[]
required

The transfer requests of this page, newest first.

next
string | null
required

Cursor of the next page: send it as next to read it. null on the last page.

Example:

"NjcyMGQ0ZjFiNGQzZTgwMDEyYzlhMmU3"