Create payout
create_payoutCreate a payout to bank card, YooMoney wallet, or SBP. Asynchronous—poll status for final confirmation. Irreversible real-money transfer.
Instructions
Create a payout to a bank card, YooMoney wallet, or SBP. Requires the separately-activated YooKassa Payouts product with its own credentials (see README/SECURITY). Asynchronous — the response may be 'pending'; poll get_payout for the final status. MOVES REAL MONEY — irreversible.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Payout amount | |
| bank_id | No | SBP participant bank id (required for destination_type=sbp) | |
| currency | No | Currency (ISO-4217, default RUB) | RUB |
| metadata | No | Arbitrary metadata | |
| description | No | Payout description | |
| payout_token | No | Recipient token from the payout widget (preferred; required if you lack PCI DSS to accept a raw card number) | |
| destination_type | No | Recipient type (if not using payout_token). bank_card requires a PCI DSS certificate | |
| destination_value | No | Recipient: card number (bank_card), wallet number (yoo_money), or phone 79XXXXXXXXX (sbp) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| paid | No | ||
| amount | No | ||
| status | No | ||
| confirmation_url | No |