api-bank-integration.rst (2118B)
1 .. 2 This file is part of GNU TALER. 3 4 Copyright (C) 2014-2025 Taler Systems SA 5 6 TALER is free software; you can redistribute it and/or modify it under the 7 terms of the GNU Affero General Public License as published by the Free Software 8 Foundation; either version 2.1, or (at your option) any later version. 9 10 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 11 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 12 A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. 13 14 You should have received a copy of the GNU Affero General Public License along with 15 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 16 17 @author Marcello Stanisci 18 @author Christian Grothoff 19 20 ========================== 21 Taler Bank Integration API 22 ========================== 23 24 This chapter describe the APIs that banks need to offer towards Taler wallets 25 to tightly integrate with GNU Taler. 26 27 28 --------------- 29 Version History 30 --------------- 31 32 The current protocol version is **v5**. 33 34 * The wallet-core is currently targeting protocol version **v4**. 35 36 **Version history:** 37 38 * ``v5``: adds ``no_amount_to_wallet`` flag to the WOPID status 39 40 **Upcoming versions:** 41 42 * ``vSHORT``: support for short wire transfer subjects? 43 * ``vPERIODIC``: support for periodic wire transfers? 44 45 **Ideas for future version:** 46 47 * ``vXXX``: marker for features not yet targeted for release 48 49 50 .. include:: bank-integration/get-config.rst 51 52 53 .. _wallet-wopid-withdrawing: 54 55 ----------- 56 Withdrawing 57 ----------- 58 59 Withdrawals with a Taler-integrated bank are based on withdrawal operations. 60 Some user interaction (on the bank's websitei) creates a 61 withdrawal operation record in the bank's database. The wallet can use a unique identifier 62 for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdrawal operation. 63 64 .. include:: bank-integration/get-withdrawal-operation-WITHDRAWAL_ID.rst 65 66 67 .. include:: bank-integration/post-withdrawal-operation-WITHDRAWAL_ID.rst 68 69 70 .. include:: bank-integration/post-withdrawal-operation-WITHDRAWAL_ID-abort.rst