Skip to main content

Payout​

This event is emitted when a payout is processed.

Object schema

Webhook payload object

Use this schema when validating, storing, or transforming the incoming payout webhook payload.

id
string<uuid>
webhookId
string<uuid>
eventType
string
required
Allowed value:
payout
eventData
object
required
payout
object
payoutId
string<uuid>
required
status
string
required
Allowed values:
AwaitingConfirmationPendingProcessingCompleteExpiredFailed
totalAmountUsd
number<float> or null

Total payout amount in USD

estimatedFeeUsd
number<float> or null

Estimated fee in USD

actualFeeUsd
number<float> or null

Actual fee in USD (available after completion)

entryCount
integer<int32> or null

Number of entries in this payout

completedPayouts

Crypto payout entry with details

id
string<uuid>
required
status
string
required
Allowed values:
PendingProcessingCompleteFailed
amount
number<float>
required
initialAmount
number<float> or null
customerId
string<uuid> or null
network
string
required
Allowed values:
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
token
string or null
payoutAddress
string
required
txHash
string or null
externalAccountId
string<uuid> or null
type
string
required
Allowed value:
crypto
payoutEntryId
string<uuid> or null
failureReason
string or null
radomData
paymentLink
object
required
paymentLinkId
string<uuid>
required
paymentLinkOrderId
string<uuid> or null
inputData
array[object] or null
label
string
required
value
string or null