blob: 10eae9adc91635ed9cd20bf30bf2803a71969edc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
..
This file is part of GNU TALER.
Copyright (C) 2014, 2015, 2016, 2017 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2.1, or (at your option) any later version.
TALER is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
@author Marcello Stanisci
@author Christian Grothoff
==============
Taler Bank API
==============
This chapter describe the APIs that banks need to offer towards Taler wallets
to tightly integrate with GNU Taler.
.. contents:: Table of Contents
-----------
Withdrawing
-----------
.. _bank-withdraw:
.. http:post:: /taler/withdraw
This API provides programmatic withdrawal of cash via Taler to all the
users registered at the bank. It triggers a wire transfer from the client
bank account to the exchange's.
**Request** The body of this request must have the format of a `BankTalerWithdrawRequest`.
**Response**
:status 200 OK:
The withdrawal was correctly initiated, therefore the exchange received the
payment. A `BankTalerWithdrawResponse` object is returned.
:status 406 Not Acceptable: the user does not have sufficient credit to fulfill their request.
:status 404 Not Found: The exchange wire details did not point to any valid bank account.
**Details**
.. ts:def:: BankTalerWithdrawRequest
interface BankTalerWithdrawRequest {
// Amount to withdraw.
amount: Amount;
// Reserve public key.
reserve_pub: string;
// Exchange bank details specified in the 'payto'
// format. NOTE: this field is optional, therefore
// the bank will initiate the withdrawal with the
// default exchange, if not given.
exchange_wire_details: string;
}
.. ts:def:: BankTalerWithdrawResponse
interface BankTalerWithdrawResponse {
// Sender account details in 'payto' format.
sender_wire_details: string;
// Exchange base URL. Optional: only returned
// if the user used the default exchange.
exchange_url: string;
}
|