commit d0e18a5ef0eb1bc350f99a53b91ff1f199db877c
parent bc49b4844bd7fe8a7dbf5530d578e7a137fa65ce
Author: Sebastian <sebasjm@gmail.com>
Date: Thu, 3 Jul 2025 14:15:07 -0300
clarification about the null semantic when patching an account
Diffstat:
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -424,7 +424,8 @@ Account Management
// when the user wants to convert the regional currency
// back to fiat currency outside bank.
// Only admin can change this property if not allowed in config
- cashout_payto_uri?: string;
+ // Sending null will disable cashout
+ cashout_payto_uri?: string | null;
// If present, change the legal name associated with $username.
// Only admin can change this property if not allowed in config
@@ -439,11 +440,13 @@ Account Management
// If present, set the user conversion rate class
// Only admin can set this property.
+ // Sending null will remove the class and switch to default class
// @since **v9**
- conversion_rate_class_id?: Integer;
+ conversion_rate_class_id?: Integer | null;
// If present, enables 2FA and set the TAN channel used for challenges
- tan_channel?: TanChannel;
+ // Sending null will disable 2FA
+ tan_channel?: TanChannel | null;
// @deprecated in **v9**, user conversion rate classes instead
min_cashout?: Amount;