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
|
/*
This file is part of GNU Taler
(C) 2021-2023 Taler Systems S.A.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
/**
*
* @author Sebastian Javier Marchano (sebasjm)
*/
type HashCode = string;
type EddsaPublicKey = string;
type EddsaSignature = string;
type WireTransferIdentifierRawP = string;
type RelativeTime = Duration;
type ImageDataUrl = string;
export interface WithId {
id: string;
}
interface Timestamp {
// Milliseconds since epoch, or the special
// value "forever" to represent an event that will
// never happen.
t_s: number | "never";
}
interface Duration {
d_us: number | "forever";
}
interface WithId {
id: string;
}
type Amount = string;
type UUID = string;
type Integer = number;
export namespace ExchangeBackend {
interface WireResponse {
// Master public key of the exchange, must match the key returned in /keys.
master_public_key: EddsaPublicKey;
// Array of wire accounts operated by the exchange for
// incoming wire transfers.
accounts: WireAccount[];
// Object mapping names of wire methods (i.e. "sepa" or "x-taler-bank")
// to wire fees.
fees: { method: AggregateTransferFee };
}
interface WireAccount {
// payto:// URI identifying the account and wire method
payto_uri: string;
// Signature using the exchange's offline key
// with purpose TALER_SIGNATURE_MASTER_WIRE_DETAILS.
master_sig: EddsaSignature;
}
interface AggregateTransferFee {
// Per transfer wire transfer fee.
wire_fee: Amount;
// Per transfer closing fee.
closing_fee: Amount;
// What date (inclusive) does this fee go into effect?
// The different fees must cover the full time period in which
// any of the denomination keys are valid without overlap.
start_date: Timestamp;
// What date (exclusive) does this fee stop going into effect?
// The different fees must cover the full time period in which
// any of the denomination keys are valid without overlap.
end_date: Timestamp;
// Signature of TALER_MasterWireFeePS with
// purpose TALER_SIGNATURE_MASTER_WIRE_FEES.
sig: EddsaSignature;
}
}
export namespace MerchantBackend {
interface ErrorDetail {
// Numeric error code unique to the condition.
// The other arguments are specific to the error value reported here.
code: number;
// Human-readable description of the error, i.e. "missing parameter", "commitment violation", ...
// Should give a human-readable hint about the error's nature. Optional, may change without notice!
hint?: string;
// Optional detail about the specific input value that failed. May change without notice!
detail?: string;
// Name of the parameter that was bogus (if applicable).
parameter?: string;
// Path to the argument that was bogus (if applicable).
path?: string;
// Offset of the argument that was bogus (if applicable).
offset?: string;
// Index of the argument that was bogus (if applicable).
index?: string;
// Name of the object that was bogus (if applicable).
object?: string;
// Name of the currency than was problematic (if applicable).
currency?: string;
// Expected type (if applicable).
type_expected?: string;
// Type that was provided instead (if applicable).
type_actual?: string;
}
// Delivery location, loosely modeled as a subset of
// ISO20022's PostalAddress25.
interface Tax {
// the name of the tax
name: string;
// amount paid in tax
tax: Amount;
}
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;
// master public key of the exchange
master_pub: EddsaPublicKey;
}
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;
// The 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?: Amount;
// 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?: TalerProtocolTimestamp;
// Minimum age buyer must have (in years). Default is 0.
minimum_age?: Integer;
}
interface Merchant {
// label for a location with the business address of the merchant
address: Location;
// the merchant's legal name of business
name: string;
// 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;
}
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";
// Currency supported by this backend.
currency: string;
}
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[];
}
namespace Instances {
//POST /private/instances/$INSTANCE/auth
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 "external", 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;
}
//POST /private/instances
interface InstanceConfigurationMessage {
// The URI where the wallet will send coins. A merchant may have
// multiple accounts, thus this is an array. Note that by
// removing URIs from this list the respective account is set to
// inactive and thus unavailable for new contracts, but preserved
// in the database as existing offers and contracts may still refer
// to it.
payto_uris: string[];
// Name of the merchant instance to create (will become $INSTANCE).
id: string;
// Merchant name corresponding to this instance.
name: string;
email: string;
website: string;
// An optional base64-encoded logo image
logo: ImageDataUrl;
// "Authentication" header required to authorize management access the instance.
// Optional, if not given authentication will be disabled for
// this instance (hopefully authentication checks are still
// done by some reverse proxy).
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;
// Maximum wire fee this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_wire_fee: Amount;
// Default factor for wire fee amortization calculations.
// Can be overridden by the frontend on a per-order basis.
default_wire_fee_amortization: Integer;
// Maximum deposit fee (sum over all coins) this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
// 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;
}
// PATCH /private/instances/$INSTANCE
interface InstanceReconfigurationMessage {
// The URI where the wallet will send coins. A merchant may have
// multiple accounts, thus this is an array. Note that by
// removing URIs from this list
payto_uris: string[];
// Merchant name corresponding to this instance.
name: string;
// 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;
// Maximum wire fee this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_wire_fee: Amount;
// Default factor for wire fee amortization calculations.
// Can be overridden by the frontend on a per-order basis.
default_wire_fee_amortization: Integer;
// Maximum deposit fee (sum over all coins) this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
// 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;
}
// GET /private/instances
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;
deleted?: boolean;
// 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[];
}
//GET /private/instances/$INSTANCE/kyc
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).
kyc_url: string;
// Base URL of the exchange this is about.
exchange_url: string;
// Our bank wire account this is about.
payto_uri: string;
}
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;
}
//GET /private/instances/$INSTANCE
interface QueryInstancesResponse {
// The URI where the wallet will send coins. A merchant may have
// multiple accounts, thus this is an array.
accounts: MerchantAccount[];
// Merchant name corresponding to this instance.
name: string;
// 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;
// Maximum wire fee this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_wire_fee: Amount;
// Default factor for wire fee amortization calculations.
// Can be overridden by the frontend on a per-order basis.
default_wire_fee_amortization: Integer;
// Maximum deposit fee (sum over all coins) this instance is willing to pay.
// Can be overridden by the frontend on a per-order basis.
default_max_deposit_fee: Amount;
// 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: {
method: "external" | "token";
token?: string;
};
}
interface MerchantAccount {
// payto:// URI of the account.
payto_uri: string;
// Hash over the wire details (including over the salt)
h_wire: HashCode;
// salt used to compute h_wire
salt: HashCode;
// true if this account is active,
// false if it is historic.
active: boolean;
}
// DELETE /private/instances/$INSTANCE
}
namespace Products {
// POST /private/products
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: Amount;
// 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;
}
// PATCH /private/products/$PRODUCT_ID
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: Amount;
// 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;
}
// GET /private/products
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;
}
// GET /private/products/$PRODUCT_ID
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: Amount;
// 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). Default is 0.
minimum_age?: Integer;
}
// POST /private/products/$PRODUCT_ID/lock
interface LockRequest {
// UUID that identifies the frontend performing the lock
// It is suggested that clients use a timeflake for this,
// see https://github.com/anthonynsimon/timeflake
lock_uuid: UUID;
// How long does the frontend intend to hold the lock
duration: RelativeTime;
// How many units should be locked?
quantity: Integer;
}
// DELETE /private/products/$PRODUCT_ID
}
namespace Orders {
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: Amount;
// 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_ec: 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_hc: number;
// Total amount that was refunded, 0 if refunded is false.
refund_amount: Amount;
// 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";
// 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: Amount;
// URI that the wallet must process to complete the payment.
taler_pay_uri: 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;
// 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;
// When was the refund approved.
timestamp: Timestamp;
// Set to true if a refund is still available for the wallet for this payment.
pending: boolean;
// Total amount that was refunded (minus a refund fee).
amount: Amount;
}
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: Amount;
// 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_ec: number;
// HTTP status code received from the exchange.
exchange_hc: number;
// Public key of the coin for which we got the exchange error.
coin_pub: CoinPublicKey;
}
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: Amount;
// 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;
}
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
// manage_inventory is set. Used in case a frontend
// reserved quantities of the individual products while
// the shopping card 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?: UUID[];
// 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;
}
type Order = MinimalOrderDetail | ContractTerms;
interface MinimalOrderDetail {
// Amount to be paid by the customer
amount: Amount;
// Short summary of the order
summary: 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).
fulfillment_url?: 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_quanitity)
available_quantity: Integer;
// When do we expect the product to be again in stock?
// Optional, not given if unknown.
restock_expected?: Timestamp;
}
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: Amount;
// 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;
}
}
namespace Tips {
// GET /private/reserves
interface TippingReserveStatus {
// 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: Amount;
// Initial amount as per exchange, 0 if exchange did
// not confirm reserve creation yet.
exchange_initial_amount: Amount;
// Amount picked up so far.
pickup_amount: Amount;
// Amount approved for tips that exceeds the pickup_amount.
committed_amount: Amount;
// Is this reserve active (false if it was deleted but not purged)
active: boolean;
}
interface ReserveCreateRequest {
// Amount that the merchant promises to put into the reserve
initial_balance: Amount;
// Exchange the merchant intends to use for tipping
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 account of the exchange where to transfer the funds
payto_uri: string;
}
interface TipCreateRequest {
// Amount that the customer should be tipped
amount: Amount;
// Justification for giving the tip
justification: string;
// URL that the user should be directed to after tipping,
// will be included in the tip_token.
next_url: string;
}
interface TipCreateConfirmation {
// Unique tip identifier for the tip that was created.
tip_id: HashCode;
// taler://tip URI for the tip
taler_tip_uri: string;
// URL that will directly trigger processing
// the tip when the browser is redirected to it
tip_status_url: string;
// when does the tip expire
tip_expiration: Timestamp;
}
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: Amount;
// Initial amount as per exchange, 0 if exchange did
// not confirm reserve creation yet.
exchange_initial_amount: Amount;
// Amount picked up so far.
pickup_amount: Amount;
// Amount approved for tips that exceeds the pickup_amount.
committed_amount: Amount;
// Array of all tips created by this reserves (possibly empty!).
// Only present if asked for explicitly.
tips?: TipStatusEntry[];
// Is this reserve active (false if it was deleted but not purged)?
active: boolean;
// URI to use to fill the reserve, can be NULL
// if the reserve is inactive or was already filled
payto_uri: string;
// URL of the exchange hosting the reserve,
// NULL if the reserve is inactive
exchange_url: string;
}
interface TipStatusEntry {
// Unique identifier for the tip.
tip_id: HashCode;
// Total amount of the tip that can be withdrawn.
total_amount: Amount;
// Human-readable reason for why the tip was granted.
reason: string;
}
interface TipDetails {
// Amount that we authorized for this tip.
total_authorized: Amount;
// Amount that was picked up by the user already.
total_picked_up: Amount;
// Human-readable reason given when authorizing the tip.
reason: string;
// Timestamp indicating when the tip is set to expire (may be in the past).
expiration: Timestamp;
// Reserve public key from which the tip 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: Amount;
}
}
namespace Transfers {
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: Amount;
// raw wire transfer identifier identifying the wire transfer (a base32-encoded value)
wtid: string;
// target account that received the wire transfer
payto_uri: string;
// base URL of the exchange that made the wire transfer
exchange_url: string;
// Serial number identifying the transfer in the merchant backend.
// Used for filgering 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 TransferInformation {
// how much was wired to the merchant (minus fees)
credit_amount: Amount;
// raw wire transfer identifier identifying the wire transfer (a base32-encoded value)
wtid: WireTransferIdentifierRawP;
// target account that received the wire transfer
payto_uri: string;
// base URL of the exchange that made the wire transfer
exchange_url: string;
}
interface MerchantTrackTransferResponse {
// Total amount transferred
total: Amount;
// Applicable wire fee that was charged
wire_fee: Amount;
// Time of the execution of the wire transfer by the exchange, according to the exchange
execution_time: Timestamp;
// details about the deposits
deposits_sums: MerchantTrackTransferDetail[];
}
interface MerchantTrackTransferDetail {
// Business activity associated with the wire transferred amount
// deposit_value.
order_id: string;
// The total amount the exchange paid back for order_id.
deposit_value: Amount;
// applicable fees for the deposit
deposit_fee: Amount;
}
type ExchangeConflictDetails =
| WireFeeConflictDetails
| TrackTransferConflictDetails;
// Note: this is not the full 'proof' of missbehavior, as
// the bogus message from the exchange with a signature
// over the 'different' wire fee is missing.
//
// This information is NOT provided by the current implementation,
// because this would be quite expensive to generate and is
// hardly needed _here_. Once we add automated reports for
// the Taler auditor, we need to generate this data anyway
// and should probably return it here as well.
interface WireFeeConflictDetails {
// Numerical error code:
code: "TALER_EC_MERCHANT_PRIVATE_POST_TRANSFERS_BAD_WIRE_FEE";
// Text describing the issue for humans.
hint: string;
// Wire fee (wrongly) charged by the exchange, breaking the
// contract affirmed by the exchange_sig.
wire_fee: Amount;
// Timestamp of the wire transfer
execution_time: Timestamp;
// The expected wire fee (as signed by the exchange)
expected_wire_fee: Amount;
// Expected closing fee (needed to verify signature)
expected_closing_fee: Amount;
// Start date of the expected fee structure
start_date: Timestamp;
// End date of the expected fee structure
end_date: Timestamp;
// Signature of the exchange affirming the expected fee structure
master_sig: EddsaSignature;
// Master public key of the exchange
master_pub: EddsaPublicKey;
}
interface TrackTransferConflictDetails {
// Numerical error code
code: "TALER_EC_MERCHANT_PRIVATE_POST_TRANSFERS_CONFLICTING_REPORTS";
// Text describing the issue for humans.
hint: string;
// Offset in the exchange_transfer where the
// exchange's response fails to match the exchange_deposit_proof.
conflict_offset: number;
// The response from the exchange which tells us when the
// coin was returned to us, except that it does not match
// the expected value of the coin.
//
// This field is NOT provided by the current implementation,
// because this would be quite expensive to generate and is
// hardly needed _here_. Once we add automated reports for
// the Taler auditor, we need to generate this data anyway
// and should probably return it here as well.
// exchange_transfer?: TrackTransferResponse;
// Public key of the exchange used to sign the response to
// our deposit request.
deposit_exchange_pub: EddsaPublicKey;
// Signature of the exchange signing the (conflicting) response.
// Signs over a struct TALER_DepositConfirmationPS.
deposit_exchange_sig: EddsaSignature;
// Hash of the merchant's bank account the wire transfer went to
h_wire: HashCode;
// Hash of the contract terms with the conflicting deposit.
h_contract_terms: HashCode;
// At what time the exchange received the deposit. Needed
// to verify the \exchange_sig\.
deposit_timestamp: Timestamp;
// At what time the refund possibility expired (needed to verify exchange_sig).
refund_deadline: Timestamp;
// Public key of the coin for which we have conflicting information.
coin_pub: EddsaPublicKey;
// Amount the exchange counted the coin for in the transfer.
amount_with_fee: Amount;
// Expected value of the coin.
coin_value: Amount;
// Expected deposit fee of the coin.
coin_fee: Amount;
// Expected deposit fee of the coin.
deposit_fee: Amount;
}
// interface TrackTransferProof {
// // signature from the exchange made with purpose
// // TALER_SIGNATURE_EXCHANGE_CONFIRM_WIRE_DEPOSIT
// 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. Again given
// // explicitly as the client might otherwise be confused by clock skew as to
// // which signing key was used.
// exchange_pub: EddsaSignature;
// // hash of the wire details (identical for all deposits)
// // Needed to check the exchange_sig
// h_wire: HashCode;
// }
}
namespace Template {
interface TemplateAddDetails {
// Template ID to use.
template_id: string;
// Human-readable description for the template.
template_description: string;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface TemplateContractDetails {
// Human-readable summary for the template.
summary?: string;
// The price is imposed by the merchant and cannot be changed by the customer.
// This parameter is optional.
amount?: Amount;
// 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;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface TemplateSummaryResponse {
// List of templates that are present in our backend.
templates: 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;
// A base64-encoded image selected by the merchant.
// This parameter is optional.
// We are not sure about it.
image?: ImageDataUrl;
// Additional information in a separate template.
template_contract: TemplateContractDetails;
}
interface UsingTemplateDetails {
// Subject of the template
summary?: string;
// The amount entered by the customer.
amount?: Amount;
}
interface UsingTemplateResponse {
// After enter the request. The user will be pay with a taler URL.
order_id: string,
token: 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: Amount;
// The URL for this purchase. Every time is is visited, the merchant
// will send back to the customer the same proposal. Clearly, this URL
// can be bookmarked and shared by users.
fulfillment_url?: string;
// Maximum total deposit fee accepted by the merchant for this contract
max_fee: Amount;
// Maximum wire fee accepted by the merchant (customer share to be
// divided by the 'wire_fee_amortization' factor, and further reduced
// if deposit fees are below 'max_fee'). Default if missing is zero.
max_wire_fee: Amount;
// Over how many customer transactions does the merchant expect to
// amortize wire fees on average? If the exchange's wire fee is
// above 'max_wire_fee', the difference is divided by this number
// to compute the expected customer's contribution to the wire fee.
// The customer's contribution may further be reduced by the difference
// between the 'max_fee' and the sum of the actual deposit fees.
// Optional, default value if missing is 1. 0 and negative values are
// invalid and also interpreted as 1.
wire_fee_amortization: number;
// List of products that are part of the purchase (see Product).
products: Product[];
// Time when this contract was generated
timestamp: TalerProtocolTimestamp;
// After this deadline has passed, no refunds will be accepted.
refund_deadline: TalerProtocolTimestamp;
// After this deadline, the merchant won't accept payments for the contact
pay_deadline: TalerProtocolTimestamp;
// Transfer deadline for the exchange. Must be in the
// deposit permissions of coins used to pay for this order.
wire_transfer_deadline: TalerProtocolTimestamp;
// 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;
// Any exchanges audited by these auditors are accepted by the merchant.
auditors: Auditor[];
// 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?: TalerProtocolTimestamp;
// 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;
// Minimum age buyer must have (in years). Default is 0.
minimum_age?: Integer;
}
}
|