Skip to main content
GET
/
v2
/
wallets
/
{id}
/
withdrawals
List withdrawals
curl --request GET \
  --url https://sandbox.groundtech.co/v2/wallets/{id}/withdrawals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending_liquidity",
      "customerApprovalState": "<string>",
      "blockedBy": "<string>",
      "failureReason": "<string>",
      "withdrawalAmount": 123,
      "destinationToken": "<string>",
      "destinationChain": "<string>",
      "destinationAddress": "<string>",
      "payouts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "withdrawalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "legKey": "<string>",
          "status": "planning",
          "turnkeyActivityId": "<string>",
          "approvalRequestedAt": "2023-11-07T05:31:56Z",
          "approvalValidBefore": "2023-11-07T05:31:56Z",
          "amount": 123,
          "token": "<string>",
          "chain": "<string>",
          "destinationAddress": "<string>",
          "txHash": "<string>",
          "failureReason": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "sourceLegs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "withdrawalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "positionKey": "<string>",
          "sourceChain": "<string>",
          "requestedUsdcUnits": "<string>",
          "status": "<string>",
          "operationId": "<string>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

API keys are prefixed ground_sandbox_ (sandbox) or ground_prod_ (production). Pass the key as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Portfolio wallet ID

Query Parameters

​
cursor
string

Opaque cursor returned from a previous list call. Pass it to fetch the next page.

​
limit
integer
default:50

Maximum number of withdrawals to return.

Required range: 1 <= x <= 200
​
sort
enum<string>
default:createdAt

Field to sort by.

Available options:
createdAt
​
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
createdAtGte
string<date-time>

Only return records created at or after this ISO 8601 timestamp.

​
status
enum<string>

Filter by withdrawal status. Can be repeated to filter by multiple statuses (e.g. ?status=completed&status=failed).

Available options:
pending_liquidity,
processing,
queued_for_customer_approval,
pending_customer_approval,
pending_broadcast,
broadcasted,
completed,
failed,
cancelled

Response

Success

​
data
object[]
​
nextCursor
string | null

Opaque cursor for the next page, or null if no more results.