Skip to main content

Deposits

Deposits are Transactions that increase a fiat balance by charging a payment method through Stripe.

See Charge a Payment Method to initiate a deposit.

The Deposit 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

The Transaction object created for this Deposit

Get a Deposit​

let deposit = await solidtx.deposits.get('deposit_cm8p8azr200000cjy95mshk65')

Parameters​

No Parameters

Returns​

Returns the Deposit object.

{
  "id": "deposit_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 Deposits​

// Search all Deposits globally
let deposits = await solidtx.deposits.search()

// Search all Deposits in a Wallet
let deposits = await solidtx.deposits.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 Deposit objects with Pagination information.

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