Create payment session
POST
https://api.radom.com/payment_sessionAuthorization
Send your API key in the Authorization header. Scheme: radomToken.
Request body
methodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0totalnumber<float>required>= 0Total price to be paid in the session.
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICalternativeEvmPaymentMethodsEVMPaymentMethod[]nullable
Select additional payment methods that will be accepted on the provided EVM-based payment address. E.g. You can opt to accept USDC on both Ethereum and BNB on the same payment address.
networkEVMNetworkrequiredAllowed
EthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnettokenstringnullablechargeCustomerNetworkFeebooleannullableWhether 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 false.
travelRuleFieldsOptionalTravelRuleFieldsnullable
Travel rule fields, not required for Open Banking checkout sessions.
namestringnullableemailAddressstringnullablecountryOfResidencestringnullabledateOfBirthstringnullableAccepted date formats are YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY or DD/MM/YYYY
companyNamestringnullableIf populated, the account_type will always be set to `Business`
addressLine1stringnullablePrimary address line
addressLine2stringnullableSecond address line
townOrCitystringnullableTown or city
postalCodestringnullablePostal or ZIP code
stateOrProvincestringnullableState or province
accountTypeCustomerAccountTypenullableAllowed
IndividualBusinessmetadataMetadata[]nullable
Associated metadata
keystringrequiredvaluestringrequiredResponses
200Payment session created successfully.
idstring<uuid>requiredmethodManagedPaymentMethodrequired
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullablediscountPercentOffnumber<float>nullable>= 0totalnumber<float>required>= 0Total price to be paid in the session.
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICsessionStatusPaymentSessionStatusrequiredAllowed
pendingsuccesscancelledexpiredrefundedpaymentTotalnumber<float>required>= 0The payment amount to be sent by the buyer to the payment address.
paymentAddressstringnullableThe payment address the buyer should send the payment amount to.
transactionsManagedTransaction[]required
Transactions, if any, made by the buyer to the payment address
networkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattransactionHashstringrequiredtokenstringnullableamountnumber<float>required>= 0blockTimestampstring<date-time>requiredtickerstringnullablesenderAddressesSenderAddress[]required
addressstringrequiredcanExtendbooleanrequiredIf the payment session's expiration time can be extended to allow more time to checkout.
alternativeEvmPaymentMethodsAlternativeEVMPaymentMethod[]nullable
Additional payment methods that will be accepted on the provided EVM-based payment address.
networkEVMNetworkrequiredAllowed
EthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnettokenstringnullablepaymentTotalnumber<float>required>= 0The total amount expected if paid using this alternative payment method.
networkFeenumber<float>nullable>= 0expiresAtstring<date-time>nullableThe time when the payment expires. After this time has passed, funds sent to the payment address will not trigger a successful payment.
createdAtstring<date-time>requiredCreation time of the payment session.
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
emailstringnullablephoneNumberstringnullablepaymentReferencestringnullableendToEndIdstringnullableremittanceInformationstringnullablesenderNamestringnullablesenderIbanstringnullablesenderBicstringnullablesenderSortCodestringnullablesenderAccountNumberstringnullablesenderBankCodestringnullablesenderBbanstringnullablepaymentSummaryPaymentSummarynullable
currencyCurrencyrequiredAllowed
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATICgrossAmountnumber<float>required>= 0underpaidAmountnumber<float>required>= 0overpaidAmountnumber<float>required>= 0netAmountnumber<float>required>= 0networkFeeAmountnumber<float>required>= 0radomFeeAmountnumber<float>required>= 0feeAmountnumber<float>required>= 0conversionRatesConversionRate[]nullable
The conversion rates used to calculate the payment totals.
fromstringrequiredtostringrequiredratenumber<float>required>= 0refundsRefundDetails[]required
If a refund is issued, this field will be populated with the refund details.
statusRefundStatusrequiredAllowed
pendingsuccesscancelledfailednetworkNetworkrequiredAllowed
BitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiattokenstringnullableamountnumber<float>nullable>= 0chargeCustomerNetworkFeebooleanrequiredrecipientAddressstringrequiredtransactionHashstringnullablecreatedAtstring<date-time>requiredmetadataMetadata[]required
Metadata associated with this payment session
keystringrequiredvaluestringrequiredtravelRuleFieldsIdstring<uuid>nullableId of associated travel rule fields entry
400Bad Request
errorstringrequired401Unauthorized
errorstringrequired500Internal server error
errorstringrequired