Skip to main content

Payout

This event is emitted when a payout is processed.

Payload schema

Webhook payload

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

idstring<uuid>required

Unique identifier for this webhook delivery.

webhookIdstring<uuid>required

Identifier of the webhook configuration that produced this delivery.

eventTypestringrequired

Discriminator for the event. Always the value shown here for this event.

Allowedpayout
eventDataobjectrequired

Event-specific payload. The key matches eventType.

payoutPayoutDatarequired
payoutIdstring<uuid>required
statusPayoutStatusrequired
AllowedAwaitingConfirmationPendingProcessingCompleteExpiredInReviewFailed
totalAmountUsdnumber<float>nullable

Total payout amount in USD

estimatedFeeUsdnumber<float>nullable

Estimated fee in USD

actualFeeUsdnumber<float>nullable

Actual fee in USD (available after completion)

entryCountinteger<int32>nullable

Number of entries in this payout

completedPayoutsPayoutEntry[]nullable
idstring<uuid>required
statusPayoutEntryStatusrequired
AllowedPendingProcessingCompleteInReviewFailed
amountnumber<float>required
initialAmountnumber<float>nullable
customerIdstring<uuid>nullable
networkNetworkrequired
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
tokenstringnullable
payoutAddressstringrequired
txHashstringnullable
externalAccountIdstring<uuid>nullable
fundingCurrencyPayoutFundingCurrencynullable
failureReasonstringnullable
typestringrequired
Allowedfiat
currencyCurrencyrequired
AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC
ibanstringnullable
sortCodestringnullable
bankCodestringnullable
bbanstringnullable
beneficiaryEmailstringrequired
beneficiaryNamestringnullable
beneficiaryCountrystringnullable
beneficiaryDobstringnullable
beneficiaryCompanyNamestringnullable
beneficiaryAddressLine1stringnullable
beneficiaryAddressLine2stringnullable
beneficiaryCitystringnullable
beneficiaryPostalCodestringnullable
beneficiaryStatestringnullable
payoutEntryIdstring<uuid>nullable
failureReasonstringnullable
radomDataRadomEventData

Context for the Radom object that triggered the event.

paymentLinkPaymentLinkDatarequired
paymentLinkIdstring<uuid>required
paymentLinkOrderIdstring<uuid>nullable
inputDataInputData[]nullable
labelstringrequired
valuestringnullable
checkoutSessionCheckoutSessionDatarequired
checkoutSessionIdstring<uuid>required
metadataMetadata[]nullable
keystringrequired
valuestringrequired
invoiceInvoiceDatarequired
invoiceIdstring<uuid>required
invoicePaymentIdstring<uuid>nullable
paymentSessionPaymentSessionDatarequired
paymentSessionIdstring<uuid>required
metadataMetadata[]nullable
keystringrequired
valuestringrequired
subscriptionSubscriptionIdDatarequired
subscriptionIdstring<uuid>required
donationLinkDonationLinkDatarequired
donationLinkIdstring<uuid>required
donationLinkOrderIdstring<uuid>required