taler-docs

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

commit b298fb872eb2c7e71662c8b0eff5c2f3433d61db
parent 26c4514dbe40b291e68ae20795e6281c32adfbe1
Author: Antoine A <>
Date:   Wed,  4 Mar 2026 10:55:09 +0100

dd80: naming changes

Diffstat:
Mcore/api-bank-wire-transfer.rst | 25++++++++++++-------------
Rcore/api-bank-wire-gateway.rst -> core/api-bank-wire.rst | 0
Mcore/api-corebank.rst | 6+++---
Mcore/api-overview.rst | 4++--
Mcore/api-terminal.rst | 2+-
Mcore/index-bank-apis.rst | 2+-
Mdesign-documents/080-short-wire-subject.rst | 2+-
7 files changed, 20 insertions(+), 21 deletions(-)

diff --git a/core/api-bank-wire-transfer.rst b/core/api-bank-wire-transfer.rst @@ -13,11 +13,11 @@ You should have received a copy of the GNU Affero General Public License along with TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> -.. _taler-wire-transfer-http-api: +.. _taler-wire-transfer-gateway-http-api: -============================ -Taler Wire Transfer HTTP API -============================ +==================================== +Taler Wire Transfer Gateway HTTP API +==================================== This section describes the API offered by Taler wire adapters. The API is used by clients such as wallets to prepare wire transfers. This allows the use @@ -48,7 +48,7 @@ and enables the use of recurring wire transfers. interface WireTransferConfig { // Name of the API. - name: "taler-wire-transfer"; + name: "taler-wire-transfer-gateway"; // libtool-style representation of the Bank protocol version, see // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning @@ -70,8 +70,7 @@ and enables the use of recurring wire transfers. Prepared wire transfers ----------------------- - -.. http:post:: /prepared-transfers +.. http:post:: /registration Register a public key for wire transfer use. @@ -94,9 +93,9 @@ Prepared wire transfers **Request:** - .. ts:def:: PreparedTransferRequest + .. ts:def:: RegistrationRequest - interface PreparedTransferRequest { + interface RegistrationRequest { // Amount to transfer credit_amount: Amount; @@ -123,7 +122,7 @@ Prepared wire transfers **Response:** :http:statuscode:`200 Ok`: - Response is a `PreparedTransferResponse`. + Response is a `RegistrationResponse`. :http:statuscode:`400 Bad request`: Input data was invalid. :http:statuscode:`409 Conflict`: @@ -181,9 +180,9 @@ Prepared wire transfers qr_reference_number: string; } - .. ts:def:: PreparedTransferResponse + .. ts:def:: RegistrationResponse - interface PreparedTransferResponse { + interface RegistrationResponse { // The transfer subject encoded in all supported formats subjects: TransferSubject[]; @@ -191,7 +190,7 @@ Prepared wire transfers expiration: Timestamp; } -.. http:delete:: /prepared-transfers +.. http:delete:: /registration Remove an existing registered public key for wire transfer use. diff --git a/core/api-bank-wire-gateway.rst b/core/api-bank-wire.rst diff --git a/core/api-corebank.rst b/core/api-corebank.rst @@ -1879,16 +1879,16 @@ Endpoints for Integrated Sub-APIs .. http:any:: /accounts/$USERNAME/taler-wire-gateway/* All endpoints under this prefix are specified - by the :doc:`GNU Taler wire gateway API </core/api-bank-wire-gateway>`. + by the :doc:`GNU Taler wire gateway API </core/api-bank-wire>`. The endpoints are only available for accounts configured with ``is_taler_exchange=true``. -.. http:any:: /accounts/$USERNAME/taler-wire-transfer/* +.. http:any:: /accounts/$USERNAME/taler-wire-transfer-gateway/* Since **v12** All endpoints under this prefix are specified - by the :doc:`GNU Taler wire transfer API </core/api-bank-wire-transfer>`. + by the :doc:`GNU Taler wire transfer gateway API </core/api-bank-wire-transfer>`. The endpoints are only available for accounts configured with ``is_taler_exchange=true``. diff --git a/core/api-overview.rst b/core/api-overview.rst @@ -82,9 +82,9 @@ Overview * **Consumers**: GNU Taler Exchange, Wire Auditor -* :doc:`Docs <api-bank-wire-gateway>` +* :doc:`Docs <api-bank-wire>` -.. rubric:: Taler Wire Transfer API +.. rubric:: Taler Wire Transfer Gateway API * **Summary**: Allows Taler clients to prepared wire transfers, enabling recurring wire transfers and optimized transfer flow. diff --git a/core/api-terminal.rst b/core/api-terminal.rst @@ -378,6 +378,6 @@ Endpoints for Integrated Sub-APIs .. http:any:: /taler-wire-gateway/* All endpoints under this prefix are specified - by the :doc:`GNU Taler wire gateway API </core/api-bank-wire-gateway>`. + by the :doc:`GNU Taler wire gateway API </core/api-bank-wire>`. The endpoints are only available for accounts configured with ``is_taler_exchange=true``. diff --git a/core/index-bank-apis.rst b/core/index-bank-apis.rst @@ -29,7 +29,7 @@ Bank RESTful APIs intro-bank-apis api-corebank - api-bank-wire-gateway + api-bank-wire api-bank-wire-transfer api-bank-revenue api-bank-integration diff --git a/design-documents/080-short-wire-subject.rst b/design-documents/080-short-wire-subject.rst @@ -164,7 +164,7 @@ By running the subject derivation logic itself and using the new authorization p Taler Wire Transfer HTTP API ---------------------------- -See the :ref:`Taler Wire Transfer <taler-wire-transfer-http-api>` documentation. +See the :ref:`Taler Wire Transfer <taler-wire-transfer-gateway-http-api>` documentation. Test Plan =========