Create a payment link

POSThttps://api.radom.com/payment_link/create

Authorization

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

Request body

productsstring[]required

Product identifiers associated with the payment link.

gatewayPaymentGatewayrequired

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

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

successUrlstringnullable

URL to direct to upon successful checkout.

cancelUrlstringnullable

URL to direct to upon cancelled/failed checkout.

inputFieldsInputField[]nullable

Optional list of input fields to accept on checkout.

inputLabelstringrequired

isRequiredbooleanrequired

dataTypeInputFieldDataTyperequired

AllowedStringNumberEmailAddressEthereumAddressSolanaAddressCountryOfResidenceDate

sendEmailReceiptbooleannullable

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.

presaleDataPresaleRequestDatanullable

totalRaiseAmountnumber<float>nullable>= 0

startsAtstring<date-time>nullable

endsAtstring<date-time>nullable

minimumPurchaseAmountnumber<float>nullable>= 0

pricingStrategiesPricingStrategynullable

timeBasedTimeBasedStrategynullable

startsAtstring<date-time>required

roundDurationSecondsnumber<float>required

priceIncreasePercentagenumber<float>required

amountBasedAmountBasedStrategy[]nullable

namestringrequired

priceIncreaseTonumber<float>required

targetAmountnumber<float>required

customizationsTokenPresaleCustomizationsnullable

titlestringnullable

bonusTitlenumber<float>nullable>= 20

titleFontSizenumber<float>nullable>= 10

titleFontColorstringnullable

titleFontFamilystringnullable

hideTotalRaiseGoalbooleannullable

bonusTokenPresaleBonusLevels[]nullable

greaterThaninteger<int32>required

lessThaninteger<int32>required

bonusinteger<int32>required

Responses

200Payment link created successfully

idstring<uuid>required

Unique identifier for the payment link.

urlstringrequired

URL of the payment link.

organizationIdstring<uuid>required

Organization ID.

sellerNamestringnullable

Product seller's name.

sellerLogoUrlstringnullable

Product seller's logo URL.

productsProductSummary[]required

Products associated with the payment link.

idstring<uuid>required

Unique identifier for the product.

organizationIdstring<uuid>required

Product's owning organization ID.

namestringrequired

Name of the product.

descriptionstringrequired

Product description.

chargingIntervalSecondsinteger<int64>required

Frequency of subscription payments.

currencyCurrencyrequired

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

pricenumber<float>required

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

imageUrlstringrequired

URL of image to use for the product.

createdAtstring<date-time>required

Time at which product was created.

updatedAtstring<date-time>required

Time at which product was last updated.

isArchivedbooleannullable

True if product is archived on dashboard

sendSubscriptionEmailsbooleannullable

productTypeProductTypenullable

PresalePresalerequired

TokenTokenPresalerequired

tickerstringrequired

decimalsinteger<int32>required>= 0

gatewayPaymentGatewayrequired

managedobjectrequired

methodsManagedPaymentMethod[]required

networkNetworkrequired

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

localeLocalenullable

Alloweddenlenfresitptsvplsk

instantPaymentStatusbooleannullable

destinationCryptoAddressstringnullable

onrampAmountstringnullable

existingUserPaidSuccessbooleannullable

createdAtstring<date-time>required

Time at which product was created.

updatedAtstring<date-time>required

Time at which product was last updated.

customizationsCheckoutCustomizationsrequired

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

successUrlstringnullable

URL to direct to upon successful checkout.

cancelUrlstringnullable

URL to direct to upon cancelled/failed checkout.

inputFieldsInputField[]nullable

JSON object containing an array of 0 or more custom inputs

inputLabelstringrequired

isRequiredbooleanrequired

dataTypeInputFieldDataTyperequired

AllowedStringNumberEmailAddressEthereumAddressSolanaAddressCountryOfResidenceDate

sendEmailReceiptbooleanrequired

chargeCustomerNetworkFeebooleanrequired

isPresalebooleanrequired

isArchivedbooleanrequired

presaleDataPresaleDatanullable

tokenPresaleDataTokenPresaleEntityrequired

idstring<uuid>required

organizationIdstring<uuid>required

paymentLinkIdstring<uuid>required

currencyCurrencyrequired

AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC

totalRaiseAmountnumber<float>nullable>= 0

totalAmountRaisednumber<float>required>= 0

startsAtstring<date-time>nullable

endsAtstring<date-time>nullable

minimumPurchaseAmountnumber<float>nullable>= 0

pricingStrategiesPricingStrategynullable

timeBasedTimeBasedStrategynullable

startsAtstring<date-time>required

roundDurationSecondsnumber<float>required

priceIncreasePercentagenumber<float>required

amountBasedAmountBasedStrategy[]nullable

namestringrequired

priceIncreaseTonumber<float>required

targetAmountnumber<float>required

customizationsTokenPresaleCustomizationsnullable

titlestringnullable

bonusTitlenumber<float>nullable>= 20

titleFontSizenumber<float>nullable>= 10

titleFontColorstringnullable

titleFontFamilystringnullable

hideTotalRaiseGoalbooleannullable

createdAtstring<date-time>required

bonusJsonnullable

400Bad Request

errorstringrequired

401Unauthorized

errorstringrequired

500Internal server error

errorstringrequired

RequestManaged crypto gateway

{
  "products": [
    "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
  ],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}

Self-custodial crypto gateway

{
  "products": [
    "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
  ],
  "gateway": {
    "selfCustodial": {
      "tokens": [
        {
          "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
          "chainId": 1
        }
      ],
      "sellerPaymentAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}

Open banking gateway

{
  "products": [
    "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
  ],
  "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/payment_link/create \
  -H 'Authorization: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "products": [
    "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
  ],
  "gateway": {
    "managed": {
      "methods": [
        {
          "network": "Ethereum",
          "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
        }
      ]
    }
  },
  "successUrl": "https://example.com/checkout/success",
  "cancelUrl": "https://example.com/checkout/cancel"
}'

Try it