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

AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetOpBnbFiat

tokenstringnullable

externalAccountIdstring<uuid>required

gatewaystringrequired

AllowedfiatWithdrawalAccount

withdrawalAccountIdstring<uuid>required

amountnumber<float>required>= 0

amountModePayoutAmountMode

Allowedrecipientsource

sidePayoutQuoteSidenullable

Allowedtofrom

customerIdstring<uuid>nullable

fundingCurrencyPayoutFundingCurrencynullable

fundingAssetcrate.db.PayoutFundingAssetnullable

accountTypePayoutAccountTypenullable

Allowedbusinessindividual

isTestModebooleannullable

deductFeesbooleannullable

sendEmailReceiptsbooleannullable

autoConfirmbooleannullable

idempotencyKeystringnullable

Client-generated key (e.g. a UUID) making creation retry-safe: a request resubmitted with the same key returns the already-created payout instead of creating and debiting a second one.

allowDuplicatebooleannullable

A payout to the same destination for the same amount as one created in the last few minutes is refused with 409 unless this is set: it is the shape of a client retry or a double submission, not of a new order.

Responses

200Payout successfully created

idstring<uuid>required

statusPayoutStatusrequired

AllowedAwaitingConfirmationPendingProcessingCompleteExpiredInReviewConvertingFailed

isTestModebooleanrequired

accountTypePayoutAccountTypenullable

Allowedbusinessindividual

deductFeesbooleanrequired

sendEmailReceiptsbooleanrequired

totalAmountUsdnumber<float>required

estimatedFeeUsdnumber<float>required

actualFeeUsdnumber<float>nullable

entryCountinteger<int32>required

fundingCurrencystringnullable

fundingAssetradom_common_rust.db.PayoutFundingAssetnullable

fundingWithdrawalIdsstring[]

fundingConversionIdsstring[]

fundingConversionErrorstringnullable

processingStagestringnullable

cryptoEntriesCryptoPayoutEntryResponse[]required

idstring<uuid>required

statusPayoutEntryStatusrequired

AllowedPendingProcessingCompleteInReviewFailed

amountnumber<float>required

customerIdstring<uuid>nullable

networkNetworkrequired

AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetOpBnbFiat

tokenstringnullable

payoutAddressstringrequired

txHashstringnullable

externalAccountIdstring<uuid>nullable

fundingCurrencyPayoutFundingCurrencynullable

failureReasonstringnullable

hedgePayoutEntryHedgeResponsenullable

fundingCurrencyPayoutFundingCurrencyrequired

fundingNetworkNetworkrequired

AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetOpBnbFiat

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

AllowedPendingProcessingCompleteInReviewFailed

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

autoConfirmbooleanrequired

The merchant asked for the payout to go out (created with `autoConfirm`, or confirmed while a recipient was still being checked). While such a payout is still awaiting confirmation it is waiting on screening, not on the merchant.

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

RequestCrypto payout

{
  "payouts": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "amount": 125,
      "countryOfResidence": "US",
      "gateway": "crypto",
      "network": "Ethereum",
      "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "payoutAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  ],
  "deductFees": true
}

Fiat external-account payout

{
  "payouts": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "amount": 125,
      "countryOfResidence": "US",
      "gateway": "fiat",
      "externalAccountId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "deductFees": true
}

Fiat withdrawal-account payout

{
  "payouts": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "amount": 125,
      "countryOfResidence": "US",
      "gateway": "fiatWithdrawalAccount",
      "withdrawalAccountId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ],
  "deductFees": true
}

Shell

curl -X POST https://api.radom.com/payout \
  -H 'Authorization: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "payouts": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "amount": 125,
      "countryOfResidence": "US",
      "gateway": "crypto",
      "network": "Ethereum",
      "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "payoutAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
    }
  ],
  "deductFees": true
}'

Try it

Sends a real POST to https://api.radom.com/payout

This operation moves funds. There is no test environment for it here — the request goes to the production API and its effects are real.

API key

Held in this page only, and discarded when you navigate away. It is not stored and is sent to api.radom.com and nowhere else.

Request body{ "payouts": [ { "name": "Ada Lovelace", "email": "ada@example.com", "amount": 125, "countryOfResidence": "US", "gateway": "crypto", "network": "Ethereum", "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", "payoutAddress": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e" } ], "deductFees": true }