Initiate payout
Noah
Initiate payout
Initiates an onchain-deposit-to-payment-method workflow from a prepared payout intent.
POST
Initiate payout
Authorizations
Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.
Body
application/json
Unique idempotency nonce for the payout request. Must not be reused across different transactions.
Maximum string length:
36CAIP-2 chain ID.
Fiat amount for the payout. Only applicable when trigger.Type is SingleOnchainDepositSourceTriggerInput.
Defines when and how the automated sell rule fires. Three variants
discriminated by Type (each with slightly different shape):
SingleOnchainDepositSourceTriggerInput— executes once.Conditions[*]must includeAmountConditions. The persistedfiatAmountfrom the quote is forwarded.PermanentOnchainDepositSourceTriggerInput— fires on every matching deposit; the entire deposited crypto amount is always sold.Conditions[*]carriesNetworkonly —AmountConditionsmust be omitted. OptionalNetworkAgnosticflag matches any network.QuotedOnchainDepositSourceTriggerInput— executes once and locks the conversion rate from a priorSellQuote. RequiresSignedQuote(fromquote.signedQuoteonPOST /payouts/quote).Conditions[*]carriesNetworkonly —AmountConditionsmust be omitted.Expiryis optional and defaults to the bound quote's expiry.
Response
Payout initiated successfully