Send a payout (irreversible)
create_payoutStep 2 of sending money: executes a preview_payout quote and sends real funds from your balance — irreversible once sent. destination_network and destination_address must be the ones of the preview. idempotency_key is required: reuse the same key when retrying after a timeout so the payout is never sent twice. Then follow get_payout (status until completed or failed, transaction_url) or webhooks payout.completed / payout.failed.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"preview_id": "<preview_id>",
"destination_network": "<destination_network>",
"destination_address": "<destination_address>",
"idempotency_key": "<idempotency_key>"
},
"name": "create_payout"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| preview_id | Yes | preview_id from preview_payout (not expired). | |
| external_id | No | Your own reference (order id); unique per account. | |
| idempotency_key | Yes | Required. Your unique key of this payout; the same key never sends twice. | |
| destination_memo | No | Memo/tag when the destination needs one (exchanges, XRP, TON…). | |
| destination_address | Yes | Same as in preview_payout. | |
| destination_network | Yes | Same as in preview_payout. |