Create a checkout session

POSThttps://api.radom.com/checkout_session

Authorization

Send your API key in the Authorization header. Scheme: radomToken.

Request body

lineItemsCheckoutSessionItem[]nullable

Line items to be purchased.

productIdstring<uuid>nullable

Unique identifier of a product

itemDataCheckoutItemDatanullable

namestringrequired

Name of the product.

descriptionstringnullable

Product description.

chargingIntervalSecondsinteger<int64>nullable

Frequency of subscription payments.

pricenumber<float>required

Price of product (either one time payment or subscription interval charge).

imageUrlstringnullable

An optional image URL of the line item

isMeteredbooleannullable

Whether product has metered billing enabled.

currencyCurrencyrequired

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

sendSubscriptionEmailsbooleannullable

If subscription email reminders should be sent out

nextBillingDateAtstring<date-time>nullable

If this line item is a subscription, optionally set the subscription's next billing date

totalnumber<float>nullable>= 0

Total price of checkout.

currencyCurrencynullable

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

gatewayPaymentGatewaynullable

managedobjectrequired

methodsManagedPaymentMethod[]required

networkNetworkrequired

AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat

tokenstringnullable

discountPercentOffnumber<float>nullable>= 0

selfCustodialobjectrequired

tokensAcceptedToken[]required

tokenAddressstring<address>required

Seller's default token selection.

chainIdinteger<int64>required>= 1

Seller's default EVM-based chain ID.

sellerPaymentAddressstring<address>nullable

openBankingobjectrequired

emailstringrequired

kycDataKycDataRequestnullable

namestringrequired

dateOfBirthstring<date>required

addressstringrequired

residenceCountrystringrequired

phonestringrequired

passportFilestringnullable

idCardFilestringnullable

selfieFilestringnullable

openBankingCheckoutUrlstringnullable

bankIdstringnullable

Radom bank identifier returned by GET /open_banking/banks.

marketCountryCodenullable

AllowedACADAEAFAGAIALAMANAOAPAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBUBVBWBXBYBZCACCCDCFCGCHCICKCLCMCNCOCPCQCRCSCUCVCWCXCYCZDEDGDJDKDMDODYDZEAECEEEFEGEHEMEPERESETEUEVEWEZFIFJFKFLFMFOFRFXGAGBGCGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIBICIDIEILIMINIOIQIRISITJAJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLFLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNTNUNZOAOMPAPEPFPGPHPIPKPLPMPNPRPSPTPWPYQARARBRCRERHRIRLRMRNRORPRSRURWSASBSCSDSESFSGSHSISJSKSLSMSNSOSRSSSTSUSVSXSYSZTATCTDTFTGTHTJTKTLTMTNTOTPTRTTTVTWTZUAUGUMUNUSUYUZVAVCVEVGVIVNVUWFWGWLWOWSWVYEYTYUYVZAZMZRZW

localeLocalenullable

Alloweddenlenfresitptsvplsk

instantPaymentStatusbooleannullable

destinationCryptoAddressstringnullable

onrampAmountstringnullable

existingUserPaidSuccessbooleannullable

successUrlstringrequired

Redirect URL after checkout is completed.

cancelUrlstringnullable

Redirect URL if checkout is cancelled by the user.

subscriptionBackButtonUrlstringnullable

Redirect URL for subscription back button.

metadataMetadata[]nullable

keystringrequired

valuestringrequired

expiresAtinteger<int64>nullable>= 0

Unix UTC timestamp (in seconds) of when the checkout session expires.

customizationsCheckoutCustomizationsnullable

leftPanelColorstringnullable

Left panel background color.

primaryButtonColorstringnullable

Pay button color.

slantedEdgebooleannullable

Left panel slanted edge style.

allowDiscountCodesbooleannullable

Whether discount codes are allowed

displayQrCodebooleannullable

Whether to display a QR code on the checkout page.

allowFreeInputAmountbooleannullable

allow user free input money amount

chargeCustomerNetworkFeebooleannullable

Whether 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.

travelRuleFieldsOptionalTravelRuleFieldsnullable

Travel rule fields, not required for Open Banking checkout sessions.

namestringnullable

emailAddressstringnullable

countryOfResidencestringnullable

dateOfBirthstringnullable

Accepted date formats are YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY or DD/MM/YYYY

companyNamestringnullable

If populated, the account_type will always be set to `Business`

addressLine1stringnullable

Primary address line

addressLine2stringnullable

Second address line

townOrCitystringnullable

Town or city

postalCodestringnullable

Postal or ZIP code

stateOrProvincestringnullable

State or province

accountTypeCustomerAccountTypenullable

AllowedIndividualBusiness

Responses

200Checkout session created successfully

checkoutSessionIdstring<uuid>required

Unique identifier of the checkout session.

checkoutSessionUrlstringrequired

URL of the checkout session.

400Bad Request

errorstringrequired

401Unauthorized

errorstringrequired

500Internal server error

errorstringrequired

502Bad Gateway

errorstringrequired

504Gateway Timeout

errorstringrequired

RequestManaged crypto gateway

{
  "lineItems": [
    {
      "itemData": {
        "name": "Pro plan",
        "price": 29,
        "currency": "USD"
      }
    }
  ],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}

Self-custodial crypto gateway

{
  "lineItems": [
    {
      "itemData": {
        "name": "Pro plan",
        "price": 29,
        "currency": "USD"
      }
    }
  ],
  "gateway": {
    "selfCustodial": {
      "tokens": [
        {
          "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "chainId": 1
        }
      ],
      "sellerPaymentAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}

Open banking gateway

{
  "lineItems": [
    {
      "itemData": {
        "name": "Pro plan",
        "price": 29,
        "currency": "USD"
      }
    }
  ],
  "gateway": {
    "openBanking": {
      "email": "customer@example.com",
      "market": "GB",
      "locale": "en-GB"
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}

Shell

curl -X POST https://api.radom.com/checkout_session \
  -H 'Authorization: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "lineItems": [
    {
      "itemData": {
        "name": "Pro plan",
        "price": 29,
        "currency": "USD"
      }
    }
  ],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}'

Try it