Skip to main content

Create a payout

POSThttps://api.radom.com/payout

Authorization

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

Request body

payoutsCreatePayoutEntity[]required
namestringnullable
emailstring
accountTypeCustomerAccountTypenullable
AllowedIndividualBusiness
countryOfResidencestringnullable
dateOfBirthstringnullable
companyNamestringnullable
addressLine1stringnullable
addressLine2stringnullable
townOrCitystringnullable
postalCodestringnullable
stateOrProvincestringnullable
payoutAddressstringnullable
networkNetworknullable
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
tokenstringnullable
externalAccountIdstring<uuid>required
gatewaystringrequired
AllowedfiatWithdrawalAccount
withdrawalAccountIdstring<uuid>required
amountnumber<float>required>= 0
amountModePayoutAmountMode
Allowedrecipientsource
sidePayoutQuoteSidenullable
Allowedtofrom
customerIdstring<uuid>nullable
fundingCurrencyPayoutFundingCurrencynullable
accountTypePayoutAccountTypenullable
Allowedbusinessindividual
isTestModebooleannullable
deductFeesbooleannullable
sendEmailReceiptsbooleannullable

Responses

200Payout successfully created
idstring<uuid>required
statusPayoutStatusrequired
AllowedAwaitingConfirmationPendingProcessingCompleteExpiredFailed
isTestModebooleanrequired
accountTypePayoutAccountTypenullable
Allowedbusinessindividual
deductFeesbooleanrequired
sendEmailReceiptsbooleanrequired
totalAmountUsdnumber<float>required
estimatedFeeUsdnumber<float>required
actualFeeUsdnumber<float>nullable
entryCountinteger<int32>required
cryptoEntriesCryptoPayoutEntryResponse[]required
idstring<uuid>required
statusPayoutEntryStatusrequired
AllowedPendingProcessingCompleteFailed
amountnumber<float>required
customerIdstring<uuid>nullable
networkNetworkrequired
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
tokenstringnullable
payoutAddressstringrequired
txHashstringnullable
externalAccountIdstring<uuid>nullable
fundingCurrencyPayoutFundingCurrencynullable
failureReasonstringnullable
hedgePayoutEntryHedgeResponsenullable
fundingCurrencyPayoutFundingCurrencyrequired
fundingNetworkNetworkrequired
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
fundingTokenstringnullable
lockedRatenumber<float>required
midPricenumber<float>required
guaranteedAmountnumber<float>required
feeBuffernumber<float>required
providerWithdrawalFeenumber<float>required
totalCryptoToAcquirenumber<float>required
stableForTradenumber<float>required
conversionFeenumber<float>required
stablecoinCostnumber<float>required
swapIdstring<uuid>nullable
deliveryWithdrawalIdstring<uuid>nullable
fiatEntriesFiatPayoutEntryResponse[]required
idstring<uuid>required
statusPayoutEntryStatusrequired
AllowedPendingProcessingCompleteFailed
amountnumber<float>required
customerIdstring<uuid>nullable
currencyCurrencyrequired
AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC
ibanstringnullable
sortCodestringnullable
bankCodestringnullable
bbanstringnullable
beneficiaryNamestringnullable
beneficiaryEmailstringrequired
beneficiaryCountrystringnullable
beneficiaryDobstringnullable
beneficiaryCompanyNamestringnullable
beneficiaryAddressLine1stringnullable
beneficiaryAddressLine2stringnullable
beneficiaryCitystringnullable
beneficiaryPostalCodestringnullable
beneficiaryStatestringnullable
externalAccountIdstring<uuid>nullable
failureReasonstringnullable
createdAtstring<date-time>required
confirmedAtstring<date-time>nullable
completedAtstring<date-time>nullable
expiresAtstring<date-time>required
400Bad Request
errorstringrequired
401Unauthorized
errorstringrequired
500Internal server error
errorstringrequired