Skip to main content

Wallets

The Wallet Object​

id string
name string
A name to easily identify the wallet
stripeCustomerId string | null

Stripe Customer ID

Used to sync data from Stripe and listen for events.

stripeConnectAccountId string | null

Stripe Connect Account ID

Used for Payouts.

createdAt string

ISO 8601

updatedAt string

ISO 8601

walletBalances WalletBalance[]
deposits Deposit[]
exchanges Exchange[]
paymentMethods PaymentMethod[]
payouts Payout[]
subscriptions Subscription[]
transfers Transfer[]
withdrawals Withdrawal[]

Create a Wallet​

let wallet = await solidtx.wallets.create({
  name: 'Jane Doe'
})

Parameters​

name stringRequired
A name for the wallet
stripeCustomerId string

The Stripe Customer ID

stripeConnectAccountId string

The Stripe Connect Account ID

Returns​

Returns the Wallet object with all its Balances.

{
  "id": "wallet_yxeh6q5mmpik8w6cyvc9zcnn",
  "name": "Jane Doe",
  "stripeCustomerId": "cus_NffrFeUfNV2Hib",
  "stripeConnectAccountId": "acct_1032D82eZvKYlo2C",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z",
  "walletBalances": [
    {
      "balanceId": "cash",
      "balanceName": "Cash",
      "balanceCurrencyCode": "USD",
      "amount": "0.00"
    },
    {
      "balanceId": "gems",
      "balanceName": "Gems",
      "balanceCurrencyCode": "GEM",
      "amount": "1000"
    },
  ]
}

Get a Wallet​

let wallet = await solidtx.wallets.get('wallet_yxeh6q5mmpik8w6cyvc9zcnn')

Parameters​

No Parameters

Returns​

Returns the Wallet object with all its Balances.

{
  "id": "wallet_yxeh6q5mmpik8w6cyvc9zcnn",
  "name": "Jane Doe",
  "stripeCustomerId": "cus_NffrFeUfNV2Hib",
  "stripeConnectAccountId": "acct_1032D82eZvKYlo2C",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z",
  "walletBalances": [
    {
      "balanceId": "cash",
      "balanceName": "Cash",
      "balanceCurrencyCode": "USD",
      "amount": "0.00"
    },
    {
      "balanceId": "gems",
      "balanceName": "Gems",
      "balanceCurrencyCode": "GEM",
      "amount": "1000"
    },
  ]
}

Update a Wallet​

let wallet = await solidtx.wallets.update({
  walletId: 'wallet_yxeh6q5mmpik8w6cyvc9zcnn',
  stripeCustomerId: 'cus_NffrFeUfNV2Hib'
})

Parameters​

walletId stringRequired
stripeCustomerId string
stripeCustomerId string | null

The Stripe Customer ID or null to clear it out

stripeConnectAccountId string | null

The Stripe Connect Account ID or null to clear it out

Returns​

Returns the Wallet object with all its Balances.

{
  "id": "wallet_yxeh6q5mmpik8w6cyvc9zcnn",
  "name": "Jane Doe",
  "stripeCustomerId": "cus_NffrFeUfNV2Hib",
  "stripeConnectAccountId": "acct_1032D82eZvKYlo2C",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z",
  "walletBalances": [
    {
      "balanceId": "cash",
      "balanceName": "Cash",
      "balanceCurrencyCode": "USD",
      "amount": "0.00"
    },
    {
      "balanceId": "gems",
      "balanceName": "Gems",
      "balanceCurrencyCode": "GEM",
      "amount": "1000"
    },
  ]
}