Deposit
This event is emitted when a deposit is processed.
Payload schema
Webhook payload
Use this schema when validating, storing, or transforming the incoming deposit webhook payload.
idstring<uuid>requiredUnique identifier for this webhook delivery.
webhookIdstring<uuid>requiredIdentifier of the webhook configuration that produced this delivery.
eventTypestringrequiredDiscriminator for the event. Always the value shown here for this event.
Allowed
depositeventDataobjectrequired
Event-specific payload. The key matches eventType.
depositDepositDatarequired
depositIdstring<uuid>requireddepositAccountIdstring<uuid>requireddepositAccountNamestringrequireddepositMethodDepositMethodrequired
CryptoCryptoDepositMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableFiatFiatDepositMethodrequired
fiatCurrencyNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiatonrampNetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiatonrampTokenstringnullablefiatGrossAmountnumber<float>nullable>= 0grossAmountnumber<float>required>= 0netAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0depositedAtstring<date-time>requiredbeneficiaryDetailsBridgeVirtualAccountBeneficiaryDetailsAnynullable
imadstringrequiredbank_namestringnullablepayment_railstringnullablepayment_schemestringnullablewire_messagestringnullableoriginator_namestringnullablesender_namestringnullableoriginator_addressstringnullableoriginator_ibanstringnullablesender_ibanstringnullablesender_account_numberstringnullablebank_routing_numberstringnullablesender_bank_namestringnullablesender_bank_routing_numberstringnullablebank_beneficiary_namestringnullablebank_beneficiary_addressstringnullablereferencestringnullablepayment_referencestringnullableend_to_end_idstringnullableremittance_informationstringnullablebicstringnullableuetrstringrequirediban_last_4stringnullableibanstringnullablerecipient_namestringnullabledescriptionstringnullableach_memostringnullabletrace_numberstringrequiredtransactionHashstringnullablesenderAddressesSenderAddress[]nullable
addressstringrequiredradomDataRadomEventData
Context for the Radom object that triggered the event.
paymentLinkPaymentLinkDatarequired
paymentLinkIdstring<uuid>requiredpaymentLinkOrderIdstring<uuid>nullableinputDataInputData[]nullable
labelstringrequiredvaluestringnullablecheckoutSessionCheckoutSessionDatarequired
checkoutSessionIdstring<uuid>requiredmetadataMetadata[]nullable
keystringrequiredvaluestringrequiredinvoiceInvoiceDatarequired
invoiceIdstring<uuid>requiredinvoicePaymentIdstring<uuid>nullablepaymentSessionPaymentSessionDatarequired
paymentSessionIdstring<uuid>requiredmetadataMetadata[]nullable
keystringrequiredvaluestringrequiredsubscriptionSubscriptionIdDatarequired
subscriptionIdstring<uuid>requireddonationLinkDonationLinkDatarequired
donationLinkIdstring<uuid>requireddonationLinkOrderIdstring<uuid>required