Skip to main content

Get a payment link

GEThttps://api.radom.com/payment_link/{id}

Authorization

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

Parameters

idstring<uuid>pathrequired

Unique identifier for the payment link.

Responses

200Payment link retrieved 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
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
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

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.

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
404Not Found
errorstringrequired
500Internal server error
errorstringrequired