Refund
This event is emitted when a refund is processed.
Payload schema
Webhook payload
Use this schema when validating, storing, or transforming the incoming refund 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
refundeventDataobjectrequired
Event-specific payload. The key matches eventType.
refundRefundWebhookDatarequired
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
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullableradomDataRadomEventData
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>requiredOpen banking refunds
For open-banking checkout refunds, Radom uses the existing refund webhook. Successful open-banking refund payloads can include:
eventData.refund.openBankingPaymentData.status
When present, a completed open-banking refund uses refunded. The same object can also include bank rail fields such as paymentScheme, instantPaymentScheme, bankId, bankName, and bankMarket when available.