Skip to main content

Cancel a payout that has not been sent

POSThttps://api.radom.com/payout/{id}/cancel

Only a payout that has not been sent can be cancelled: one awaiting confirmation (or already expired), or one held for a recipient's review before it was confirmed. It reads Expired from now on, nothing is debited for it, and it is not sent later on its own. A confirmed payout, or one whose stablecoin purchase or funding conversion has already started, is refused.

Authorization

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

Parameters

unlessHeldbooleanquery

Leave the payout as it is when one of its recipients is held for a compliance review. For clients that cancel quotes their user walked away from: abandoning a quote does not withdraw it from review.

idstring<uuid>pathrequired

Responses

200Payout cancelled
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