blob: 7ce5e4677c7cb69dea28ed658b505053ba952f2d (
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
The following list shows all the CLI subcommands
acting as the Circuit API's client side. Each section
name is one subcommand available in this pattern:
``libeufin-cli sandbox demobank $subcommand``.
Finally, each section name links to the related API
documentation of the endpoint being addressed.
:ref:`circuit-account-info <circuit-account-info>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieve Circuit information about one account. Useful to get cash-out
address and contact details.
Options:
--username TEXT Username of the account to retrieve. It defaults to
LIBEUFIN_SANDBOX_USERNAME and doesn't accept 'admin'.
--help Show this message and exit.
:ref:`circuit-accounts <circuit-account-list>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gets the list of all the accounts managed by the Circuit. Only 'admin'
allowed
Options:
--help Show this message and exit.
:ref:`circuit-cashout <circuit-cashout>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create a cash-out operation. If successful, the user gets a TAN.
Options:
--subject TEXT Payment subject to associate to the outgoing and
incoming payments that are associated with this cash-
out operation.
--amount-debit TEXT Amount that will debited to the local currency
account, in the <currency>:X.Y format. [required]
--amount-credit TEXT Amount that will credited to the fiat currency
account, in the <currency>:X.Y format. [required]
--tan-channel TEXT Indicates how to send the TAN to the user: 'sms',
'email' and 'file' are valid values. If missing, the
bank defaults to SMS. 'file' makes the server write
the TAN to /tmp/libeufin-cashout-tan.txt, normally
used for testing.
--help Show this message and exit.
:ref:`circuit-cashout-abort <circuit-cashout-abort>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Abort a cash-out operation. Admin and author are allowed to request.
Options:
--uuid TEXT UUID of the cash-out operation to abort. [required]
--help Show this message and exit.
:ref:`circuit-cashout-confirm <circuit-cashout-confirm>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Confirm a cash-out operation. Only the author is allowed (no admin).
Options:
--tan TEXT TAN that authorizes the cash-out operaion. [required]
--uuid TEXT UUID of the cash-out operation to confirm. [required]
--help Show this message and exit.
:ref:`circuit-cashout-details <circuit-cashout-details>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Retrieve status information about one cash-out operation. Admin and author
are allowed to request.
Options:
--uuid TEXT UUID of the cash-out operation to retrieve. [required]
--help Show this message and exit.
:ref:`circuit-cashouts <circuit-cashouts>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gets the list of all the pending and confirmed cash-out operations.
Options:
--help Show this message and exit.
:ref:`circuit-delete-account <circuit-delete-account>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Delete one account. Only available to the administrator and for accounts
with zero balance.
Options:
--username TEXT account to delete [required]
--help Show this message and exit.
:ref:`circuit-password-reconfig <circuit-password-reconfig>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Ask interactively to change the password. It needs administrator or owner
credentials
Options:
--username TEXT Username whose password will change. Defaults to
LIBEUFIN_SANDBOX_USERNAME and doesn't accept 'admin' as a
value.
--help Show this message and exit.
:ref:`circuit-reconfig <circuit-reconfig>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reconfigure an account with cash-out capabilities. It needs administrator
or owner credentials
Options:
--phone TEXT Phone number for the SMS TAN
--email TEXT E-mail address for receiving the TAN
--cashout-address TEXT Payto address where to send fiat payments on cash-
outs [required]
--username TEXT Username associated with the account to reconfigure.
It defaults to LIBEUFIN_SANDBOX_USERNAME and doesn't
accept 'admin'.
--help Show this message and exit.
:ref:`circuit-register <circuit-register>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Register a new account with cash-out capabilities. It needs administrator
credentials, and the new account password exported in
LIBEUFIN_NEW_CIRCUIT_ACCOUNT_PASSWORD.
Options:
--username TEXT new account username [required]
--cashout-address TEXT Payto address where to send fiat payments on cash-
outs [required]
--name TEXT Legal name associated to the account. [required]
--phone TEXT SMS where to send the cash-out TAN.
--email TEXT E-mail address where to send the cash-out TAN.
--internal-iban TEXT Which IBAN to associate to this account. The IBAN
participates only in the local currency circuit. If
missing, the bank generates one.
--help Show this message and exit.
|
