Skip to main content

Withdrawals

Withdrawals are Transactions that decrease a fiat balance by withdrawing to a payment method through Stripe or by transferring to a Stripe Connect account.

See Withdraw to a Payment Method to initiate a withdrawal or Payout to a User to transfer via Stripe Connect.

The Withdrawal Object​

id string
walletId string

ID of the Wallet

balanceId string

ID of the Balance

amount string
The amount of the transaction
status string

COMPLETED, PENDING, FAILED

createdAt string

ISO 8601

updatedAt string

ISO 8601

transaction Transaction

Get a Withdrawal​

let withdrawal = await solidtx.withdrawals.get('withdrawal_cm8p8azr200000cjy95mshk65')

Parameters​

No Parameters

Returns​

Returns the Withdrawal object.

{
  "id": "withdrawal_cm8p8azr200000cjy95mshk65",
  "walletId": "wallet_yxeh6q5mmpik8w6cyvc9zcnn",
  "balanceId": "cash",
  "amount": "10.00",
  "status": "COMPLETED",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z",
  "transaction": { ... }
}

Search Withdrawals​

// Search all Withdrawals globally
let withdrawals = await solidtx.withdrawals.search()

// Search all Withdrawals in a Wallet
let withdrawals = await solidtx.withdrawals.search({
  walletId: 'wallet_yxeh6q5mmpik8w6cyvc9zcnn'
})

Parameters​

walletId string
after string

The previous endCursor.

See Pagination.

take number

The maximum number of results to return. Default: 50

See Pagination.

Returns​

Returns a list of Withdrawal objects with Pagination information.

{
  "pageInfo": {
    "endCursor": "...",
    "totalCount": 17
  },
  "data": [
    // Withdrawal objects
  ]
}