Update a subaccount
update_subaccountUpdate a subaccount’s name, email, status, metadata, or payout bank details. Payout account changes run name enquiry and apply a cooldown before the new account is used.
Instructions
Update a subaccount.
Update a subaccount’s name, email, status or metadata. Changing the payout account (bank_code with account_number) re-runs name enquiry, and the new account is used only after a cooldown (settlement_account.usable_from) to protect against account takeover.
In live mode this sends real money or changes where money is paid, and it cannot be undone. Before calling, confirm the exact amount (in kobo) and the destination with the user.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The subaccount id (`sub_…`). | |
| name | No | ||
| No | |||
| status | No | ||
| metadata | No | ||
| bank_code | No | Change the payout account (a cooldown applies before it is used) | |
| account_number | No |