Skip to main content

Payouts

SolidTX can pay out funds from a Wallet to a user using Stripe Connect. To do this, the Wallet.stripeConnectAccountId attribute must be set.

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

Payout to a User​

let payout = await solidtx.wallets.payout({
  walletId: 'wallet_yxeh6q5mmpik8w6cyvc9zcnn',
  balanceId: 'cash',
  amount: '10.00'
})

Parameters​

walletId stringRequired

ID of the Wallet

balanceId stringRequired

ID of the Balance

Only balances with the USD currency code are currently supported.

amount stringRequired

The amount of the payout. Must be a positive number and may not exceed the amount in the Balance.

Returns​

Creates and returns a new Payout object.

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

Get a Payout​

let payout = await solidtx.payouts.get('payout_cm8p6laci00050cl6631a4l7t')

Parameters​

No Parameters

Returns​

Returns the Payout object.

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

Search Payouts​

// Search all Payouts globally
let payouts = await solidtx.payouts.search()

// Search all Payouts in a Wallet
let payouts = await solidtx.payouts.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 Payout objects with Pagination information.

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