Request a payout
ambassador.earnings.request_payoutRequest a payout of everything withdrawable, to the payout details saved on the outreach dashboard. Needs identity verified and payout details set (both once, on the dashboard) and at least the minimum confirmed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Sandbox notice. | |
| error | No | Present instead of the other fields when the call failed. | |
| amount | No | Amount requested. | |
| status | No | requested. | |
| currency | No | Its currency. | |
| next_step | No | What happens or what to do next, in plain language. | |
| payout_id | No | The payout's id. | |
| simulated | No | True in the sandbox: made-up data, nothing changed. |