-
Notifications
You must be signed in to change notification settings - Fork 53
/
treetracker-wallet-api.yaml
2083 lines (2081 loc) · 68.9 KB
/
treetracker-wallet-api.yaml
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
openapi: 3.0.0
info:
title: Treetracker Wallet API
version: '1.31.2'
description: 'The Wallet API of Greenstand for managing impact wallets and tokens.'
contact:
name: Greenstand Support
email: admin@greenstand.com
license:
name: AGPL 3.0
url: 'https://www.gnu.org/licenses/agpl-3.0.en.html'
servers:
- url: https://{environment}-k8s.treetracker.org/wallet/v2
variables:
environment:
default: dev
enum:
- dev # Development server
- test # Test server
- prod # Production server
paths:
'/auth':
post:
tags:
- Authentication
operationId: post-auth
summary: Authenticate account
description: 'Authenticate the client using wallet name or id and password, and respond with a bearer token'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
requestBody:
description: 'Authentication request body'
content:
application/json:
schema:
$ref: '#/components/schemas/authRequest'
required: true
responses:
'200':
description: 'Successful authentication response'
content:
application/json:
schema:
$ref: '#/components/schemas/bearerToken'
'401':
description: 'Incorrect password for wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 401
message: 'Invalid Credentials'
'404':
description: 'No wallet found with provided wallet name or id'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Could not find entity by wallet name: bad_wallet'
'415':
$ref: '#/components/responses/UnsupportedMediaTypeError'
'422':
description: 'Missing request parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"wallet" is not allowed to be empty'
deprecated: false
'/tokens':
get:
tags:
- Token details
operationId: get-tokens
summary: Get a list of tokens in the current wallet or managed wallets.
description: 'Get a list of for tokens in the current wallet or managed wallets, matching certain parameters'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: limit
in: query
description: Number of items to return
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 1
maximum: 2000
example: 100
default: 2000
- name: offset
in: query
description: 'Where does the list offset, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 0
example: 1
default: 0
- name: wallet
description: 'Wallet name can be specified if the authenticated wallet manages other wallets. The default is to return tokens matching the authenticated wallet.'
in: query
schema:
type: string
example: wallet2
responses:
'200':
description: 'Returns list of tokens matching the input parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/tokens'
'401':
$ref: '#/components/responses/UnauthorizedError'
'422':
$ref: '#/components/responses/InvalidQueryParametersLimit'
deprecated: false
'/tokens/{token_uuid}':
get:
tags:
- Token details
operationId: get-tokens-tokenId
summary: Get details for one token
description: 'Get details for one token in the current wallet or managed wallets, matching certain parameters'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: token_uuid
description: 'ID of specific token to retrieve'
in: path
required: true
schema:
type: string
format: uuid
example: 496ffa8e-2fa2-488c-98e1-acf9b57c230b
responses:
'200':
description: 'Returns token matching the input parameter'
content:
application/json:
schema:
$ref: '#/components/schemas/tokenItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: 'No token found matching token_uuid'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Can not find token by id: a5fee1ec-31dd-4150-aae1-dfe423ee9fc7'
'422':
description: 'Missing or invalid query or request parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"value" must be a valid GUID'
deprecated: false
'/tokens/{token_uuid}/transactions':
get:
tags:
- Token details
operationId: get-tokens-tokenId-transactions
summary: Get transaction history for a particular token
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: token_uuid
in: path
description: 'ID of specific token to retrieve'
required: true
explode: true
schema:
type: string
example: e3cd6587-ff01-419b-b2c9-44ceed4dc749
- name: limit
in: query
description: Number of items to return
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 1
maximum: 2000
default: 1000
example: 100
- name: offset
in: query
description: 'Where does the list offset, 0 means offset from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 0
example: 0
default: 0
responses:
'200':
description: 'Return list of transactions associated with the token'
content:
application/json:
schema:
$ref: '#/components/schemas/historyResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: 'No token found matching token_uuid'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Can not find token by id:d15f40b4-ed8b-457a-8c85-97beb8862682'
'422':
description: 'Missing or invalid query or request parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"value" must be a valid GUID'
deprecated: false
'/wallets':
get:
tags:
- Managed wallets
operationId: get-wallets
summary: 'Get all wallets managed by the logged in account. This endpoint is also used to get the total number of tokens in a given wallet.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: limit
in: query
description: 'Number of items to return'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 1
maximum: 2000
example: 100
default: 1000
- name: offset
in: query
description: 'Where does the list offset, 0 means offset from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 0
example: 1
default: 0
- name: name
in: query
description: 'Filter wallets by name'
required: false
style: form
explode: true
schema:
type: string
example: walletA
- name: sort_by
in: query
description: 'Sort result by field'
required: false
style: form
explode: true
schema:
type: string
example: created_at
default: created_at
- name: order
in: query
description: 'Order result in ascending or descending order'
required: false
style: form
explode: true
schema:
type: string
enum:
- asc
- desc
example: desc
default: desc
- name: created_at_start_date
in: query
description: 'Wallets created after this date'
required: false
style: form
explode: true
schema:
type: string
format: date
example: 2023-09-12
- name: created_at_end_date
in: query
description: 'Wallets created before this date'
required: false
style: form
explode: true
schema:
type: string
format: date
example: 2023-09-20
responses:
'200':
description: 'Returns list of managed wallets'
content:
application/json:
schema:
$ref: '#/components/schemas/walletsResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'422':
$ref: '#/components/responses/InvalidQueryParametersLimit'
deprecated: false
post:
tags:
- Managed wallets
operationId: post-wallets
summary: 'Create a new managed wallet'
description: 'Create a new managed wallet. Requires the manage_account role.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
requestBody:
description: 'Wallet creation request'
content:
application/json:
schema:
$ref: '#/components/schemas/accountRequest'
required: true
responses:
'201':
description: 'A new wallet was created'
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
example: 784311ee-156e-41c7-a85f-b51572cbcf91
wallet:
type: string
example: new_wallet
'401':
$ref: '#/components/responses/UnauthorizedError'
'409':
description: 'The wallet to be created already exists'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 409
message: 'The wallet "walletX" already exists'
'415':
$ref: '#/components/responses/UnsupportedMediaTypeError'
'422':
description: 'Missing or invalid parameters in request body'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"wallet" is required'
deprecated: false
'/wallets/{wallet_uuid}':
get:
tags:
- Managed wallets
operationId: get-wallets-walletId
summary: Get details for one wallet, including number of tokens
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: wallet_uuid
description: 'ID of wallet'
in: path
required: true
schema:
type: string
example: 496ffa8e-2fa2-488c-98e1-acf9b57c230b
responses:
'200':
description: 'Return wallet matching wallet_uuid'
content:
application/json:
schema:
$ref: '#/components/schemas/walletItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/walletNotFound'
'422':
description: 'Missing or invalid query parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"wallet_id" must be a valid GUID'
deprecated: false
'/wallets/{wallet_uuid}/trust_relationships':
get:
tags:
- Managed wallets
operationId: get-wallets-walletId-trustRelationships
summary: Get list of trust relationships for the specified wallet
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: wallet_uuid
description: 'ID of wallet'
in: path
required: true
schema:
type: string
format: uuid
example: 496ffa8e-2fa2-488c-98e1-acf9b57c230b
- name: state
in: query
description: 'Trust state'
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/trustStateType'
- name: type
in: query
description: 'Trust type'
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/trustType'
- name: request_type
in: query
description: 'Trust request type'
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/trustRequestType'
responses:
'200':
description: 'Return list of trust relationships for the wallet matching wallet_uuid'
content:
application/json:
schema:
$ref: '#/components/schemas/trustRelationshipsResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/walletNotFound'
'422':
description: 'Invalid query parameter'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"wallet_id" must be a valid GUID'
deprecated: false
/wallets/batch-create-wallet:
post:
tags:
- Managed wallets
operationId: post-wallets-batchCreate
deprecated: false
summary: 'Batch Create Wallets'
description: 'Create multiple wallets using a CSV file.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeMultipartHeader'
requestBody:
description: 'Wallet batch create request'
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/batchCreateRequest'
encoding:
csv:
contentType: text/csv
required: true
responses:
'200':
description: 'Batch create response'
content:
application/json:
schema:
$ref: '#/components/schemas/batchCreateResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'415':
$ref: '#/components/responses/MultipartMediaTypeError'
'422':
description: 'Missing or invalid parameters in request body'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"sender_wallet" is not allowed to be empty'
/wallets/batch-transfer:
post:
tags:
- Managed wallets
operationId: post-wallets-batchTransfer
summary: 'Batch transfer'
deprecated: false
description: 'Create multiple transfers using a CSV file.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeMultipartHeader'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/batchTransferRequest'
encoding:
csv:
contentType: text/csv
responses:
'200':
description: 'Successful batch transfer response'
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: 'Batch transfer successful'
'401':
$ref: '#/components/responses/UnauthorizedError'
'415':
$ref: '#/components/responses/MultipartMediaTypeError'
'422':
description: 'Missing or invalid parameters in request body'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"sender_wallet" is required'
'/transfers':
post:
tags:
- Transfers
operationId: post-transfers
summary: 'Move, request, and send tokens between wallets'
description: 'Move, request, and send tokens between wallets (by name or id) as allowed by trust relationships. Transfer can be created/requested either using an explicit list of token ids or by specifying a bundle of tokens using tags and a count of tokens to attempt to transfer. The originator of the request (currently logged in wallet) is used by the server code to compute who the originating wallet is for this request, whether the request is a credit, debit, or managed transfer, and if appropriate trust relationships exist to automatically execute or if it must be stored as a request until approval. A claim boolean is entered to specify if the tokens are transferable. Claimed tokens cannot participate in further transfers after they are received.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
requestBody:
description: 'Request body for creating a transfer'
content:
application/json:
schema:
$ref: '#/components/schemas/transferRequest'
required: true
responses:
'201':
description: 'The transfer was completely processed'
content:
application/json:
schema:
$ref: '#/components/schemas/transferItem'
'202':
$ref: '#/components/responses/transferPendingResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: 'Lacking permission to transfer the tokens'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 403
message: 'The token 89b071ee-c49d-420c-b43d-0d3dfe323962 does not belong to the sender wallet'
'404':
description: 'No wallet or token found matching the corresponding parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Could not find entity by wallet name: testwalletxyz'
'409':
description: 'The transfer cannot be processed due to some conflict'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 409
message: 'The token 89b071ee-c49d-420c-b43d-0d3dfe32396 is claimed, cannot be transfered'
'415':
$ref: '#/components/responses/UnsupportedMediaTypeError'
'422':
description: 'Missing or invalid request parameters in body'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 422
message: '"bundle" is required'
get:
tags:
- Transfers
operationId: get-transfers
summary: 'Get requested, pending, completed, cancelled, and failed transfers'
description: 'Get requested, pending, completed, cancelled and failed transfers for wallets (by name or id). The authenticated wallet is either the source, destination, or originating wallet entity.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- in: query
name: state
schema:
$ref: '#/components/schemas/transferState'
required: false
description: 'requested, pending, completed, cancelled, failed'
- in: query
name: wallet
schema:
$ref: '#/components/schemas/walletNameOrId'
required: false
description: 'filter transfers matches the source, destination, or originating wallet (by name or id) of a transfer'
- name: before
in: query
description: 'Get transfers that fall before this date'
required: false
style: form
explode: true
schema:
type: string
format: date-time
example: 2023-08-10
- name: after
in: query
description: 'Get transfers that fall after this date'
required: false
style: form
explode: true
schema:
type: string
format: date-time
example: 2023-08-02
- name: limit
in: query
description: Number of items to return
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 1
maximum: 2000
example: 100
default: 1000
- name: offset
in: query
description: 'Where does the list offset, 0 means offset from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 0
example: 1
default: 0
responses:
'200':
description: Return array of matching transfers
content:
application/json:
schema:
type: object
properties:
transfers:
type: array
items:
$ref: '#/components/schemas/transferItem'
query:
type: object
properties:
limit:
type: integer
example: 200
offset:
type: integer
example: 0
total:
type: integer
example: 1
'401':
$ref: '#/components/responses/UnauthorizedError'
'422':
$ref: '#/components/responses/InvalidQueryParametersLimit'
'/transfers/{transfer_id}':
get:
tags:
- Transfers
operationId: get-transfers-transferId
summary: 'Get information of a single transfer'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: transfer_id
in: path
description: 'The unique ID for the transfer'
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: 'Return the transfer matching the transfer_id'
content:
application/json:
schema:
$ref: '#/components/schemas/transferItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: 'No transfer found matching the transfer_id or the transfer is not associated with the logged in wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Transfer does not exist or it is not related to this wallet'
'422':
$ref: '#/components/responses/InvalidQueryParametersTransferId'
delete:
tags:
- Transfers
operationId: delete-transfers
summary: 'Cancel a pending or requested transfer that has not closed'
description: 'Cancel a pending (untrusted) or requested transfer. The executor can delete the pending/requested transfer before it is executed. Transfer is marked canceled by this command.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: transfer_id
in: path
description: 'The unique ID for the transfer'
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
$ref: '#/components/responses/transferCancelledResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: 'No transfer found matching the transfer_id or the transfer is not associated with the logged in wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Can not find transfer by id: 03537683-5356-42f4-97b2-95ba287a453b'
'409':
description: 'Transfer could not be cancelled due to some conflict'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 409
message: 'The transfer state is neither pending nor requested'
'/transfers/{transfer_id}/tokens':
get:
tags:
- Transfers
operationId: get-transfers-transferId-tokens
summary: 'Get all tokens linked to a single transfer'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- name: transfer_id
in: path
description: 'The unique ID for the transfer'
required: true
schema:
$ref: '#/components/schemas/uuid'
- name: limit
in: query
description: 'Number of items to return'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 1
maximum: 2000
default: 2000
example: 100
- name: offset
in: query
description: 'Where does the list offset, 0 means offset from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
minimum: 0
example: 0
default: 0
responses:
'200':
description: 'Returns list of tokens associated with the transfer'
content:
application/json:
schema:
type: object
properties:
tokens:
type: array
items:
$ref: '#/components/schemas/transferTokenItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: 'No transfer found matching the transfer_id or the transfer is not associated with the logged in wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Transfer does not exist or it is not related to this wallet'
'422':
$ref: '#/components/responses/InvalidQueryParametersTransferId'
'/transfers/{transfer_id}/accept':
post:
tags:
- Transfers
operationId: post-transfers-transferId-accept
summary: 'Accept a pending (untrusted) transfer'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: 'The unique ID for the transfer'
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
$ref: '#/components/responses/transferAcceptedResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: 'Lacking permission to accept the transfer'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 403
message: 'Current account has no permission to accept this transfer'
'404':
description: 'No transfer found matching the transfer_id or the transfer is not associated with the logged in wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Can not find transfer by id: df80b648-4fef-4ca6-b704-9e7e1c77d1ef'
'409':
description: 'Transfer could not be processed due to some conflict'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 409
message: 'Do not have enough tokens'
'415':
$ref: '#/components/responses/UnsupportedMediaTypeError'
'422':
$ref: '#/components/responses/InvalidQueryParametersTransferId'
'/transfers/{transfer_id}/decline':
post:
tags:
- Transfers
operationId: post-transfers-transferId-decline
summary: 'Decline a pending (untrusted) transfer'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: 'The unique ID for the transfer'
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
$ref: '#/components/responses/transferCancelledResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: 'Lacking permission to decline the transfer'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 403
message: 'Current account has no permission to decline this transfer'
'404':
description: 'No transfer found matching the transfer_id or the transfer is not associated with the logged in wallet'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 404
message: 'Can not find transfer by id: df80b648-4fef-4ca6-b704-9e7e1c77d1ef'
'409':
description: 'Transfer could not be processed due to some conflict'
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
example:
code: 409
message: 'The transfer state is neither pending nor requested'
'415':
$ref: '#/components/responses/UnsupportedMediaTypeError'
'422':
$ref: '#/components/responses/InvalidQueryParametersTransferId'
'/transfers/{transfer_id}/fulfill':
post:
tags:
- Transfers
operationId: post-transfers-transferId-fulfill
summary: 'Fulfill a requested transfer'
description: 'Post a list of tokens to fulfill the parameters of a transfer request that specifies tokens using a bundle. This allows the debited wallet to decide which tokens matching the bundle parameters to attach to the transfer. Application logic must check that each token matches the parameters of the request.'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: the id of the transfer record on the server
required: true
style: simple
schema:
$ref: '#/components/schemas/uuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/requestBundleFulfillBody'
responses:
'200':
$ref: '#/components/responses/transferAcceptedResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: 'Lacking permission to fulfill the transfer'
content:
application/json: