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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
|
import { codecForAmountString } from "../amounts.js";
import { Codec, buildCodecForObject, buildCodecForUnion, codecForBoolean, codecForConstString, codecForEither, codecForList, codecForMap, codecForNumber, codecForString, codecOptional } from "../codec.js";
import { PaytoString, PaytoUri, codecForPaytoString } from "../payto.js";
import { AmountString } from "../taler-types.js";
import { TalerActionString, WithdrawUriResult, codecForTalerActionString } from "../taleruri.js";
import { codecForTimestamp } from "../time.js";
import { TalerErrorDetail } from "../wallet-types.js";
export type UserAndPassword = {
username: string,
password: string,
}
export type UserAndToken = {
username: string,
token: AccessToken,
}
export type PaginationParams = {
/**
* row identifier as the starting point of the query
*/
offset?: string,
/**
* max number of element in the result response
* always greater than 0
*/
limit?: number,
/**
* milliseconds the server should wait for at least one result to be shown
*/
timoutMs?: number,
/**
* order
*/
order: "asc" | "dec"
}
///
/// HASH
///
// 64-byte hash code.
type HashCode = string;
// 32-byte hash code.
type ShortHashCode = string;
// 16-byte salt.
type WireSalt = string;
type SHA256HashCode = ShortHashCode;
type SHA512HashCode = HashCode;
// 32-byte nonce value, must only be used once.
type CSNonce = string;
// 32-byte nonce value, must only be used once.
type RefreshMasterSeed = string;
// 32-byte value representing a point on Curve25519.
type Cs25519Point = string;
// 32-byte value representing a scalar multiplier
// for scalar operations on points on Curve25519.
type Cs25519Scalar = string;
///
/// KEYS
///
// 16-byte access token used to authorize access.
type ClaimToken = string;
// EdDSA and ECDHE public keys always point on Curve25519
// and represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type EddsaPublicKey = string;
// EdDSA and ECDHE public keys always point on Curve25519
// and represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type EddsaPrivateKey = string;
// Edx25519 public keys are points on Curve25519 and represented using the
// standard 256 bits Ed25519 compact format converted to Crockford
// Base32.
type Edx25519PublicKey = string;
// Edx25519 private keys are always points on Curve25519
// and represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type Edx25519PrivateKey = string;
// EdDSA and ECDHE public keys always point on Curve25519
// and represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type EcdhePublicKey = string;
// Point on Curve25519 represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type CsRPublic = string;
// EdDSA and ECDHE public keys always point on Curve25519
// and represented using the standard 256 bits Ed25519 compact format,
// converted to Crockford Base32.
type EcdhePrivateKey = string;
type CoinPublicKey = EddsaPublicKey;
// RSA public key converted to Crockford Base32.
type RsaPublicKey = string;
type Integer = number;
type WireTransferIdentifierRawP = string;
// Subset of numbers: Integers in the
// inclusive range 0 .. (2^53 - 1).
type SafeUint64 = number;
// The string must be a data URL according to RFC 2397
// with explicit mediatype and base64 parameters.
//
// data:<mediatype>;base64,<data>
//
// Supported mediatypes are image/jpeg and image/png.
// Invalid strings will be rejected by the wallet.
type ImageDataUrl = string;
type WadId = string;
interface Timestamp {
// Seconds since epoch, or the special
// value "never" to represent an event that will
// never happen.
t_s: number | "never";
}
interface RelativeTime {
// Duration in microseconds or "forever"
// to represent an infinite duration. Numeric
// values are capped at 2^53 - 1 inclusive.
d_us: number | "forever";
}
export interface LoginToken {
token: AccessToken,
expiration: Timestamp,
}
// token used to get loginToken
// must forget after used
declare const __ac_token: unique symbol;
export type AccessToken = string & {
[__ac_token]: true;
};
export namespace TalerAuthentication {
export interface TokenRequest {
// Service-defined scope for the token.
// Typical scopes would be "readonly" or "readwrite".
scope: string;
// Server may impose its own upper bound
// on the token validity duration
duration?: RelativeTime;
// Is the token refreshable into a new token during its
// validity?
// Refreshable tokens effectively provide indefinite
// access if they are refreshed in time.
refreshable?: boolean;
}
export interface TokenSuccessResponse {
// Expiration determined by the server.
// Can be based on the token_duration
// from the request, but ultimately the
// server decides the expiration.
expiration: Timestamp;
// Opque access token.
access_token: AccessToken;
}
}
// DD51 https://docs.taler.net/design-documents/051-fractional-digits.html
export interface CurrencySpecification {
// Name of the currency.
name: string;
// how many digits the user may enter after the decimal_separator
num_fractional_input_digits: Integer;
// Number of fractional digits to render in normal font and size.
num_fractional_normal_digits: Integer;
// Number of fractional digits to render always, if needed by
// padding with zeros.
num_fractional_trailing_zero_digits: Integer;
// map of powers of 10 to alternative currency names / symbols, must
// always have an entry under "0" that defines the base name,
// e.g. "0 => €" or "3 => k€". For BTC, would be "0 => BTC, -3 => mBTC".
// Communicates the currency symbol to be used.
alt_unit_names: { [log10: string]: string };
}
export const codecForAccessToken = codecForString as () => Codec<AccessToken>;
export const codecForTokenSuccessResponse =
(): Codec<TalerAuthentication.TokenSuccessResponse> =>
buildCodecForObject<TalerAuthentication.TokenSuccessResponse>()
.property("access_token", codecForAccessToken())
.property("expiration", codecForTimestamp)
.build("TalerAuthentication.TokenSuccessResponse")
export const codecForCurrencySpecificiation =
(): Codec<CurrencySpecification> =>
buildCodecForObject<CurrencySpecification>()
.property("name", codecForString())
.property("num_fractional_input_digits", codecForNumber())
.property("num_fractional_normal_digits", codecForNumber())
.property("num_fractional_trailing_zero_digits", codecForNumber())
.property("alt_unit_names", codecForMap(codecForString()))
.build("CurrencySpecification")
export const codecForIntegrationBankConfig =
(): Codec<TalerCorebankApi.IntegrationConfig> =>
buildCodecForObject<TalerCorebankApi.IntegrationConfig>()
.property("name", codecForConstString("taler-bank-integration"))
.property("version", codecForString())
.property("currency", codecForString())
.property("currency_specification", codecForCurrencySpecificiation())
.build("TalerCorebankApi.IntegrationConfig")
export const codecForCoreBankConfig =
(): Codec<TalerCorebankApi.Config> =>
buildCodecForObject<TalerCorebankApi.Config>()
.property("name", codecForConstString("libeufin-bank"))
// .property("name", codecForConstString("taler-corebank"))
.property("version", codecForString())
.property("allow_deletions", codecForBoolean())
.property("allow_registrations", codecForBoolean())
.property("have_cashout", codecOptional(codecForBoolean()))
.property("currency", codecForCurrencySpecificiation())
.property("fiat_currency", codecOptional(codecForCurrencySpecificiation()))
.property("conversion_info", codecOptional(codecForConversionRatesResponse()))
.build("TalerCorebankApi.Config")
export const codecForMerchantConfig =
(): Codec<TalerMerchantApi.VersionResponse> =>
buildCodecForObject<TalerMerchantApi.VersionResponse>()
.property("name", codecForConstString("taler-merchant"))
.property("currency", codecForString())
.property("version", codecForString())
.property("currencies", codecForMap(codecForCurrencySpecificiation()))
.build("TalerMerchantApi.VersionResponse")
export const codecForExchangeConfig =
(): Codec<TalerExchangeApi.ExchangeVersionResponse> =>
buildCodecForObject<TalerExchangeApi.ExchangeVersionResponse>()
.property("version", codecForString())
.property("name", codecForConstString("taler-exchange"))
.property("currency", codecForString())
.property("currency_specification", codecForCurrencySpecificiation())
.property("supported_kyc_requirements", codecForList(codecForString()))
.build("TalerExchangeApi.ExchangeVersionResponse")
const codecForBalance = (): Codec<TalerCorebankApi.Balance> =>
buildCodecForObject<TalerCorebankApi.Balance>()
.property("amount", codecForAmountString())
.property("credit_debit_indicator", codecForEither(codecForConstString("credit"), codecForConstString("debit")))
.build("TalerCorebankApi.Balance")
const codecForPublicAccount = (): Codec<TalerCorebankApi.PublicAccount> =>
buildCodecForObject<TalerCorebankApi.PublicAccount>()
.property("account_name", codecForString())
.property("balance", codecForBalance())
.property("payto_uri", codecForPaytoString())
.build("TalerCorebankApi.PublicAccount")
export const codecForPublicAccountsResponse =
(): Codec<TalerCorebankApi.PublicAccountsResponse> =>
buildCodecForObject<TalerCorebankApi.PublicAccountsResponse>()
.property("public_accounts", codecForList(codecForPublicAccount()))
.build("TalerCorebankApi.PublicAccountsResponse")
export const codecForAccountMinimalData =
(): Codec<TalerCorebankApi.AccountMinimalData> =>
buildCodecForObject<TalerCorebankApi.AccountMinimalData>()
.property("balance", codecForBalance())
.property("debit_threshold", codecForAmountString())
.property("name", codecForString())
.property("username", codecForString())
.build("TalerCorebankApi.AccountMinimalData")
export const codecForListBankAccountsResponse =
(): Codec<TalerCorebankApi.ListBankAccountsResponse> =>
buildCodecForObject<TalerCorebankApi.ListBankAccountsResponse>()
.property("accounts", codecForList(codecForAccountMinimalData()))
.build("TalerCorebankApi.ListBankAccountsResponse")
export const codecForAccountData =
(): Codec<TalerCorebankApi.AccountData> =>
buildCodecForObject<TalerCorebankApi.AccountData>()
.property("name", codecForString())
.property("balance", codecForBalance())
.property("payto_uri", codecForPaytoString())
.property("debit_threshold", codecForAmountString())
.property("contact_data", codecOptional(codecForChallengeContactData()))
.property("cashout_payto_uri", codecOptional(codecForPaytoString()))
.build("TalerCorebankApi.AccountData")
export const codecForChallengeContactData =
(): Codec<TalerCorebankApi.ChallengeContactData> =>
buildCodecForObject<TalerCorebankApi.ChallengeContactData>()
.property("email", codecOptional(codecForString()))
.property("phone", codecOptional(codecForString()))
.build("TalerCorebankApi.ChallengeContactData")
export const codecForBankAccountTransactionsResponse =
(): Codec<TalerCorebankApi.BankAccountTransactionsResponse> =>
buildCodecForObject<TalerCorebankApi.BankAccountTransactionsResponse>()
.property("transactions", codecForList(codecForBankAccountTransactionInfo()))
.build("TalerCorebankApi.BankAccountTransactionsResponse");
export const codecForBankAccountTransactionInfo =
(): Codec<TalerCorebankApi.BankAccountTransactionInfo> =>
buildCodecForObject<TalerCorebankApi.BankAccountTransactionInfo>()
.property("amount", codecForAmountString())
.property("creditor_payto_uri", codecForPaytoString())
.property("date", codecForTimestamp)
.property("debtor_payto_uri", codecForPaytoString())
.property("direction", codecForEither(codecForConstString("debit"), codecForConstString("credit")))
.property("row_id", codecForNumber())
.property("subject", codecForString())
.build("TalerCorebankApi.BankAccountTransactionInfo");
export const codecForBankAccountCreateWithdrawalResponse =
(): Codec<TalerCorebankApi.BankAccountCreateWithdrawalResponse> =>
buildCodecForObject<TalerCorebankApi.BankAccountCreateWithdrawalResponse>()
.property("taler_withdraw_uri", codecForTalerActionString())
.property("withdrawal_id", codecForString())
.build("TalerCorebankApi.BankAccountCreateWithdrawalResponse");
export const codecForBankAccountGetWithdrawalResponse =
(): Codec<TalerCorebankApi.BankAccountGetWithdrawalResponse> =>
buildCodecForObject<TalerCorebankApi.BankAccountGetWithdrawalResponse>()
.property("aborted", codecForBoolean())
.property("amount", codecForAmountString())
.property("confirmation_done", codecForBoolean())
.property("selected_exchange_account", codecOptional(codecForPaytoString()))
.property("selected_reserve_pub", codecOptional(codecForString()))
.property("selection_done", (codecForBoolean()))
.build("TalerCorebankApi.BankAccountGetWithdrawalResponse");
export const codecForCashoutPending =
(): Codec<TalerCorebankApi.CashoutPending> =>
buildCodecForObject<TalerCorebankApi.CashoutPending>()
.property("cashout_id", codecForString())
.build("TalerCorebankApi.CashoutPending");
export const codecForCashoutConversionResponse =
(): Codec<TalerCorebankApi.CashoutConversionResponse> =>
buildCodecForObject<TalerCorebankApi.CashoutConversionResponse>()
.property("amount_credit", codecForAmountString())
.property("amount_debit", codecForAmountString())
.build("TalerCorebankApi.CashoutConversionResponse");
export const codecForCashouts =
(): Codec<TalerCorebankApi.Cashouts> =>
buildCodecForObject<TalerCorebankApi.Cashouts>()
.property("cashouts", codecForList(codecForCashoutInfo()))
.build("TalerCorebankApi.Cashouts");
export const codecForCashoutInfo =
(): Codec<TalerCorebankApi.CashoutInfo> =>
buildCodecForObject<TalerCorebankApi.CashoutInfo>()
.property("cashout_id", codecForString())
.property("status", codecForEither(codecForConstString("pending"), codecForConstString("confirmed"),))
.build("TalerCorebankApi.CashoutInfo");
export const codecForGlobalCashouts =
(): Codec<TalerCorebankApi.GlobalCashouts> =>
buildCodecForObject<TalerCorebankApi.GlobalCashouts>()
.property("cashouts", codecForList(codecForGlobalCashoutInfo()))
.build("TalerCorebankApi.GlobalCashouts");
export const codecForGlobalCashoutInfo =
(): Codec<TalerCorebankApi.GlobalCashoutInfo> =>
buildCodecForObject<TalerCorebankApi.GlobalCashoutInfo>()
.property("cashout_id", codecForString())
.property("username", codecForString())
.property("status", codecForEither(codecForConstString("pending"), codecForConstString("confirmed"),))
.build("TalerCorebankApi.GlobalCashoutInfo");
export const codecForCashoutStatusResponse =
(): Codec<TalerCorebankApi.CashoutStatusResponse> =>
buildCodecForObject<TalerCorebankApi.CashoutStatusResponse>()
.property("amount_credit", codecForAmountString())
.property("amount_debit", codecForAmountString())
.property("confirmation_time", codecForTimestamp)
.property("creation_time", codecForTimestamp)
.property("credit_payto_uri", codecForPaytoString())
.property("status", codecForEither(codecForConstString("pending"), codecForConstString("confirmed")))
.property("subject", codecForString())
.build("TalerCorebankApi.CashoutStatusResponse");
export const codecForConversionRatesResponse =
(): Codec<TalerCorebankApi.ConversionRatesResponse> =>
buildCodecForObject<TalerCorebankApi.ConversionRatesResponse>()
.property("buy_at_ratio", codecForDecimalNumber())
.property("buy_in_fee", codecForDecimalNumber())
.property("sell_at_ratio", codecForDecimalNumber())
.property("sell_out_fee", codecForDecimalNumber())
.build("TalerCorebankApi.ConversionRatesResponse");
export const codecForMonitorResponse = (): Codec<TalerCorebankApi.MonitorResponse> => buildCodecForUnion<TalerCorebankApi.MonitorResponse>()
.discriminateOn("type")
.alternative("just-payouts", codecForMonitorResponseJustPayout())
.alternative("with-cashout", codecForMonitorResponseWithCashout())
.build("TalerWireGatewayApi.IncomingBankTransaction");
export const codecForMonitorResponseJustPayout =
(): Codec<TalerCorebankApi.MonitorJustPayouts> =>
buildCodecForObject<TalerCorebankApi.MonitorJustPayouts>()
.property("type", codecForConstString("just-payouts"))
.property("talerPayoutCount", codecForNumber())
.property("talerPayoutInternalVolume", codecForAmountString())
.build("TalerCorebankApi.MonitorJustPayouts");
export const codecForMonitorResponseWithCashout =
(): Codec<TalerCorebankApi.MonitorWithCashout> =>
buildCodecForObject<TalerCorebankApi.MonitorWithCashout>()
.property("type", codecForConstString("with-cashout"))
.property("cashinCount", (codecForNumber()))
.property("cashinExternalVolume", (codecForAmountString()))
.property("cashoutCount", (codecForNumber()))
.property("cashoutExternalVolume", (codecForAmountString()))
.property("talerPayoutCount", codecForNumber())
.property("talerPayoutInternalVolume", codecForAmountString())
.build("TalerCorebankApi.MonitorWithCashout");
export const codecForBankVersion =
(): Codec<TalerBankIntegrationApi.BankVersion> =>
buildCodecForObject<TalerBankIntegrationApi.BankVersion>()
.property("currency", codecForCurrencyName())
.property("currency_specification", codecForCurrencySpecificiation())
.property("name", codecForConstString("taler-bank-integration"))
.property("version", codecForLibtoolVersion())
.build("TalerBankIntegrationApi.BankVersion");
export const codecForBankWithdrawalOperationStatus =
(): Codec<TalerBankIntegrationApi.BankWithdrawalOperationStatus> =>
buildCodecForObject<TalerBankIntegrationApi.BankWithdrawalOperationStatus>()
.property("aborted", codecForBoolean())
.property("selection_done", codecForBoolean())
.property("transfer_done", codecForBoolean())
.property("amount", codecForAmountString())
.property("sender_wire", codecOptional(codecForPaytoString()))
.property("suggested_exchange", codecOptional(codecForString()))
.property("confirm_transfer_url", codecOptional(codecForURL()))
.property("wire_types", codecForList(codecForString()))
.build("TalerBankIntegrationApi.BankWithdrawalOperationStatus");
export const codecForBankWithdrawalOperationPostResponse =
(): Codec<TalerBankIntegrationApi.BankWithdrawalOperationPostResponse> =>
buildCodecForObject<TalerBankIntegrationApi.BankWithdrawalOperationPostResponse>()
.property("confirm_transfer_url", codecOptional(codecForURL()))
.property("transfer_done", codecForBoolean())
.build("TalerBankIntegrationApi.BankWithdrawalOperationPostResponse");
export const codecForMerchantIncomingHistory =
(): Codec<TalerRevenueApi.MerchantIncomingHistory> =>
buildCodecForObject<TalerRevenueApi.MerchantIncomingHistory>()
.property("credit_account", codecForPaytoString())
.property("incoming_transactions", codecForList(codecForMerchantIncomingBankTransaction()))
.build("TalerRevenueApi.MerchantIncomingHistory");
export const codecForMerchantIncomingBankTransaction =
(): Codec<TalerRevenueApi.MerchantIncomingBankTransaction> =>
buildCodecForObject<TalerRevenueApi.MerchantIncomingBankTransaction>()
.property("row_id", codecForNumber())
.property("date", codecForTimestamp)
.property("amount", codecForAmountString())
.property("debit_account", codecForPaytoString())
.property("exchange_url", codecForURL())
.property("wtid", codecForString())
.build("TalerRevenueApi.MerchantIncomingBankTransaction");
export const codecForTransferResponse =
(): Codec<TalerWireGatewayApi.TransferResponse> =>
buildCodecForObject<TalerWireGatewayApi.TransferResponse>()
.property("row_id", codecForNumber())
.property("timestamp", codecForTimestamp)
.build("TalerWireGatewayApi.TransferResponse");
export const codecForIncomingHistory =
(): Codec<TalerWireGatewayApi.IncomingHistory> =>
buildCodecForObject<TalerWireGatewayApi.IncomingHistory>()
.property("credit_account", codecForPaytoString())
.property("incoming_transactions", codecForList(codecForIncomingBankTransaction()))
.build("TalerWireGatewayApi.IncomingHistory");
export const codecForIncomingBankTransaction = (): Codec<TalerWireGatewayApi.IncomingBankTransaction> => buildCodecForUnion<TalerWireGatewayApi.IncomingBankTransaction>()
.discriminateOn("type")
.alternative("RESERVE", codecForIncomingReserveTransaction())
.alternative("WAD", codecForIncomingWadTransaction())
.build("TalerWireGatewayApi.IncomingBankTransaction");
export const codecForIncomingReserveTransaction =
(): Codec<TalerWireGatewayApi.IncomingReserveTransaction> =>
buildCodecForObject<TalerWireGatewayApi.IncomingReserveTransaction>()
.property("amount", codecForAmountString())
.property("date", codecForTimestamp)
.property("debit_account", codecForPaytoString())
.property("reserve_pub", codecForString())
.property("row_id", codecForNumber())
.property("type", codecForConstString("RESERVE"))
.build("TalerWireGatewayApi.IncomingReserveTransaction");
export const codecForIncomingWadTransaction =
(): Codec<TalerWireGatewayApi.IncomingWadTransaction> =>
buildCodecForObject<TalerWireGatewayApi.IncomingWadTransaction>()
.property("amount", codecForAmountString())
.property("credit_account", codecForPaytoString())
.property("date", codecForTimestamp)
.property("debit_account", codecForPaytoString())
.property("origin_exchange_url", codecForURL())
.property("row_id", codecForNumber())
.property("type", codecForConstString("WAD"))
.property("wad_id", codecForString())
.build("TalerWireGatewayApi.IncomingWadTransaction");
export const codecForOutgoingHistory =
(): Codec<TalerWireGatewayApi.OutgoingHistory> =>
buildCodecForObject<TalerWireGatewayApi.OutgoingHistory>()
.property("debit_account", codecForPaytoString())
.property("outgoing_transactions", codecForList(codecForOutgoingBankTransaction()))
.build("TalerWireGatewayApi.OutgoingHistory");
export const codecForOutgoingBankTransaction =
(): Codec<TalerWireGatewayApi.OutgoingBankTransaction> =>
buildCodecForObject<TalerWireGatewayApi.OutgoingBankTransaction>()
.property("amount", codecForAmountString())
.property("credit_account", codecForPaytoString())
.property("date", codecForTimestamp)
.property("exchange_base_url", codecForURL())
.property("row_id", codecForNumber())
.property("wtid", codecForString())
.build("TalerWireGatewayApi.OutgoingBankTransaction");
export const codecForAddIncomingResponse =
(): Codec<TalerWireGatewayApi.AddIncomingResponse> =>
buildCodecForObject<TalerWireGatewayApi.AddIncomingResponse>()
.property("row_id", codecForNumber())
.property("timestamp", codecForTimestamp)
.build("TalerWireGatewayApi.AddIncomingResponse");
// export const codecFor =
// (): Codec<TalerWireGatewayApi.PublicAccountsResponse> =>
// buildCodecForObject<TalerWireGatewayApi.PublicAccountsResponse>()
// .property("", codecForString())
// .build("TalerWireGatewayApi.PublicAccountsResponse");
type EmailAddress = string;
type PhoneNumber = string;
type EddsaSignature = string;
// base32 encoded RSA blinded signature.
type BlindedRsaSignature = string;
type Base32 = string;
type DecimalNumber = number;
type RsaSignature = string;
// The type of a coin's blinded envelope depends on the cipher that is used
// for signing with a denomination key.
type CoinEnvelope = RSACoinEnvelope | CSCoinEnvelope;
// For denomination signatures based on RSA, the planchet is just a blinded
// coin's public EdDSA key.
interface RSACoinEnvelope {
cipher: "RSA" | "RSA+age_restricted";
rsa_blinded_planchet: string; // Crockford Base32 encoded
}
// For denomination signatures based on Blind Clause-Schnorr, the planchet
// consists of the public nonce and two Curve25519 scalars which are two
// blinded challenges in the Blinded Clause-Schnorr signature scheme.
// See https://taler.net/papers/cs-thesis.pdf for details.
interface CSCoinEnvelope {
cipher: "CS" | "CS+age_restricted";
cs_nonce: string; // Crockford Base32 encoded
cs_blinded_c0: string; // Crockford Base32 encoded
cs_blinded_c1: string; // Crockford Base32 encoded
}
// Secret for blinding/unblinding.
// An RSA blinding secret, which is basically
// a 256-bit nonce, converted to Crockford Base32.
type DenominationBlindingKeyP = string;
const codecForURL = codecForString
const codecForLibtoolVersion = codecForString
const codecForCurrencyName = codecForString
const codecForEddsaSignature = codecForString
const codecForDecimalNumber = codecForNumber
enum TanChannel {
SMS = "sms",
EMAIL = "email",
FILE = "file"
}
export namespace TalerWireGatewayApi {
export interface TransferResponse {
// Timestamp that indicates when the wire transfer will be executed.
// In cases where the wire transfer gateway is unable to know when
// the wire transfer will be executed, the time at which the request
// has been received and stored will be returned.
// The purpose of this field is for debugging (humans trying to find
// the transaction) as well as for taxation (determining which
// time period a transaction belongs to).
timestamp: Timestamp;
// Opaque ID of the transaction that the bank has made.
row_id: SafeUint64;
}
export interface TransferRequest {
// Nonce to make the request idempotent. Requests with the same
// transaction_uid that differ in any of the other fields
// are rejected.
request_uid: HashCode;
// Amount to transfer.
amount: AmountString;
// Base URL of the exchange. Shall be included by the bank gateway
// in the appropriate section of the wire transfer details.
exchange_base_url: string;
// Wire transfer identifier chosen by the exchange,
// used by the merchant to identify the Taler order(s)
// associated with this wire transfer.
wtid: ShortHashCode;
// The recipient's account identifier as a payto URI.
credit_account: PaytoString;
}
export interface IncomingHistory {
// Array of incoming transactions.
incoming_transactions: IncomingBankTransaction[];
// Payto URI to identify the receiver of funds.
// This must be one of the exchange's bank accounts.
// Credit account is shared by all incoming transactions
// as per the nature of the request.
credit_account: PaytoString;
}
// Union discriminated by the "type" field.
export type IncomingBankTransaction =
| IncomingReserveTransaction
| IncomingWadTransaction;
export interface IncomingReserveTransaction {
type: "RESERVE";
// Opaque identifier of the returned record.
row_id: SafeUint64;
// Date of the transaction.
date: Timestamp;
// Amount transferred.
amount: AmountString;
// Payto URI to identify the sender of funds.
debit_account: PaytoString;
// The reserve public key extracted from the transaction details.
reserve_pub: EddsaPublicKey;
}
export interface IncomingWadTransaction {
type: "WAD";
// Opaque identifier of the returned record.
row_id: SafeUint64;
// Date of the transaction.
date: Timestamp;
// Amount transferred.
amount: AmountString;
// Payto URI to identify the receiver of funds.
// This must be one of the exchange's bank accounts.
credit_account: PaytoString;
// Payto URI to identify the sender of funds.
debit_account: PaytoString;
// Base URL of the exchange that originated the wad.
origin_exchange_url: string;
// The reserve public key extracted from the transaction details.
wad_id: WadId;
}
export interface OutgoingHistory {
// Array of outgoing transactions.
outgoing_transactions: OutgoingBankTransaction[];
// Payto URI to identify the sender of funds.
// This must be one of the exchange's bank accounts.
// Credit account is shared by all incoming transactions
// as per the nature of the request.
debit_account: PaytoString;
}
export interface OutgoingBankTransaction {
// Opaque identifier of the returned record.
row_id: SafeUint64;
// Date of the transaction.
date: Timestamp;
// Amount transferred.
amount: AmountString;
// Payto URI to identify the receiver of funds.
credit_account: PaytoString;
// The wire transfer ID in the outgoing transaction.
wtid: ShortHashCode;
// Base URL of the exchange.
exchange_base_url: string;
}
export interface AddIncomingRequest {
// Amount to transfer.
amount: AmountString;
// Reserve public key that is included in the wire transfer details
// to identify the reserve that is being topped up.
reserve_pub: EddsaPublicKey;
// Account (as payto URI) that makes the wire transfer to the exchange.
// Usually this account must be created by the test harness before this API is
// used. An exception is the "exchange-fakebank", where any debit account can be
// specified, as it is automatically created.
debit_account: PaytoString;
}
export interface AddIncomingResponse {
// Timestamp that indicates when the wire transfer will be executed.
// In cases where the wire transfer gateway is unable to know when
// the wire transfer will be executed, the time at which the request
// has been received and stored will be returned.
// The purpose of this field is for debugging (humans trying to find
// the transaction) as well as for taxation (determining which
// time period a transaction belongs to).
timestamp: Timestamp;
// Opaque ID of the transaction that the bank has made.
row_id: SafeUint64;
}
}
export namespace TalerRevenueApi {
export interface MerchantIncomingHistory {
// Array of incoming transactions.
incoming_transactions: MerchantIncomingBankTransaction[];
// Payto URI to identify the receiver of funds.
// This must be one of the merchant's bank accounts.
// Credit account is shared by all incoming transactions
// as per the nature of the request.
credit_account: PaytoString;
}
export interface MerchantIncomingBankTransaction {
// Opaque identifier of the returned record.
row_id: SafeUint64;
// Date of the transaction.
date: Timestamp;
// Amount transferred.
amount: AmountString;
// Payto URI to identify the sender of funds.
debit_account: PaytoString;
// Base URL of the exchange where the transfer originated form.
exchange_url: string;
// The wire transfer identifier.
wtid: WireTransferIdentifierRawP;
}
}
export namespace TalerBankIntegrationApi {
export interface BankVersion {
// libtool-style representation of the Bank protocol version, see
// https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
// The format is "current:revision:age".
version: string;
// Currency used by this bank.
currency: string;
// How the bank SPA should render this currency.
currency_specification: CurrencySpecification;
// Name of the API.
name: "taler-bank-integration";
}
export interface BankWithdrawalOperationStatus {
// Indicates whether the withdrawal was aborted.
aborted: boolean;
// Has the wallet selected parameters for the withdrawal operation
// (exchange and reserve public key) and successfully sent it
// to the bank?
selection_done: boolean;
// The transfer has been confirmed and registered by the bank.
// Does not guarantee that the funds have arrived at the exchange already.
transfer_done: boolean;
// Amount that will be withdrawn with this operation
// (raw amount without fee considerations).
amount: AmountString;
// Bank account of the customer that is withdrawing, as a
// payto URI.
sender_wire?: PaytoString;
// Suggestion for an exchange given by the bank.
suggested_exchange?: string;
// URL that the user needs to navigate to in order to
// complete some final confirmation (e.g. 2FA).
// It may contain withdrawal operation id
confirm_transfer_url?: string;
// Wire transfer types supported by the bank.
wire_types: string[];
}
export interface BankWithdrawalOperationPostRequest {
// Reserve public key.
reserve_pub: string;
// Payto address of the exchange selected for the withdrawal.
selected_exchange: PaytoString;
}
export interface BankWithdrawalOperationPostResponse {
// The transfer has been confirmed and registered by the bank.
// Does not guarantee that the funds have arrived at the exchange already.
transfer_done: boolean;
// URL that the user needs to navigate to in order to
// complete some final confirmation (e.g. 2FA).
//
// Only applicable when transfer_done is false.
// It may contain withdrawal operation id
confirm_transfer_url?: string;
}
}
export namespace TalerCorebankApi {
export interface IntegrationConfig {
// libtool-style representation of the Bank protocol version, see
// https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
// The format is "current:revision:age".
version: string;
// Currency used by this bank.
currency: string;
// How the bank SPA should render this currency.
currency_specification: CurrencySpecification;
// Name of the API.
name: "taler-bank-integration";
}
export interface Config {
// Name of this API, always "taler-corebank".
name: "libeufin-bank";
// name: "taler-corebank";
// API version in the form $n:$n:$n
version: string;
// If 'true' anyone can register
// If 'false' only the admin can
allow_registrations: boolean;
// If 'true' account can delete themselves
// If 'false' only the admin can delete accounts
allow_deletions: boolean;
// If 'true', the server provides local currency
// conversion support.
// If missing or false, some parts of the API
// are not supported and return 404.
have_cashout?: boolean;
// How the bank SPA should render the currency.
currency: CurrencySpecification;
// Fiat currency. That is the currency in which
// cash-out operations ultimately wire money.
// Only applicable if have_cashout=true.
fiat_currency?: CurrencySpecification;
// Extra conversion rate information.
// Only present if conversion is supported and the server opts in
// to report the static conversion rate.
conversion_info?: ConversionRatesResponse
}
export interface BankAccountCreateWithdrawalRequest {
// Amount to withdraw.
amount: AmountString;
}
export interface BankAccountCreateWithdrawalResponse {
// ID of the withdrawal, can be used to view/modify the withdrawal operation.
withdrawal_id: string;
// URI that can be passed to the wallet to initiate the withdrawal.
taler_withdraw_uri: TalerActionString;
}
export interface BankAccountGetWithdrawalResponse {
// Amount that will be withdrawn with this withdrawal operation.
amount: AmountString;
// Was the withdrawal aborted?
aborted: boolean;
// Has the withdrawal been confirmed by the bank?
// The wire transfer for a withdrawal is only executed once
// both confirmation_done is true and selection_done is true.
confirmation_done: boolean;
// Did the wallet select reserve details?
selection_done: boolean;
// Reserve public key selected by the exchange,
// only non-null if selection_done is true.
selected_reserve_pub: string | undefined;
// Exchange account selected by the wallet, or by the bank
// (with the default exchange) in case the wallet did not provide one
// through the Integration API.
selected_exchange_account: PaytoString | undefined;
}
export interface BankAccountTransactionsResponse {
transactions: BankAccountTransactionInfo[];
}
export interface BankAccountTransactionInfo {
creditor_payto_uri: PaytoString;
debtor_payto_uri: PaytoString;
amount: AmountString;
direction: "debit" | "credit";
subject: string;
// Transaction unique ID. Matches
// $transaction_id from the URI.
row_id: number;
date: Timestamp;
}
export interface CreateBankAccountTransactionCreate {
// Address in the Payto format of the wire transfer receiver.
// It needs at least the 'message' query string parameter.
payto_uri: PaytoString;
// Transaction amount (in the $currency:x.y format), optional.
// However, when not given, its value must occupy the 'amount'
// query string parameter of the 'payto' field. In case it
// is given in both places, the paytoUri's takes the precedence.
amount?: AmountString;
}
export interface RegisterAccountRequest {
// Username
username: string;
// Password.
password: string;
// Legal name of the account owner
name: string;
// Defaults to false.
is_public?: boolean;
// Is this a taler exchange account?
// If true:
// - incoming transactions to the account that do not
// have a valid reserve public key are automatically
// - the account provides the taler-wire-gateway-api endpoints
// Defaults to false.
is_taler_exchange?: boolean;
// Addresses where to send the TAN for transactions.
// Currently only used for cashouts.
// If missing, cashouts will fail.
// In the future, might be used for other transactions
// as well.
challenge_contact_data?: ChallengeContactData;
// 'payto' address pointing a bank account
// external to the libeufin-bank.
// Payments will be sent to this bank account
// when the user wants to convert the local currency
// back to fiat currency outside libeufin-bank.
cashout_payto_uri?: PaytoString;
// Internal payto URI of this bank account.
// Used mostly for testing.
internal_payto_uri?: PaytoString;
}
export interface ChallengeContactData {
// E-Mail address
email?: EmailAddress;
// Phone number.
phone?: PhoneNumber;
}
export interface AccountReconfiguration {
// Addresses where to send the TAN for transactions.
// Currently only used for cashouts.
// If missing, cashouts will fail.
// In the future, might be used for other transactions
// as well.
challenge_contact_data?: ChallengeContactData;
// 'payto' address pointing a bank account
// external to the libeufin-bank.
// Payments will be sent to this bank account
// when the user wants to convert the local currency
// back to fiat currency outside libeufin-bank.
cashout_address?: PaytoString;
// Legal name associated with $username.
// When missing, the old name is kept.
name?: string;
// If present, change the is_exchange configuration.
// See RegisterAccountRequest
is_exchange?: boolean;
// If present, change the max debit allowed for this user
// Only admin can change this property.
debit_threshold?: AmountString
}
export interface AccountPasswordChange {
// New password.
new_password: string;
// Old password. If present, chec that the old password matches.
// Optional for admin account.
old_password?: string;
}
export interface PublicAccountsResponse {
public_accounts: PublicAccount[];
}
export interface PublicAccount {
payto_uri: PaytoString;
balance: Balance;
// The account name (=username) of the
// libeufin-bank account.
account_name: string;
}
export interface ListBankAccountsResponse {
accounts: AccountMinimalData[];
}
export interface Balance {
amount: AmountString;
credit_debit_indicator: "credit" | "debit";
}
export interface AccountMinimalData {
// Username
username: string;
// Legal name of the account owner.
name: string;
// current balance of the account
balance: Balance;
// Number indicating the max debit allowed for the requesting user.
debit_threshold: AmountString;
}
export interface AccountData {
// Legal name of the account owner.
name: string;
// Available balance on the account.
balance: Balance;
// payto://-URI of the account.
payto_uri: PaytoString;
// Number indicating the max debit allowed for the requesting user.
debit_threshold: AmountString;
contact_data?: ChallengeContactData;
// 'payto' address pointing the bank account
// where to send cashouts. This field is optional
// because not all the accounts are required to participate
// in the merchants' circuit. One example is the exchange:
// that never cashouts. Registering these accounts can
// be done via the access API.
cashout_payto_uri?: PaytoString;
}
export interface CashoutRequest {
// Optional subject to associate to the
// cashout operation. This data will appear
// as the incoming wire transfer subject in
// the user's external bank account.
subject?: string;
// That is the plain amount that the user specified
// to cashout. Its $currency is the (regional) currency of the
// bank instance.
amount_debit: AmountString;
// That is the amount that will effectively be
// transferred by the bank to the user's bank
// account, that is external to the regional currency.
// It is expressed in the fiat currency and
// is calculated after the cashout fee and the
// exchange rate. See the /cashout-rates call.
// The client needs to calculate this amount
// correctly based on the amount_debit and the cashout rate,
// otherwise the request will fail.
amount_credit: AmountString;
// Which channel the TAN should be sent to. If
// this field is missing, it defaults to SMS.
// The default choice prefers to change the communication
// channel respect to the one used to issue this request.
tan_channel?: TanChannel;
}
export interface CashoutPending {
// ID identifying the operation being created
// and now waiting for the TAN confirmation.
cashout_id: string;
}
export interface CashoutConfirmRequest {
// the TAN that confirms $CASHOUT_ID.
tan: string;
}
export interface CashoutConversionResponse {
// Amount that the user will get deducted from their regional
// bank account, according to the 'amount_credit' value.
amount_debit: AmountString;
// Amount that the user will receive in their fiat
// bank account, according to 'amount_debit'.
amount_credit: AmountString;
}
export interface Cashouts {
// Every string represents a cash-out operation ID.
cashouts: CashoutInfo[];
}
export interface CashoutInfo {
cashout_id: string;
status: "pending" | "confirmed";
}
export interface GlobalCashouts {
// Every string represents a cash-out operation ID.
cashouts: GlobalCashoutInfo[];
}
export interface GlobalCashoutInfo {
cashout_id: string;
username: string;
status: "pending" | "confirmed";
}
export interface CashoutStatusResponse {
status: "pending" | "confirmed";
// Amount debited to the internal
// regional currency bank account.
amount_debit: AmountString;
// Amount credited to the external bank account.
amount_credit: AmountString;
// Transaction subject.
subject: string;
// Fiat bank account that will receive the cashed out amount.
// Specified as a payto URI.
credit_payto_uri: PaytoString;
// Time when the cashout was created.
creation_time: Timestamp;
// Time when the cashout was confirmed via its TAN.
// Missing when the operation wasn't confirmed yet.
confirmation_time?: Timestamp;
}
export interface ConversionRatesResponse {
// Exchange rate to buy the local currency from the external one
buy_at_ratio: DecimalNumber;
// Exchange rate to sell the local currency for the external one
sell_at_ratio: DecimalNumber;
// Fee to subtract after applying the buy ratio.
buy_in_fee: DecimalNumber;
// Fee to subtract after applying the sell ratio.
sell_out_fee: DecimalNumber;
}
export enum MonitorTimeframeParam {
hour, day, month, year, decade,
}
export type MonitorResponse =
| MonitorJustPayouts
| MonitorWithCashout;
// Monitoring stats when conversion is not supported
export interface MonitorJustPayouts {
type: "just-payouts";
// This number identifies how many payments were made by a
// Taler exchange to a merchant bank account in the internal
// currency, in the timeframe specified in the request.
talerPayoutCount: number;
// This amount accounts the overall *internal* currency that
// has been paid by a Taler exchange to a merchant internal
// bank account, in the timeframe specified in the request.
talerPayoutInternalVolume: AmountString;
}
// Monitoring stats when conversion is supported
export interface MonitorWithCashout {
type: "with-cashout";
// This number identifies how many cashin operations
// took place in the timeframe specified in the request.
// This number corresponds to how many withdrawals have
// been initiated by a wallet owner. Note: wallet owners
// are NOT required to be customers of the libeufin-bank.
cashinCount: number;
// This amount accounts how much external currency has been
// spent to withdraw Taler coins in the internal currency.
// The exact amount of internal currency being created can be
// calculated using the advertised conversion rates.
cashinExternalVolume: AmountString;
// This number identifies how many cashout operations were
// confirmed in the timeframe speficied in the request.
cashoutCount: number;
// This amount corresponds to how much *external* currency was
// paid by the libeufin-bank administrator to fulfill all the
// confirmed cashouts related to the timeframe specified in the
// request.
cashoutExternalVolume: AmountString;
// This number identifies how many payments were made by a
// Taler exchange to a merchant bank account in the internal
// currency, in the timeframe specified in the request.
talerPayoutCount: number;
// This amount accounts the overall *internal* currency that
// has been paid by a Taler exchange to a merchant internal
// bank account, in the timeframe specified in the request.
talerPayoutInternalVolume: AmountString;
}
}
export namespace TalerExchangeApi {
export interface ExchangeVersionResponse {
// libtool-style representation of the Exchange protocol version, see
// https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
// The format is "current:revision:age".
version: string;
// Name of the protocol.
name: "taler-exchange";
// Currency supported by this exchange.
currency: string;
// How wallets should render this currency.
currency_specification: CurrencySpecification;
// Names of supported KYC requirements.
supported_kyc_requirements: string[];
}
type AccountRestriction =
| RegexAccountRestriction
| DenyAllAccountRestriction
// Account restriction that disables this type of
// account for the indicated operation categorically.
interface DenyAllAccountRestriction {
type: "deny";
}
// Accounts interacting with this type of account
// restriction must have a payto://-URI matching
// the given regex.
interface RegexAccountRestriction {
type: "regex";
// Regular expression that the payto://-URI of the
// partner account must follow. The regular expression
// should follow posix-egrep, but without support for character
// classes, GNU extensions, back-references or intervals. See
// https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002degrep-regular-expression-syntax.html
// for a description of the posix-egrep syntax. Applications
// may support regexes with additional features, but exchanges
// must not use such regexes.
payto_regex: string;
// Hint for a human to understand the restriction
// (that is hopefully easier to comprehend than the regex itself).
human_hint: string;
// Map from IETF BCP 47 language tags to localized
// human hints.
human_hint_i18n?: { [lang_tag: string]: string };
}
export interface WireAccount {
// payto:// URI identifying the account and wire method
payto_uri: PaytoString;
// URI to convert amounts from or to the currency used by
// this wire account of the exchange. Missing if no
// conversion is applicable.
conversion_url?: string;
// Restrictions that apply to bank accounts that would send
// funds to the exchange (crediting this exchange bank account).
// Optional, empty array for unrestricted.
credit_restrictions: AccountRestriction[];
// Restrictions that apply to bank accounts that would receive
// funds from the exchange (debiting this exchange bank account).
// Optional, empty array for unrestricted.
debit_restrictions: AccountRestriction[];
// Signature using the exchange's offline key over
// a TALER_MasterWireDetailsPS
// with purpose TALER_SIGNATURE_MASTER_WIRE_DETAILS.
master_sig: EddsaSignature;
}
}
export namespace TalerMerchantApi {
export interface VersionResponse {
// libtool-style representation of the Merchant protocol version, see
// https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
// The format is "current:revision:age".
version: string;
// Name of the protocol.
name: "taler-merchant";
// Default (!) currency supported by this backend.
// This is the currency that the backend should
// suggest by default to the user when entering
// amounts. See currencies for a list of
// supported currencies and how to render them.
currency: string;
// How wallets should render currencies supported
// by this backend. Maps
// currency codes (e.g. "EUR" or "KUDOS") to
// the respective currency specification.
// All currencies in this map are supported by
// the backend.
currencies: { [currency: string]: CurrencySpecification };
}
export interface ClaimRequest {
// Nonce to identify the wallet that claimed the order.
nonce: string;
// Token that authorizes the wallet to claim the order.
// *Optional* as the merchant may not have required it
// (create_token set to false in PostOrderRequest).
token?: ClaimToken;
}
export interface ClaimResponse {
// Contract terms of the claimed order
contract_terms: ContractTerms;
// Signature by the merchant over the contract terms.
sig: EddsaSignature;
}
export interface PaymentResponse {
// Signature on TALER_PaymentResponsePS with the public
// key of the merchant instance.
sig: EddsaSignature;
// Text to be shown to the point-of-sale staff as a proof of
// payment.
pos_confirmation?: string;
}
interface PayRequest {
// The coins used to make the payment.
coins: CoinPaySig[];
// Custom inputs from the wallet for the contract.
wallet_data?: Object;
// The session for which the payment is made (or replayed).
// Only set for session-based payments.
session_id?: string;
}
export interface CoinPaySig {
// Signature by the coin.
coin_sig: EddsaSignature;
// Public key of the coin being spent.
coin_pub: EddsaPublicKey;
// Signature made by the denomination public key.
ub_sig: RsaSignature;
// The hash of the denomination public key associated with this coin.
h_denom: HashCode;
// The amount that is subtracted from this coin with this payment.
contribution: AmountString;
// URL of the exchange this coin was withdrawn from.
exchange_url: string;
}
interface StatusPaid {
// Was the payment refunded (even partially, via refund or abort)?
refunded: boolean;
// Is any amount of the refund still waiting to be picked up (even partially)?
refund_pending: boolean;
// Amount that was refunded in total.
refund_amount: AmountString;
// Amount that already taken by the wallet.
refund_taken: AmountString;
}
interface StatusGotoResponse {
// The client should go to the reorder URL, there a fresh
// order might be created as this one is taken by another
// customer or wallet (or repurchase detection logic may
// apply).
public_reorder_url: string;
}
interface StatusUnpaidResponse {
// URI that the wallet must process to complete the payment.
taler_pay_uri: string;
// Status URL, can be used as a redirect target for the browser
// to show the order QR code / trigger the wallet.
fulfillment_url?: string;
// Alternative order ID which was paid for already in the same session.
// Only given if the same product was purchased before in the same session.
already_paid_order_id?: string;
}
interface PaidRefundStatusResponse {
// Text to be shown to the point-of-sale staff as a proof of
// payment (present only if re-usable OTP algorithm is used).
pos_confirmation?: string;
// True if the order has been subjected to
// refunds. False if it was simply paid.
refunded: boolean;
}
interface PaidRequest {
// Signature on TALER_PaymentResponsePS with the public
// key of the merchant instance.
sig: EddsaSignature;
// Hash of the order's contract terms (this is used to authenticate the
// wallet/customer and to enable signature verification without
// database access).
h_contract: HashCode;
// Hash over custom inputs from the wallet for the contract.
wallet_data_hash?: HashCode;
// Session id for which the payment is proven.
session_id: string;
}
interface AbortRequest {
// Hash of the order's contract terms (this is used to authenticate the
// wallet/customer in case $ORDER_ID is guessable).
h_contract: HashCode;
// List of coins the wallet would like to see refunds for.
// (Should be limited to the coins for which the original
// payment succeeded, as far as the wallet knows.)
coins: AbortingCoin[];
}
interface AbortingCoin {
// Public key of a coin for which the wallet is requesting an abort-related refund.
coin_pub: EddsaPublicKey;
// The amount to be refunded (matches the original contribution)
contribution: AmountString;
// URL of the exchange this coin was withdrawn from.
exchange_url: string;
}
interface AbortResponse {
// List of refund responses about the coins that the wallet
// requested an abort for. In the same order as the coins
// from the original request.
// The rtransaction_id is implied to be 0.
refunds: MerchantAbortPayRefundStatus[];
}
type MerchantAbortPayRefundStatus =
| MerchantAbortPayRefundSuccessStatus
| MerchantAbortPayRefundFailureStatus;
// Details about why a refund failed.
interface MerchantAbortPayRefundFailureStatus {
// Used as tag for the sum type RefundStatus sum type.
type: "failure";
// HTTP status of the exchange request, must NOT be 200.
exchange_status: Integer;
// Taler error code from the exchange reply, if available.
exchange_code?: Integer;
// If available, HTTP reply from the exchange.
exchange_reply?: Object;
}
// Additional details needed to verify the refund confirmation signature
// (h_contract_terms and merchant_pub) are already known
// to the wallet and thus not included.
interface MerchantAbortPayRefundSuccessStatus {
// Used as tag for the sum type MerchantCoinRefundStatus sum type.
type: "success";
// HTTP status of the exchange request, 200 (integer) required for refund confirmations.
exchange_status: 200;
// The EdDSA :ref:signature (binary-only) with purpose
// TALER_SIGNATURE_EXCHANGE_CONFIRM_REFUND using a current signing key of the
// exchange affirming the successful refund.
exchange_sig: EddsaSignature;
// Public EdDSA key of the exchange that was used to generate the signature.
// Should match one of the exchange's signing keys from /keys. It is given
// explicitly as the client might otherwise be confused by clock skew as to
// which signing key was used.
exchange_pub: EddsaPublicKey;
}
interface WalletRefundRequest {
// Hash of the order's contract terms (this is used to authenticate the
// wallet/customer).
h_contract: HashCode;
}
interface WalletRefundResponse {
// Amount that was refunded in total.
refund_amount: AmountString;
// Successful refunds for this payment, empty array for none.
refunds: MerchantCoinRefundStatus[];
// Public key of the merchant.
merchant_pub: EddsaPublicKey;
}
type MerchantCoinRefundStatus =
| MerchantCoinRefundSuccessStatus
| MerchantCoinRefundFailureStatus;
// Details about why a refund failed.
interface MerchantCoinRefundFailureStatus {
// Used as tag for the sum type RefundStatus sum type.
type: "failure";
// HTTP status of the exchange request, must NOT be 200.
exchange_status: Integer;
// Taler error code from the exchange reply, if available.
exchange_code?: Integer;
// If available, HTTP reply from the exchange.
exchange_reply?: Object;
// Refund transaction ID.
rtransaction_id: Integer;
// Public key of a coin that was refunded.
coin_pub: EddsaPublicKey;
// Amount that was refunded, including refund fee charged by the exchange
// to the customer.
refund_amount: AmountString;
// Timestamp when the merchant approved the refund.
// Useful for grouping refunds.
execution_time: Timestamp;
}
// Additional details needed to verify the refund confirmation signature
// (h_contract_terms and merchant_pub) are already known
// to the wallet and thus not included.
interface MerchantCoinRefundSuccessStatus {
// Used as tag for the sum type MerchantCoinRefundStatus sum type.
type: "success";
// HTTP status of the exchange request, 200 (integer) required for refund confirmations.
exchange_status: 200;
// The EdDSA :ref:signature (binary-only) with purpose
// TALER_SIGNATURE_EXCHANGE_CONFIRM_REFUND using a current signing key of the
// exchange affirming the successful refund.
exchange_sig: EddsaSignature;
// Public EdDSA key of the exchange that was used to generate the signature.
// Should match one of the exchange's signing keys from /keys. It is given
// explicitly as the client might otherwise be confused by clock skew as to
// which signing key was used.
exchange_pub: EddsaPublicKey;
// Refund transaction ID.
rtransaction_id: Integer;
// Public key of a coin that was refunded.
coin_pub: EddsaPublicKey;
// Amount that was refunded, including refund fee charged by the exchange
// to the customer.
refund_amount: AmountString;
// Timestamp when the merchant approved the refund.
// Useful for grouping refunds.
execution_time: Timestamp;
}
interface RewardInformation {
// Exchange from which the reward will be withdrawn. Needed by the
// wallet to determine denominations, fees, etc.
exchange_url: string;
// URL where to go after obtaining the reward.
next_url: string;
// (Remaining) amount of the reward (including fees).
reward_amount: AmountString;
// Timestamp indicating when the reward is set to expire (may be in the past).
// Note that rewards that have expired MAY also result in a 404 response.
expiration: Timestamp;
}
interface RewardPickupRequest {
// List of planchets the wallet wants to use for the reward.
planchets: PlanchetDetail[];
}
interface PlanchetDetail {
// Hash of the denomination's public key (hashed to reduce
// bandwidth consumption).
denom_pub_hash: HashCode;
// Coin's blinded public key.
coin_ev: CoinEnvelope;
}
interface RewardResponse {
// Blind RSA signatures over the planchets.
// The order of the signatures matches the planchets list.
blind_sigs: BlindSignature[];
}
interface BlindSignature {
// The (blind) RSA signature. Still needs to be unblinded.
blind_sig: BlindedRsaSignature;
}
interface InstanceConfigurationMessage {
// Name of the merchant instance to create (will become $INSTANCE).
// Must match the regex ^[A-Za-z0-9][A-Za-z0-9_.@-]+$.
id: string;
// Merchant name corresponding to this instance.
name: string;
// Type of the user (business or individual).
// Defaults to 'business'. Should become mandatory field
// in the future, left as optional for API compatibility for now.
user_type?: string;
// Merchant email for customer contact.
email?: string;
// Merchant public website.
website?: string;
// Merchant logo.
logo?: ImageDataUrl;
// Authentication settings for this instance
auth: InstanceAuthConfigurationMessage;
// The merchant's physical address (to be put into contracts).
address: Location;
// The jurisdiction under which the merchant conducts its business
// (to be put into contracts).
jurisdiction: Location;
// Use STEFAN curves to determine default fees?
// If false, no fees are allowed by default.
// Can always be overridden by the frontend on a per-order basis.
use_stefan: boolean;
// If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
default_wire_transfer_delay: RelativeTime;
// If the frontend does NOT specify a payment deadline, how long should
// offers we make be valid by default?
default_pay_delay: RelativeTime;
}
interface InstanceAuthConfigurationMessage {
// Type of authentication.
// "external": The mechant backend does not do
// any authentication checks. Instead an API
// gateway must do the authentication.
// "token": The merchant checks an auth token.
// See "token" for details.
method: "external" | "token";
// For method "token", this field is mandatory.
// The token MUST begin with the string "secret-token:".
// After the auth token has been set (with method "token"),
// the value must be provided in a "Authorization: Bearer $token"
// header.
token?: string;
}
interface LoginTokenRequest {
// Scope of the token (which kinds of operations it will allow)
scope: "readonly" | "write";
// Server may impose its own upper bound
// on the token validity duration
duration?: RelativeTime;
// Can this token be refreshed?
// Defaults to false.
refreshable?: boolean;
}
interface LoginTokenSuccessResponse {
// The login token that can be used to access resources
// that are in scope for some time. Must be prefixed
// with "Bearer " when used in the "Authorization" HTTP header.
// Will already begin with the RFC 8959 prefix.
token: string;
// Scope of the token (which kinds of operations it will allow)
scope: "readonly" | "write";
// Server may impose its own upper bound
// on the token validity duration
expiration: Timestamp;
// Can this token be refreshed?
refreshable: boolean;
}
interface InstanceReconfigurationMessage {
// Merchant name corresponding to this instance.
name: string;
// Type of the user (business or individual).
// Defaults to 'business'. Should become mandatory field
// in the future, left as optional for API compatibility for now.
user_type?: string;
// Merchant email for customer contact.
email?: string;
// Merchant public website.
website?: string;
// Merchant logo.
logo?: ImageDataUrl;
// The merchant's physical address (to be put into contracts).
address: Location;
// The jurisdiction under which the merchant conducts its business
// (to be put into contracts).
jurisdiction: Location;
// Use STEFAN curves to determine default fees?
// If false, no fees are allowed by default.
// Can always be overridden by the frontend on a per-order basis.
use_stefan: boolean;
// If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
default_wire_transfer_delay: RelativeTime;
// If the frontend does NOT specify a payment deadline, how long should
// offers we make be valid by default?
default_pay_delay: RelativeTime;
}
interface InstancesResponse {
// List of instances that are present in the backend (see Instance).
instances: Instance[];
}
interface Instance {
// Merchant name corresponding to this instance.
name: string;
// Type of the user ("business" or "individual").
user_type: string;
// Merchant public website.
website?: string;
// Merchant logo.
logo?: ImageDataUrl;
// Merchant instance this response is about ($INSTANCE).
id: string;
// Public key of the merchant/instance, in Crockford Base32 encoding.
merchant_pub: EddsaPublicKey;
// List of the payment targets supported by this instance. Clients can
// specify the desired payment target in /order requests. Note that
// front-ends do not have to support wallets selecting payment targets.
payment_targets: string[];
// Has this instance been deleted (but not purged)?
deleted: boolean;
}
interface QueryInstancesResponse {
// Merchant name corresponding to this instance.
name: string;
// Type of the user ("business" or "individual").
user_type: string;
// Merchant email for customer contact.
email?: string;
// Merchant public website.
website?: string;
// Merchant logo.
logo?: ImageDataUrl;
// Public key of the merchant/instance, in Crockford Base32 encoding.
merchant_pub: EddsaPublicKey;
// The merchant's physical address (to be put into contracts).
address: Location;
// The jurisdiction under which the merchant conducts its business
// (to be put into contracts).
jurisdiction: Location;
// Use STEFAN curves to determine default fees?
// If false, no fees are allowed by default.
// Can always be overridden by the frontend on a per-order basis.
use_stefan: boolean;
// If the frontend does NOT specify an execution date, how long should
// we tell the exchange to wait to aggregate transactions before
// executing the wire transfer? This delay is added to the current
// time when we generate the advisory execution time for the exchange.
default_wire_transfer_delay: RelativeTime;
// If the frontend does NOT specify a payment deadline, how long should
// offers we make be valid by default?
default_pay_delay: RelativeTime;
// Authentication configuration.
// Does not contain the token when token auth is configured.
auth: {
type: "external" | "token";
};
}
interface AccountKycRedirects {
// Array of pending KYCs.
pending_kycs: MerchantAccountKycRedirect[];
// Array of exchanges with no reply.
timeout_kycs: ExchangeKycTimeout[];
}
interface MerchantAccountKycRedirect {
// URL that the user should open in a browser to
// proceed with the KYC process (as returned
// by the exchange's /kyc-check/ endpoint).
// Optional, missing if the account is blocked
// due to AML and not due to KYC.
kyc_url?: string;
// AML status of the account.
aml_status: Integer;
// Base URL of the exchange this is about.
exchange_url: string;
// Our bank wire account this is about.
payto_uri: PaytoString;
}
interface ExchangeKycTimeout {
// Base URL of the exchange this is about.
exchange_url: string;
// Numeric error code indicating errors the exchange
// returned, or TALER_EC_INVALID for none.
exchange_code: number;
// HTTP status code returned by the exchange when we asked for
// information about the KYC status.
// 0 if there was no response at all.
exchange_http_status: number;
}
interface AccountAddDetails {
// payto:// URI of the account.
payto_uri: PaytoString;
// URL from where the merchant can download information
// about incoming wire transfers to this account.
credit_facade_url?: string;
// Credentials to use when accessing the credit facade.
// Never returned on a GET (as this may be somewhat
// sensitive data). Can be set in POST
// or PATCH requests to update (or delete) credentials.
// To really delete credentials, set them to the type: "none".
credit_facade_credentials?: FacadeCredentials;
}
type FacadeCredentials =
| NoFacadeCredentials
| BasicAuthFacadeCredentials;
interface NoFacadeCredentials {
type: "none";
};
interface BasicAuthFacadeCredentials {
type: "basic";
// Username to use to authenticate
username: string;
// Password to use to authenticate
password: string;
};
interface AccountAddResponse {
// Hash over the wire details (including over the salt).
h_wire: HashCode;
// Salt used to compute h_wire.
salt: HashCode;
}
interface AccountPatchDetails {
// URL from where the merchant can download information
// about incoming wire transfers to this account.
credit_facade_url?: string;
// Credentials to use when accessing the credit facade.
// Never returned on a GET (as this may be somewhat
// sensitive data). Can be set in POST
// or PATCH requests to update (or delete) credentials.
// To really delete credentials, set them to the type: "none".
// If the argument is omitted, the old credentials
// are simply preserved.
credit_facade_credentials?: FacadeCredentials;
}
interface AccountsSummaryResponse {
// List of accounts that are known for the instance.
accounts: BankAccountEntry[];
}
interface BankAccountEntry {
// payto:// URI of the account.
payto_uri: PaytoString;
// Hash over the wire details (including over the salt).
h_wire: HashCode;
// Salt used to compute h_wire.
salt: HashCode;
// URL from where the merchant can download information
// about incoming wire transfers to this account.
credit_facade_url?: string;
// true if this account is active,
// false if it is historic.
active: boolean;
}
interface ProductAddDetail {
// Product ID to use.
product_id: string;
// Human-readable product description.
description: string;
// Map from IETF BCP 47 language tags to localized descriptions.
description_i18n?: { [lang_tag: string]: string };
// Unit in which the product is measured (liters, kilograms, packages, etc.).
unit: string;
// The price for one unit of the product. Zero is used
// to imply that this product is not sold separately, or
// that the price is not fixed, and must be supplied by the
// front-end. If non-zero, this price MUST include applicable
// taxes.
price: AmountString;
// An optional base64-encoded product image.
image?: ImageDataUrl;
// A list of taxes paid by the merchant for one unit of this product.
taxes?: Tax[];
// Number of units of the product in stock in sum in total,
// including all existing sales ever. Given in product-specific
// units.
// A value of -1 indicates "infinite" (i.e. for "electronic" books).
total_stock: Integer;
// Identifies where the product is in stock.
address?: Location;
// Identifies when we expect the next restocking to happen.
next_restock?: Timestamp;
// Minimum age buyer must have (in years). Default is 0.
minimum_age?: Integer;
}
interface ProductPatchDetail {
// Human-readable product description.
description: string;
// Map from IETF BCP 47 language tags to localized descriptions.
description_i18n?: { [lang_tag: string]: string };
// Unit in which the product is measured (liters, kilograms, packages, etc.).
unit: string;
// The price for one unit of the product. Zero is used
// to imply that this product is not sold separately, or
// that the price is not fixed, and must be supplied by the
// front-end. If non-zero, this price MUST include applicable
// taxes.
price: AmountString;
// An optional base64-encoded product image.
image?: ImageDataUrl;
// A list of taxes paid by the merchant for one unit of this product.
taxes?: Tax[];
// Number of units of the product in stock in sum in total,
// including all existing sales ever. Given in product-specific
// units.
// A value of -1 indicates "infinite" (i.e. for "electronic" books).
total_stock: Integer;
// Number of units of the product that were lost (spoiled, stolen, etc.).
total_lost?: Integer;
// Identifies where the product is in stock.
address?: Location;
// Identifies when we expect the next restocking to happen.
next_restock?: Timestamp;
// Minimum age buyer must have (in years). Default is 0.
minimum_age?: Integer;
}
interface InventorySummaryResponse {
// List of products that are present in the inventory.
products: InventoryEntry[];
}
interface InventoryEntry {
// Product identifier, as found in the product.
product_id: string;
}
interface ProductDetail {
// Human-readable product description.
description: string;
// Map from IETF BCP 47 language tags to localized descriptions.
description_i18n: { [lang_tag: string]: string };
// Unit in which the product is measured (liters, kilograms, packages, etc.).
unit: string;
// The price for one unit of the product. Zero is used
// to imply that this product is not sold separately, or
// that the price is not fixed, and must be supplied by the
// front-end. If non-zero, this price MUST include applicable
// taxes.
price: AmountString;
// An optional base64-encoded product image.
image: ImageDataUrl;
// A list of taxes paid by the merchant for one unit of this product.
taxes: Tax[];
// Number of units of the product in stock in sum in total,
// including all existing sales ever. Given in product-specific
// units.
// A value of -1 indicates "infinite" (i.e. for "electronic" books).
total_stock: Integer;
// Number of units of the product that have already been sold.
total_sold: Integer;
// Number of units of the product that were lost (spoiled, stolen, etc.).
total_lost: Integer;
// Identifies where the product is in stock.
address: Location;
// Identifies when we expect the next restocking to happen.
next_restock?: Timestamp;
// Minimum age buyer must have (in years).
minimum_age?: Integer;
}
interface LockRequest {
// UUID that identifies the frontend performing the lock
// Must be unique for the lifetime of the lock.
lock_uuid: string;
// How long does the frontend intend to hold the lock?
duration: RelativeTime;
// How many units should be locked?
quantity: Integer;
}
interface PostOrderRequest {
// The order must at least contain the minimal
// order detail, but can override all.
order: Order;
// If set, the backend will then set the refund deadline to the current
// time plus the specified delay. If it's not set, refunds will not be
// possible.
refund_delay?: RelativeTime;
// Specifies the payment target preferred by the client. Can be used
// to select among the various (active) wire methods supported by the instance.
payment_target?: string;
// Specifies that some products are to be included in the
// order from the inventory. For these inventory management
// is performed (so the products must be in stock) and
// details are completed from the product data of the backend.
inventory_products?: MinimalInventoryProduct[];
// Specifies a lock identifier that was used to
// lock a product in the inventory. Only useful if
// inventory_products is set. Used in case a frontend
// reserved quantities of the individual products while
// the shopping cart was being built. Multiple UUIDs can
// be used in case different UUIDs were used for different
// products (i.e. in case the user started with multiple
// shopping sessions that were combined during checkout).
lock_uuids: string[];
// Should a token for claiming the order be generated?
// False can make sense if the ORDER_ID is sufficiently
// high entropy to prevent adversarial claims (like it is
// if the backend auto-generates one). Default is 'true'.
create_token?: boolean;
// OTP device ID to associate with the order.
// This parameter is optional.
otp_id?: string;
}
type Order = MinimalOrderDetail | ContractTerms;
interface MinimalOrderDetail {
// Amount to be paid by the customer.
amount: AmountString;
// Short summary of the order.
summary: string;
// See documentation of fulfillment_url in ContractTerms.
// Either fulfillment_url or fulfillment_message must be specified.
fulfillment_url?: string;
// See documentation of fulfillment_message in ContractTerms.
// Either fulfillment_url or fulfillment_message must be specified.
fulfillment_message?: string;
}
interface MinimalInventoryProduct {
// Which product is requested (here mandatory!).
product_id: string;
// How many units of the product are requested.
quantity: Integer;
}
interface PostOrderResponse {
// Order ID of the response that was just created.
order_id: string;
// Token that authorizes the wallet to claim the order.
// Provided only if "create_token" was set to 'true'
// in the request.
token?: ClaimToken;
}
interface OutOfStockResponse {
// Product ID of an out-of-stock item.
product_id: string;
// Requested quantity.
requested_quantity: Integer;
// Available quantity (must be below requested_quantity).
available_quantity: Integer;
// When do we expect the product to be again in stock?
// Optional, not given if unknown.
restock_expected?: Timestamp;
}
interface OrderHistory {
// Timestamp-sorted array of all orders matching the query.
// The order of the sorting depends on the sign of delta.
orders: OrderHistoryEntry[];
}
interface OrderHistoryEntry {
// Order ID of the transaction related to this entry.
order_id: string;
// Row ID of the order in the database.
row_id: number;
// When the order was created.
timestamp: Timestamp;
// The amount of money the order is for.
amount: AmountString;
// The summary of the order.
summary: string;
// Whether some part of the order is refundable,
// that is the refund deadline has not yet expired
// and the total amount refunded so far is below
// the value of the original transaction.
refundable: boolean;
// Whether the order has been paid or not.
paid: boolean;
}
type MerchantOrderStatusResponse = CheckPaymentPaidResponse |
CheckPaymentClaimedResponse |
CheckPaymentUnpaidResponse;
interface CheckPaymentPaidResponse {
// The customer paid for this contract.
order_status: "paid";
// Was the payment refunded (even partially)?
refunded: boolean;
// True if there are any approved refunds that the wallet has
// not yet obtained.
refund_pending: boolean;
// Did the exchange wire us the funds?
wired: boolean;
// Total amount the exchange deposited into our bank account
// for this contract, excluding fees.
deposit_total: AmountString;
// Numeric error code indicating errors the exchange
// encountered tracking the wire transfer for this purchase (before
// we even got to specific coin issues).
// 0 if there were no issues.
exchange_code: number;
// HTTP status code returned by the exchange when we asked for
// information to track the wire transfer for this purchase.
// 0 if there were no issues.
exchange_http_status: number;
// Total amount that was refunded, 0 if refunded is false.
refund_amount: AmountString;
// Contract terms.
contract_terms: ContractTerms;
// The wire transfer status from the exchange for this order if
// available, otherwise empty array.
wire_details: TransactionWireTransfer[];
// Reports about trouble obtaining wire transfer details,
// empty array if no trouble were encountered.
wire_reports: TransactionWireReport[];
// The refund details for this order. One entry per
// refunded coin; empty array if there are no refunds.
refund_details: RefundDetails[];
// Status URL, can be used as a redirect target for the browser
// to show the order QR code / trigger the wallet.
order_status_url: string;
}
interface CheckPaymentClaimedResponse {
// A wallet claimed the order, but did not yet pay for the contract.
order_status: "claimed";
// Contract terms.
contract_terms: ContractTerms;
}
interface CheckPaymentUnpaidResponse {
// The order was neither claimed nor paid.
order_status: "unpaid";
// URI that the wallet must process to complete the payment.
taler_pay_uri: string;
// when was the order created
creation_time: Timestamp;
// Order summary text.
summary: string;
// Total amount of the order (to be paid by the customer).
total_amount: AmountString;
// Alternative order ID which was paid for already in the same session.
// Only given if the same product was purchased before in the same session.
already_paid_order_id?: string;
// Fulfillment URL of an already paid order. Only given if under this
// session an already paid order with a fulfillment URL exists.
already_paid_fulfillment_url?: string;
// Status URL, can be used as a redirect target for the browser
// to show the order QR code / trigger the wallet.
order_status_url: string;
// We do we NOT return the contract terms here because they may not
// exist in case the wallet did not yet claim them.
}
interface RefundDetails {
// Reason given for the refund.
reason: string;
// Set to true if a refund is still available for the wallet for this payment.
pending: boolean;
// When was the refund approved.
timestamp: Timestamp;
// Total amount that was refunded (minus a refund fee).
amount: AmountString;
}
interface TransactionWireTransfer {
// Responsible exchange.
exchange_url: string;
// 32-byte wire transfer identifier.
wtid: Base32;
// Execution time of the wire transfer.
execution_time: Timestamp;
// Total amount that has been wire transferred
// to the merchant.
amount: AmountString;
// Was this transfer confirmed by the merchant via the
// POST /transfers API, or is it merely claimed by the exchange?
confirmed: boolean;
}
interface TransactionWireReport {
// Numerical error code.
code: number;
// Human-readable error description.
hint: string;
// Numerical error code from the exchange.
exchange_code: number;
// HTTP status code received from the exchange.
exchange_http_status: number;
// Public key of the coin for which we got the exchange error.
coin_pub: CoinPublicKey;
}
interface ForgetRequest {
// Array of valid JSON paths to forgettable fields in the order's
// contract terms.
fields: string[];
}
interface RefundRequest {
// Amount to be refunded.
refund: AmountString;
// Human-readable refund justification.
reason: string;
}
interface MerchantRefundResponse {
// URL (handled by the backend) that the wallet should access to
// trigger refund processing.
// taler://refund/...
taler_refund_uri: string;
// Contract hash that a client may need to authenticate an
// HTTP request to obtain the above URI in a wallet-friendly way.
h_contract: HashCode;
}
interface TransferInformation {
// How much was wired to the merchant (minus fees).
credit_amount: AmountString;
// Raw wire transfer identifier identifying the wire transfer (a base32-encoded value).
wtid: WireTransferIdentifierRawP;
// Target account that received the wire transfer.
payto_uri: PaytoString;
// Base URL of the exchange that made the wire transfer.
exchange_url: string;
}
interface TransferList {
// List of all the transfers that fit the filter that we know.
transfers: TransferDetails[];
}
interface TransferDetails {
// How much was wired to the merchant (minus fees).
credit_amount: AmountString;
// Raw wire transfer identifier identifying the wire transfer (a base32-encoded value).
wtid: WireTransferIdentifierRawP;
// Target account that received the wire transfer.
payto_uri: PaytoString;
// Base URL of the exchange that made the wire transfer.
exchange_url: string;
// Serial number identifying the transfer in the merchant backend.
// Used for filtering via offset.
transfer_serial_id: number;
// Time of the execution of the wire transfer by the exchange, according to the exchange
// Only provided if we did get an answer from the exchange.
execution_time?: Timestamp;
// True if we checked the exchange's answer and are happy with it.
// False if we have an answer and are unhappy, missing if we
// do not have an answer from the exchange.
verified?: boolean;
// True if the merchant uses the POST /transfers API to confirm
// that this wire transfer took place (and it is thus not
// something merely claimed by the exchange).
confirmed?: boolean;
}
interface ReserveCreateRequest {
// Amount that the merchant promises to put into the reserve.
initial_balance: AmountString;
// Exchange the merchant intends to use for rewards.
exchange_url: string;
// Desired wire method, for example "iban" or "x-taler-bank".
wire_method: string;
}
interface ReserveCreateConfirmation {
// Public key identifying the reserve.
reserve_pub: EddsaPublicKey;
// Wire accounts of the exchange where to transfer the funds.
accounts: TalerExchangeApi.WireAccount[];
}
interface RewardReserveStatus {
// Array of all known reserves (possibly empty!).
reserves: ReserveStatusEntry[];
}
interface ReserveStatusEntry {
// Public key of the reserve.
reserve_pub: EddsaPublicKey;
// Timestamp when it was established.
creation_time: Timestamp;
// Timestamp when it expires.
expiration_time: Timestamp;
// Initial amount as per reserve creation call.
merchant_initial_amount: AmountString;
// Initial amount as per exchange, 0 if exchange did
// not confirm reserve creation yet.
exchange_initial_amount: AmountString;
// Amount picked up so far.
pickup_amount: AmountString;
// Amount approved for rewards that exceeds the pickup_amount.
committed_amount: AmountString;
// Is this reserve active (false if it was deleted but not purged)?
active: boolean;
}
interface ReserveDetail {
// Timestamp when it was established.
creation_time: Timestamp;
// Timestamp when it expires.
expiration_time: Timestamp;
// Initial amount as per reserve creation call.
merchant_initial_amount: AmountString;
// Initial amount as per exchange, 0 if exchange did
// not confirm reserve creation yet.
exchange_initial_amount: AmountString;
// Amount picked up so far.
pickup_amount: AmountString;
// Amount approved for rewards that exceeds the pickup_amount.
committed_amount: AmountString;
// Array of all rewards created by this reserves (possibly empty!).
// Only present if asked for explicitly.
rewards?: RewardStatusEntry[];
// Is this reserve active (false if it was deleted but not purged)?
active: boolean;
// Array of wire accounts of the exchange that could
// be used to fill the reserve, can be NULL
// if the reserve is inactive or was already filled
accounts?: TalerExchangeApi.WireAccount[];
// URL of the exchange hosting the reserve,
// NULL if the reserve is inactive
exchange_url: string;
}
interface RewardStatusEntry {
// Unique identifier for the reward.
reward_id: HashCode;
// Total amount of the reward that can be withdrawn.
total_amount: AmountString;
// Human-readable reason for why the reward was granted.
reason: string;
}
interface RewardCreateRequest {
// Amount that the customer should be rewarded.
amount: AmountString;
// Justification for giving the reward.
justification: string;
// URL that the user should be directed to after receiving the reward,
// will be included in the reward_token.
next_url: string;
}
interface RewardCreateConfirmation {
// Unique reward identifier for the reward that was created.
reward_id: HashCode;
// taler://reward URI for the reward.
taler_reward_uri: string;
// URL that will directly trigger processing
// the reward when the browser is redirected to it.
reward_status_url: string;
// When does the reward expire?
reward_expiration: Timestamp;
}
interface RewardDetails {
// Amount that we authorized for this reward.
total_authorized: AmountString;
// Amount that was picked up by the user already.
total_picked_up: AmountString;
// Human-readable reason given when authorizing the reward.
reason: string;
// Timestamp indicating when the reward is set to expire (may be in the past).
expiration: Timestamp;
// Reserve public key from which the reward is funded.
reserve_pub: EddsaPublicKey;
// Array showing the pickup operations of the wallet (possibly empty!).
// Only present if asked for explicitly.
pickups?: PickupDetail[];
}
interface PickupDetail {
// Unique identifier for the pickup operation.
pickup_id: HashCode;
// Number of planchets involved.
num_planchets: Integer;
// Total amount requested for this pickup_id.
requested_amount: AmountString;
}
interface RewardsResponse {
// List of rewards that are present in the backend.
rewards: Reward[];
}
interface Reward {
// ID of the reward in the backend database.
row_id: number;
// Unique identifier for the reward.
reward_id: HashCode;
// (Remaining) amount of the reward (including fees).
reward_amount: AmountString;
}
interface OtpDeviceAddDetails {
// Device ID to use.
otp_device_id: string;
// Human-readable description for the device.
otp_device_description: string;
// A base64-encoded key
otp_key: string;
// Algorithm for computing the POS confirmation.
otp_algorithm: Integer;
// Counter for counter-based OTP devices.
otp_ctr?: Integer;
}
interface OtpDevicePatchDetails {
// Human-readable description for the device.
otp_device_description: string;
// A base64-encoded key
otp_key: string;
// Algorithm for computing the POS confirmation.
otp_algorithm: Integer;
// Counter for counter-based OTP devices.
otp_ctr?: Integer;
}
interface OtpDeviceSummaryResponse {
// Array of devices that are present in our backend.
otp_devices: OtpDeviceEntry[];
}
interface OtpDeviceEntry {
// Device identifier.
otp_device_id: string;
// Human-readable description for the device.
device_description: string;
}
interface OtpDeviceDetails {
// Human-readable description for the device.
device_description: string;
// Algorithm for computing the POS confirmation.
otp_algorithm: Integer;
// Counter for counter-based OTP devices.
otp_ctr?: Integer;
}
interface TemplateAddDetails {
// Template ID to use.
template_id: string;
// Human-readable description for the template.
template_description: string;
// OTP device ID.
// This parameter is optional.
otp_id?: string;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface TemplateContractDetails {
// Human-readable summary for the template.
summary?: string;
// Required currency for payments to the template.
// The user may specify any amount, but it must be
// in this currency.
// This parameter is optional and should not be present
// if "amount" is given.
currency?: string;
// The price is imposed by the merchant and cannot be changed by the customer.
// This parameter is optional.
amount?: AmountString;
// Minimum age buyer must have (in years). Default is 0.
minimum_age: Integer;
// The time the customer need to pay before his order will be deleted.
// It is deleted if the customer did not pay and if the duration is over.
pay_duration: RelativeTime;
}
interface TemplatePatchDetails {
// Human-readable description for the template.
template_description: string;
// OTP device ID.
// This parameter is optional.
otp_id?: string;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface TemplateSummaryResponse {
// List of templates that are present in our backend.
templates_list: TemplateEntry[];
}
interface TemplateEntry {
// Template identifier, as found in the template.
template_id: string;
// Human-readable description for the template.
template_description: string;
}
interface TemplateDetails {
// Human-readable description for the template.
template_description: string;
// OTP device ID.
// This parameter is optional.
otp_id?: string;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface UsingTemplateDetails {
// Summary of the template
summary?: string;
// The amount entered by the customer.
amount?: AmountString;
}
interface WebhookAddDetails {
// Webhook ID to use.
webhook_id: string;
// The event of the webhook: why the webhook is used.
event_type: string;
// URL of the webhook where the customer will be redirected.
url: string;
// Method used by the webhook
http_method: string;
// Header template of the webhook
header_template?: string;
// Body template by the webhook
body_template?: string;
}
interface WebhookPatchDetails {
// The event of the webhook: why the webhook is used.
event_type: string;
// URL of the webhook where the customer will be redirected.
url: string;
// Method used by the webhook
http_method: string;
// Header template of the webhook
header_template?: string;
// Body template by the webhook
body_template?: string;
}
interface WebhookSummaryResponse {
// Return webhooks that are present in our backend.
webhooks: WebhookEntry[];
}
interface WebhookEntry {
// Webhook identifier, as found in the webhook.
webhook_id: string;
// The event of the webhook: why the webhook is used.
event_type: string;
}
interface WebhookDetails {
// The event of the webhook: why the webhook is used.
event_type: string;
// URL of the webhook where the customer will be redirected.
url: string;
// Method used by the webhook
http_method: string;
// Header template of the webhook
header_template?: string;
// Body template by the webhook
body_template?: string;
}
interface ContractTerms {
// Human-readable description of the whole purchase.
summary: string;
// Map from IETF BCP 47 language tags to localized summaries.
summary_i18n?: { [lang_tag: string]: string };
// Unique, free-form identifier for the proposal.
// Must be unique within a merchant instance.
// For merchants that do not store proposals in their DB
// before the customer paid for them, the order_id can be used
// by the frontend to restore a proposal from the information
// encoded in it (such as a short product identifier and timestamp).
order_id: string;
// Total price for the transaction.
// The exchange will subtract deposit fees from that amount
// before transferring it to the merchant.
amount: AmountString;
// URL where the same contract could be ordered again (if
// available). Returned also at the public order endpoint
// for people other than the actual buyer (hence public,
// in case order IDs are guessable).
public_reorder_url?: string;
// URL that will show that the order was successful after
// it has been paid for. Optional. When POSTing to the
// merchant, the placeholder "${ORDER_ID}" will be
// replaced with the actual order ID (useful if the
// order ID is generated server-side and needs to be
// in the URL).
// Note that this placeholder can only be used once.
// Either fulfillment_url or fulfillment_message must be specified.
fulfillment_url?: string;
// Message shown to the customer after paying for the order.
// Either fulfillment_url or fulfillment_message must be specified.
fulfillment_message?: string;
// Map from IETF BCP 47 language tags to localized fulfillment
// messages.
fulfillment_message_i18n?: { [lang_tag: string]: string };
// Maximum total deposit fee accepted by the merchant for this contract.
// Overrides defaults of the merchant instance.
max_fee: AmountString;
// List of products that are part of the purchase (see Product).
products: Product[];
// Time when this contract was generated.
timestamp: Timestamp;
// After this deadline has passed, no refunds will be accepted.
refund_deadline: Timestamp;
// After this deadline, the merchant won't accept payments for the contract.
pay_deadline: Timestamp;
// Transfer deadline for the exchange. Must be in the
// deposit permissions of coins used to pay for this order.
wire_transfer_deadline: Timestamp;
// Merchant's public key used to sign this proposal; this information
// is typically added by the backend. Note that this can be an ephemeral key.
merchant_pub: EddsaPublicKey;
// Base URL of the (public!) merchant backend API.
// Must be an absolute URL that ends with a slash.
merchant_base_url: string;
// More info about the merchant, see below.
merchant: Merchant;
// The hash of the merchant instance's wire details.
h_wire: HashCode;
// Wire transfer method identifier for the wire method associated with h_wire.
// The wallet may only select exchanges via a matching auditor if the
// exchange also supports this wire method.
// The wire transfer fees must be added based on this wire transfer method.
wire_method: string;
// Exchanges that the merchant accepts even if it does not accept any auditors that audit them.
exchanges: Exchange[];
// Delivery location for (all!) products.
delivery_location?: Location;
// Time indicating when the order should be delivered.
// May be overwritten by individual products.
delivery_date?: Timestamp;
// Nonce generated by the wallet and echoed by the merchant
// in this field when the proposal is generated.
nonce: string;
// Specifies for how long the wallet should try to get an
// automatic refund for the purchase. If this field is
// present, the wallet should wait for a few seconds after
// the purchase and then automatically attempt to obtain
// a refund. The wallet should probe until "delay"
// after the payment was successful (i.e. via long polling
// or via explicit requests with exponential back-off).
//
// In particular, if the wallet is offline
// at that time, it MUST repeat the request until it gets
// one response from the merchant after the delay has expired.
// If the refund is granted, the wallet MUST automatically
// recover the payment. This is used in case a merchant
// knows that it might be unable to satisfy the contract and
// desires for the wallet to attempt to get the refund without any
// customer interaction. Note that it is NOT an error if the
// merchant does not grant a refund.
auto_refund?: RelativeTime;
// Extra data that is only interpreted by the merchant frontend.
// Useful when the merchant needs to store extra information on a
// contract without storing it separately in their database.
extra?: any;
}
interface Product {
// Merchant-internal identifier for the product.
product_id?: string;
// Human-readable product description.
description: string;
// Map from IETF BCP 47 language tags to localized descriptions.
description_i18n?: { [lang_tag: string]: string };
// The number of units of the product to deliver to the customer.
quantity?: Integer;
// Unit in which the product is measured (liters, kilograms, packages, etc.).
unit?: string;
// The price of the product; this is the total price for quantity times unit of this product.
price?: AmountString;
// An optional base64-encoded product image.
image?: ImageDataUrl;
// A list of taxes paid by the merchant for this product. Can be empty.
taxes?: Tax[];
// Time indicating when this product should be delivered.
delivery_date?: Timestamp;
}
interface Tax {
// The name of the tax.
name: string;
// Amount paid in tax.
tax: AmountString;
}
interface Merchant {
// The merchant's legal name of business.
name: string;
// Label for a location with the business address of the merchant.
email?: string;
// Label for a location with the business address of the merchant.
website?: string;
// An optional base64-encoded product image.
logo?: ImageDataUrl;
// Label for a location with the business address of the merchant.
address?: Location;
// Label for a location that denotes the jurisdiction for disputes.
// Some of the typical fields for a location (such as a street address) may be absent.
jurisdiction?: Location;
}
// Delivery location, loosely modeled as a subset of
// ISO20022's PostalAddress25.
interface Location {
// Nation with its own government.
country?: string;
// Identifies a subdivision of a country such as state, region, county.
country_subdivision?: string;
// Identifies a subdivision within a country sub-division.
district?: string;
// Name of a built-up area, with defined boundaries, and a local government.
town?: string;
// Specific location name within the town.
town_location?: string;
// Identifier consisting of a group of letters and/or numbers that
// is added to a postal address to assist the sorting of mail.
post_code?: string;
// Name of a street or thoroughfare.
street?: string;
// Name of the building or house.
building_name?: string;
// Number that identifies the position of a building on a street.
building_number?: string;
// Free-form address lines, should not exceed 7 elements.
address_lines?: string[];
}
interface Auditor {
// Official name.
name: string;
// Auditor's public key.
auditor_pub: EddsaPublicKey;
// Base URL of the auditor.
url: string;
}
interface Exchange {
// The exchange's base URL.
url: string;
// How much would the merchant like to use this exchange.
// The wallet should use a suitable exchange with high
// priority. The following priority values are used, but
// it should be noted that they are NOT in any way normative.
//
// 0: likely it will not work (recently seen with account
// restriction that would be bad for this merchant)
// 512: merchant does not know, might be down (merchant
// did not yet get /wire response).
// 1024: good choice (recently confirmed working)
priority: Integer;
// Master public key of the exchange.
master_pub: EddsaPublicKey;
}
}
|