Get webhook messages by webhook
GET
https://api.radom.com/webhook/{id}/messagesAuthorization
Send your API key in the Authorization header. Scheme: radomToken.
Parameters
idstring<uuid>pathrequiredUnique identifier for the webhook.
limitinteger<int64>queryNumber of webhook messages to return.
offsetinteger<int64>queryOffset for pagination
statusWebhookMessageStatus[]queryFilter by message statuses
Responses
200Webhook message collection found successfully
dataWebhookMessage[]required
idstring<uuid>requiredwebhookIdstring<uuid>requiredmessagePayloadWebhookMessagePayloadrequired
idstring<uuid>nullablewebhookIdstring<uuid>nullableeventTypeWebhookEventrequiredAllowed
paymentordermanagedPaymentmanagedRecurringPaymentpaymentTransactionDetectedpaymentTransactionConfirmedmanagedWithdrawalnewSubscriptionincompletePaymentsubscriptionCancelledsubscriptionExpiredsubscriptionPaymentsubscriptionPaymentAttemptFailuresubscriptionPaymentOverduesubscriptionPaymentReminderrefundonramppayoutdeposittesteventDataWebhookEventDatarequired
managedPaymentManagedPaymentrequired
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0alternativeMethodPaymentsAlternativeMethodPayment[]nullable
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0transactionsManagedEventTransaction[]nullable
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]nullable
addressstringrequireddiscountCodeIdstring<uuid>nullablediscountAmountnumber<float>required>= 0paymentSummaryPaymentSummarynullable
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgrossAmountnumber<float>required>= 0underpaidAmountnumber<float>required>= 0overpaidAmountnumber<float>required>= 0netAmountnumber<float>required>= 0networkFeeAmountnumber<float>required>= 0radomFeeAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0conversionRatesConversionRate[]nullable
fromstringrequiredtostringrequiredratenumber<float>required>= 0tokenDiscountAmountnumber<float>required>= 0discountTotalnumber<float>required>= 0openBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablemanagedRecurringPaymentManagedPaymentrequired
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0alternativeMethodPaymentsAlternativeMethodPayment[]nullable
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0transactionsManagedEventTransaction[]nullable
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]nullable
addressstringrequireddiscountCodeIdstring<uuid>nullablediscountAmountnumber<float>required>= 0paymentSummaryPaymentSummarynullable
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgrossAmountnumber<float>required>= 0underpaidAmountnumber<float>required>= 0overpaidAmountnumber<float>required>= 0netAmountnumber<float>required>= 0networkFeeAmountnumber<float>required>= 0radomFeeAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0conversionRatesConversionRate[]nullable
fromstringrequiredtostringrequiredratenumber<float>required>= 0tokenDiscountAmountnumber<float>required>= 0discountTotalnumber<float>required>= 0openBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablepaymentTransactionDetectedPaymentTransactionWebhookDatarequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0senderAddressesSenderAddress[]nullable
addressstringrequiredtransactionHashstringrequiredpaymentTransactionConfirmedPaymentTransactionWebhookDatarequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0senderAddressesSenderAddress[]nullable
addressstringrequiredtransactionHashstringrequiredmanagedWithdrawalWithdrawalDatarequired
withdrawalRequestIdstring<uuid>requirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablewithdrawalAmountnumber<float>required>= 0recipientAddressstringnullabletransactionHashstringnullableisSuccessbooleanrequiredfailureReasonstringnullablereceiptWithdrawalReceiptnullable
EVMReceiptEVMReceiptrequired
transactionHashstringnullablenetworkFeeAmountnumber<float>nullable>= 0BTCReceiptBTCReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0BSVReceiptBSVReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0DOGEReceiptDOGEReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0LTCReceiptLTCReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0BCHReceiptBCHReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0XMRReceiptXMRReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0SOLReceiptSOLReceiptrequired
signaturestringnullablenetworkFeeAmountnumber<float>nullable>= 0DOTReceiptDOTReceiptrequired
transactionHashstringnullablenetworkFeeAmountnumber<float>nullable>= 0FiatReceiptFiatReceiptrequired
finalAmountstringnullabletransferMethodTransferMethodnullableAllowed
SepaAchWireflatFeenumber<float>nullable>= 0percentFeenumber<float>nullable>= 0transactionHashstringnullabledestinationWithdrawalDestinationnullable
uetrstringnullablecurrencystringnullablepaymentRailstringnullabletraceNumberstringnullableexternalAccountIdstringnullableincompletePaymentManagedPaymentrequired
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0alternativeMethodPaymentsAlternativeMethodPayment[]nullable
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0transactionsManagedEventTransaction[]nullable
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]nullable
addressstringrequireddiscountCodeIdstring<uuid>nullablediscountAmountnumber<float>required>= 0paymentSummaryPaymentSummarynullable
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgrossAmountnumber<float>required>= 0underpaidAmountnumber<float>required>= 0overpaidAmountnumber<float>required>= 0netAmountnumber<float>required>= 0networkFeeAmountnumber<float>required>= 0radomFeeAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0conversionRatesConversionRate[]nullable
fromstringrequiredtostringrequiredratenumber<float>required>= 0tokenDiscountAmountnumber<float>required>= 0discountTotalnumber<float>required>= 0openBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablenewSubscriptionNewSubscriptionWebhookDatarequired
subscriptionIdstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullablecreatedAtstring<date-time>requiredtagsSubscriptionTagsnullable
productIdstring<uuid>nullablenamestringnullableimageUrlstringnullablesubscriptionCancelledSubscriptionCancelledWebhookDatarequired
subscriptionIdstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullablecreatedAtstring<date-time>requiredcancelledAtstring<date-time>requiredtagsSubscriptionTagsnullable
productIdstring<uuid>nullablenamestringnullableimageUrlstringnullablesubscriptionExpiredSubscriptionExpiredWebhookDatarequired
subscriptionIdstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullablecreatedAtstring<date-time>requiredexpiredAtstring<date-time>requiredtagsSubscriptionTagsnullable
productIdstring<uuid>nullablenamestringnullableimageUrlstringnullablesubscriptionPaymentPaymentDatarequired
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0alternativeMethodPaymentsAlternativeMethodPayment[]nullable
paymentMethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0amountnumber<float>required>= 0transactionsManagedEventTransaction[]nullable
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]nullable
addressstringrequireddiscountCodeIdstring<uuid>nullablediscountAmountnumber<float>required>= 0paymentSummaryPaymentSummarynullable
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgrossAmountnumber<float>required>= 0underpaidAmountnumber<float>required>= 0overpaidAmountnumber<float>required>= 0netAmountnumber<float>required>= 0networkFeeAmountnumber<float>required>= 0radomFeeAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0conversionRatesConversionRate[]nullable
fromstringrequiredtostringrequiredratenumber<float>required>= 0radomDataRadomEventDatarequired
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>requiredtokenDiscountAmountstringnullablediscountTotalstringnullableopenBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablesubscriptionPaymentAttemptFailureSubscriptionPaymentAttemptFailureDatarequired
subscriptionIdstring<uuid>requiredfailureReasonSubscriptionPaymentAttemptFailureReasonrequiredAllowed
insufficientAllowanceinsufficientBalancegasCostGreaterThanSubscriptionCostsubscriptionPaymentReminderSubscriptionDatarequired
subscriptionIdstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullablecreatedAtstring<date-time>requiredtagsSubscriptionTagsnullable
productIdstring<uuid>nullablenamestringnullableimageUrlstringnullableradomDataRadomEventDatanullable
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>requiredsubscriptionPaymentOverdueSubscriptionDatarequired
subscriptionIdstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullablecreatedAtstring<date-time>requiredtagsSubscriptionTagsnullable
productIdstring<uuid>nullablenamestringnullableimageUrlstringnullableradomDataRadomEventDatanullable
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>requiredrefundRefundWebhookDatarequired
refundIdstring<uuid>requirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablewithdrawalAmountnumber<float>required>= 0isSuccessbooleanrequiredfailureReasonstringnullablereceiptWithdrawalReceiptnullable
EVMReceiptEVMReceiptrequired
transactionHashstringnullablenetworkFeeAmountnumber<float>nullable>= 0BTCReceiptBTCReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0BSVReceiptBSVReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0DOGEReceiptDOGEReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0LTCReceiptLTCReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0BCHReceiptBCHReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0XMRReceiptXMRReceiptrequired
transactionIdstringnullablenetworkFeeAmountnumber<float>nullable>= 0SOLReceiptSOLReceiptrequired
signaturestringnullablenetworkFeeAmountnumber<float>nullable>= 0DOTReceiptDOTReceiptrequired
transactionHashstringnullablenetworkFeeAmountnumber<float>nullable>= 0FiatReceiptFiatReceiptrequired
finalAmountstringnullabletransferMethodTransferMethodnullableAllowed
SepaAchWireflatFeenumber<float>nullable>= 0percentFeenumber<float>nullable>= 0transactionHashstringnullableopenBankingPaymentDataOpenBankingPaymentDatanullable
statusstringnullableProvider payment lifecycle status for open-banking payments. This is optional and remains a string so Radom can pass through future provider statuses without breaking clients.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedbankStatementReferencestringrequiredonrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledpayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablebankIdstringnullablebankNamestringnullablebankMarketstringnullablepaymentSchemestringnullableinstantPaymentSchemebooleannullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullableonrampOnrampDatarequired
onrampIdstring<uuid>requiredstatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledreceiptOnrampReceiptnullable
finalAmountstringnullableexchangeRatestringnullabletxHashstringnullablepayoutPayoutDatarequired
payoutIdstring<uuid>requiredstatusPayoutStatusrequiredAllowed
AwaitingConfirmationPendingProcessingCompleteExpiredFailedtotalAmountUsdnumber<float>nullableTotal payout amount in USD
estimatedFeeUsdnumber<float>nullableEstimated fee in USD
actualFeeUsdnumber<float>nullableActual fee in USD (available after completion)
entryCountinteger<int32>nullableNumber of entries in this payout
completedPayoutsPayoutEntry[]nullable
idstring<uuid>requiredstatusPayoutEntryStatusrequiredAllowed
PendingProcessingCompleteFailedamountnumber<float>requiredinitialAmountnumber<float>nullablecustomerIdstring<uuid>nullablenetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablepayoutAddressstringrequiredtxHashstringnullableexternalAccountIdstring<uuid>nullablefundingCurrencyPayoutFundingCurrencynullablefailureReasonstringnullabletypestringrequiredAllowed
fiatcurrencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICibanstringnullablesortCodestringnullablebankCodestringnullablebbanstringnullablebeneficiaryEmailstringrequiredbeneficiaryNamestringnullablebeneficiaryCountrystringnullablebeneficiaryDobstringnullablebeneficiaryCompanyNamestringnullablebeneficiaryAddressLine1stringnullablebeneficiaryAddressLine2stringnullablebeneficiaryCitystringnullablebeneficiaryPostalCodestringnullablebeneficiaryStatestringnullablepayoutEntryIdstring<uuid>nullablefailureReasonstringnullabledepositDepositDatarequired
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
addressstringrequiredtestWebhookTestDatarequired
sentAtinteger<int64>requiredradomDataRadomEventDatanullable
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>requiredmessageStatusWebhookMessageStatusrequiredAllowed
PendingSuccessFailedWebhookDoesNotExistcreatedAtstring<date-time>requirednextDeliveryAttemptTimestampstring<date-time>requirednumFailedDeliveryAttemptsinteger<int32>requireddeliveryResponseStatusCodeinteger<int32>nullabletotalinteger<int64>required401Unauthorized
errorstringrequired404Not Found
errorstringrequired500Internal server error
errorstringrequired