Payment
This event is emitted when a one-time payment is completed successfully. Note that the radomData object changes according to the type of checkout.
Payload schema
Webhook payload
Use this schema when validating, storing, or transforming the incoming managedPayment 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
managedPaymenteventDataobjectrequired
Event-specific payload. The key matches eventType.
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
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 checkout sessions
For open-banking checkout sessions, managedPayment remains the final successful-payment webhook. Do not fulfill from the browser redirect alone.
When the payment used open banking, the payload can include:
eventData.managedPayment.openBankingPaymentData
Common fields include:
| Field | Description |
|---|---|
status | Provider lifecycle status. Successful open-banking payments use paid; pending checkout/session reads can show values such as processing, waiting_for_payment, authorized, or finalizing. |
onrampStatus | Radom settlement status. This is separate from the provider lifecycle status. |
paymentScheme | Bank rail or payment scheme when supplied, for example Sepa Credit, Sepa Instant, or Faster Payments. |
instantPaymentScheme | Whether the provider identified the rail as instant. |
bankId, bankName, bankMarket | Bank details when available, including bank preselection metadata. |
statusHistoryList | Provider status history when supplied. |
paymentReference, endToEndId, remittanceInformation | Bank references for reconciliation when supplied. |
Use the checkout session response while the transfer is still pending. Standard rails such as SEPA Credit can be sent before funds arrive, so keep fulfillment pending until this final managedPayment webhook or a final successful checkout status.
Examples
- Payment link
- Checkout session
{
"id": "f01fa77a-6f71-45fd-884e-4212ec76e9e9",
"webhookId": "ad474121-b97e-479b-a180-60a21bda8532",
"eventType": "managedPayment",
"eventData": {
"managedPayment": {
"paymentMethod": {
"network": "SolanaDevnet",
"token": null
},
"amount": "0.05174000000",
"transactions": [
{
"network": "SolanaDevnet",
"transactionHash": "Biqv82rkELugxVFVUrcobxabNvUztxno9vCBDLdnQUzBqNmacbMKtuSAF9srJPQq8CWpA47rpL8skkt2MTEsZvk",
"token": null,
"amount": "0.0520",
"blockTimestamp": "2023-06-06T06:11:42Z"
}
]
}
},
"radomData": {
"paymentLink": {
"paymentLinkId": "9353ac9f-d44e-4acf-a18e-83189422363a",
"paymentLinkOrderId": "aa697c4e-c489-4dd4-813d-1f9e8ad19745",
"inputData": [
{
"label": "Name",
"value": "Adam"
},
{
"label": "Email address",
"value": "adam@example.com"
}
]
}
}
}
{
"id": "456c95b0-85a3-4415-b60f-0e21707a0774",
"webhookId": "69798cea-0be8-4176-9178-d83d4e00d158",
"eventType": "managedPayment",
"eventData": {
"managedPayment": {
"paymentMethod": {
"network": "SepoliaTestnet",
"token": "0xa4fce8264370437e718ae207805b4e6233638b9e"
},
"amount": "42.790671",
"transactions": [
{
"network": "SepoliaTestnet",
"transactionHash": "0xbd57aa3597e79fe97017842d42b9badb40cd881163c937f9a25311e338503ede",
"token": "0xa4fce8264370437e718ae207805b4e6233638b9e",
"amount": "43.50564900",
"blockTimestamp": "2024-02-05T16:53:48Z"
}
]
}
},
"radomData": {
"checkoutSession": {
"checkoutSessionId": "343d51bc-8ccb-4502-80e2-fc908291e768",
"metadata": [
{
"key": "test-metadata",
"value": "some-id"
}
]
}
}
}