Get a checkout session
GET
https://api.radom.com/checkout_session/{id}Authorization
Send your API key in the Authorization header. Scheme: radomToken.
Parameters
idstring<uuid>pathrequiredUnique identifier for the checkout session.
refreshOpenBankingStatusbooleanqueryRefresh open-banking provider status from Ivy/Augustus before returning the checkout session. Defaults to false so ordinary checkout page loads do not depend on a live provider read.
Responses
200Checkout session retrieved successfully
idstring<uuid>requiredUnique identifier for the checkout session.
sessionStatusCheckoutSessionStatusrequiredAllowed
pendingsuccesscancelledexpiredrefundedrefundFailedorganizationIdstring<uuid>requiredProduct's owning organization ID.
productsCheckoutProduct[]nullable
idstring<uuid>requiredUnique identifier for the product.
organizationIdstring<uuid>requiredProduct's owning organization ID.
namestringrequiredName of the product.
descriptionstringrequiredProduct description.
chargingIntervalSecondsinteger<int64>requiredFrequency of subscription payments.
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICpricenumber<float>requiredPrice of product (either one time payment or subscription charge).
imageUrlstringrequiredURL of image to use for the product.
sendSubscriptionEmailsbooleannullableproductTypeProductTypenullable
PresalePresalerequired
TokenTokenPresalerequired
tickerstringrequireddecimalsinteger<int32>required>= 0nextBillingDateAtstring<date-time>nullableitemsCheckoutItemData[]nullable
namestringrequiredName of the product.
descriptionstringnullableProduct description.
chargingIntervalSecondsinteger<int64>nullableFrequency of subscription payments.
pricenumber<float>requiredPrice of product (either one time payment or subscription interval charge).
imageUrlstringnullableAn optional image URL of the line item
isMeteredbooleannullableWhether product has metered billing enabled.
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICsendSubscriptionEmailsbooleannullableIf subscription email reminders should be sent out
nextBillingDateAtstring<date-time>nullabletotalnumber<float>nullable>= 0Total price of checkout
currencyCurrencynullableAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgatewayPaymentGatewayrequired
managedobjectrequired
methodsManagedPaymentMethod[]required
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0selfCustodialobjectrequired
tokensAcceptedToken[]required
tokenAddressstring<address>requiredSeller's default token selection.
chainIdinteger<int64>required>= 1Seller's default EVM-based chain ID.
sellerPaymentAddressstring<address>nullableopenBankingobjectrequired
emailstringrequiredkycDataKycDataRequestnullable
namestringrequireddateOfBirthstring<date>requiredaddressstringrequiredresidenceCountrystringrequiredphonestringrequiredpassportFilestringnullableidCardFilestringnullableselfieFilestringnullableopenBankingCheckoutUrlstringnullablebankIdstringnullableRadom bank identifier returned by GET /open_banking/banks.
marketCountryCodenullableAllowed
ACADAEAFAGAIALAMANAOAPAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBXBYBZCACCCDCFCGCHCICKCLCMCNCOCPCQCRCSCUCVCWCXCYCZDEDGDJDKDMDODYDZEAECEEEFEGEHEMEPERESETEUEVEWEZFIFJFKFLFMFOFRFXGAGBGCGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIBICIDIEILIMINIOIQIRISITJAJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLFLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOAOMPAPEPFPGPHPIPKPLPMPNPRPSPTPWPYQARARBRCRERHRIRLRMRNRORPRSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUMUNUSUYUZVAVCVEVGVIVNVUWFWGWLWOWSWVYEYTYUYVZAZMZRZWlocaleLocalenullableAllowed
denlenfresitptsvplskinstantPaymentStatusbooleannullabledestinationCryptoAddressstringnullableonrampAmountstringnullableexistingUserPaidSuccessbooleannullablesuccessUrlstringrequiredRedirect URL after checkout is completed.
cancelUrlstringnullableRedirect URL if checkout fails.
subscriptionBackButtonUrlstringnullableURL for subscription cancel/back button.
metadataMetadata[]nullable
keystringrequiredvaluestringrequiredexpiresAtstring<date-time>nullableTime at which the checkout session expires.
createdAtstring<date-time>requiredTime at which the checkout session was created.
updatedAtstring<date-time>requiredTime at which the checkout session was last updated.
customizationsCheckoutCustomizationsrequired
leftPanelColorstringnullableLeft panel background color.
primaryButtonColorstringnullablePay button color.
slantedEdgebooleannullableLeft panel slanted edge style.
allowDiscountCodesbooleannullableWhether discount codes are allowed
displayQrCodebooleannullableWhether to display a QR code on the checkout page.
allowFreeInputAmountbooleannullableallow user free input money amount
paymentPaymentDetailsnullable
managedobjectrequired
idstring<uuid>requiredpaymentEventIdstring<uuid>nullablenetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0networkFeenumber<float>required>= 0transactionsManagedTransaction[]required
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]required
addressstringrequiredconversionRatesConversionRate[]required
fromstringrequiredtostringrequiredratenumber<float>required>= 0managedTokenDelegatePaymentobjectrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0transactionsManagedTransaction[]required
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]required
addressstringrequiredconversionRatesConversionRate[]required
fromstringrequiredtostringrequiredratenumber<float>required>= 0openBankingobjectrequired
idstring<uuid>requiredpaymentEventIdstring<uuid>nullablenetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0onrampStatusOnrampStatusrequiredAllowed
AwaitingFundsFundsReceivedPaymentSubmittedCompleteCancelledonrampGrossAmountstringnullableonrampNetAmountstringnullableonrampNetworkNetworknullableAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiatonrampTokenstringnullableonrampFeestringnullableopenBankingPaymentDataOpenBankingPaymentDatanullable
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
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablerefundsRefundDetails[]required
If a refund is issued, this field will be populated with the refund details.
statusRefundStatusrequiredAllowed
pendingsuccesscancelledfailednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>nullable>= 0chargeCustomerNetworkFeebooleanrequiredrecipientAddressstringrequiredtransactionHashstringnullablecreatedAtstring<date-time>requiredchargeCustomerNetworkFeebooleanrequiredWhether or not to pass the network fee to the customer to pay, in addition to the total supplied. If this is false, the network fee is subtracted from the supplied total, otherwise, it's added to the total. Defaults to true.
travelRuleFieldsTravelRuleFieldsCollectionStatusrequired
countryOfResidenceCollectedbooleanrequireddateOfBirthCollectedbooleanrequiredemailAddressCollectedbooleanrequirednameCollectedbooleanrequiredcompanyNameCollectedbooleanrequiredaccountTypeCustomerAccountTypenullableAllowed
IndividualBusinesstravelRuleEmailstringnullableassociatedSubscriptionsManagedSubscriptionSummary[]required
Zero or more subscriptions associated with orders created from this checkout session.
idstring<uuid>requiredsubscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequiredsubscriptionContractAddressstringrequiredrecommendedAllowanceDurationinteger<int64>nullable>= 0emailAddressstringnullableemailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequiredstatusSubscriptionStatusrequiredAllowed
activecancelledexpirednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>required>= 0currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICperiodManagedSubscriptionPeriodrequiredAllowed
dailyweeklymonthlyquarterlyannuallycustomperiodCustomDurationinteger<int64>nullabletagsobjectnullablenextBillingDateAtstring<date-time>requiredcreatedAtstring<date-time>requiredcancelledAtstring<date-time>nullableexpiredAtstring<date-time>nullablesendSubscriptionEmailsbooleanrequiredchargeCustomerNetworkFeebooleanrequiredmetadataJsonnullablecustomerIdstring<uuid>nullableopenBankingPaymentDataCheckoutSessionOpenBankingDatanullable
statusstringrequiredProvider payment lifecycle status for the open-banking checkout session.
Allowed
processingwaiting_for_paymentauthorizedfinalizingpaidfailedcanceledcancelledin_refundpartially_refundedrefundedrefund_failedpaymentSchemestringnullableinstantPaymentSchemebooleannullablepayerFinancialAddressPayerFinancialAddressnullable
ibanIbannullable
ibanstringrequiredaccountHolderNamestringnullablebicstringnullablesortCodeSortCodenullable
sortCodestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebankCodeBankCodenullable
codestringrequiredaccountNumberstringrequiredaccountHolderNamestringnullablebbanBbannullable
bbanstringrequiredaccountHolderNamestringnullablebicstringnullablestatusHistoryListOrderStatusHistoryEntry[]nullable
currentStatusstringreasonstringcreatedAtstringupdatedAtstringpreviousStatusstringnullableshopperShoppernullable
emailstringnullablephoneNumberstringnullable404Not Found
errorstringrequired500Internal server error
errorstringrequired502Bad Gateway
errorstringrequired504Gateway Timeout
errorstringrequired