taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit c15191a43a2195a2bb5af1f1be88783ba6029e79
parent 847c3a9853013e9a372d20d395d3777450441f9b
Author: Antoine A <>
Date:   Mon, 16 Jun 2025 18:50:10 +0200

corebank: update conversion rate class doc

Diffstat:
Mcore/api-corebank.rst | 16++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/core/api-corebank.rst b/core/api-corebank.rst @@ -331,6 +331,7 @@ Account Management // If present, set the user conversion rate class // Only admin can set this property. + // @since **v9** conversion_rate_class_id?: Number; // If present, enables 2FA and set the TAN channel used for challenges @@ -421,6 +422,7 @@ Account Management // If present, set the user conversion rate class // Only admin can set this property. + // @since **v9** conversion_rate_class_id?: Number // If present, enables 2FA and set the TAN channel used for challenges @@ -587,9 +589,11 @@ Account Management Starting ``row_id`` for :ref:`pagination <row-id-pagination>`. Since **v5**. :query filter_name: *Optional.* Pattern to filter on the account's legal name. Given - the filter 'foo', all the results will **contain** + the filter 'foo', all the accounts will **contain** 'foo' in their legal name. Without this option, all the existing accounts are returned. + :query conversion_rate_class_id: *Optional.* + Id of a conversion rate class. Given the filter '1', the accounts will be part of the conversion rate class 1. Given the filter '0', will have no conversion rate class. Without this option all the existing accounts are returned. Since **v9**. :query delta: *Optional.* Deprecated since **v5**. Use *limit* instead. :query start: *Optional.* @@ -741,7 +745,6 @@ Account Management // Is 2FA enabled and what channel is used for challenges? tan_channel?: TanChannel; - // Current status of the account // active: the account can be used @@ -752,6 +755,10 @@ Account Management // Defaults to 'active' is missing // @since **v4**, will become mandatory in the next version. status?: "active" | "locked" | "deleted"; + + // Conversion rate class to which the user belongs + // @since **v9** + conversion_rate_class?: ConversionRateClass; } Transactions @@ -1490,6 +1497,11 @@ Conversion rate class At most return the given number of results. Negative for descending by ``conversion_rate_class_id``, positive for ascending by ``conversion_rate_class_id``. Defaults to ``-20``. :query offset: *Optional.* Starting ``conversion_rate_class_id`` for :ref:`pagination <row-id-pagination>`. + :query filter_name: *Optional.* + Pattern to filter on the class name. Given + the filter 'foo', all the classes will **contain** + 'foo' in their name. Without this option, + all the existing classes are returned. **Response:**