-
Notifications
You must be signed in to change notification settings - Fork 52
/
treetracker-wallet-api-v1-10.yaml
1180 lines (1180 loc) · 36.3 KB
/
treetracker-wallet-api-v1-10.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 token api v1.10.3
contact: {}
version: '1.10.3'
paths:
/auth:
post:
tags:
- Authentication
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: ''
content:
application/json:
schema:
$ref: '#/components/schemas/authrequest'
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/bearerToken'
deprecated: false
/tokens:
get:
tags:
- Token details
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'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
example: 1
default: 0
- name: wallet
description: Wallet id or name can be specified if the authenticated wallet manages other wallets. The default is to return tokens matching the authenticated wallet
in: query
required: false
schema:
$ref: '#/components/schemas/walletNameOrId'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/tokens'
'401':
$ref: '#/components/responses/UnauthorizedError'
deprecated: false
'/tokens/{token_uuid}':
get:
tags:
- Token details
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'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: token_uuid
description: ''
in: path
required: true
schema:
type: string
example: 496ffa8e-2fa2-488c-98e1-acf9b57c230b
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/tokenItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
deprecated: false
/wallets:
get:
tags:
- Managed 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. Each wallet also returns all trust relationships for that wallet that have not been deleted
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
default: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
example: 1
default: 0
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/walletsResponse'
deprecated: false
post:
tags:
- Managed 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: ''
content:
application/json:
schema:
$ref: '#/components/schemas/accountrequest'
example:
wallet: sprinter_van_2004
required: true
responses:
'201':
description: A new wallet was created
'401':
$ref: '#/components/responses/UnauthorizedError'
deprecated: false
/transfers:
post:
tags:
- 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, debut, or managed transfer, and if appropriate trust relationships exist to automatically execute or if it must be stored as a request until approval'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/transferrequest'
examples:
ExplicitTokens:
value:
tokens:
- e1b278e8-f025-44b7-9dd8-36ffb2d58f7e
- e533653e-2dbf-48cd-940a-a87e5a393158
sender_wallet: zaven4
receiver_wallet: dadiorchen
Bundle:
value:
bundle:
bundle_size: 100
matching_all_tags:
- pine
- Tanzania
required: true
responses:
'201':
description: The transfer was completely processed
content:
application/json:
schema:
$ref: '#/components/schemas/sendRequestProcessedResponse'
'202':
description: 'The transfer could not be completely processed because a trust relationship does not exist allowing for automated processing. If a the source wallet is controlled by the authenitcated user, a transfer in the pending state has been created. If the source wallet is not controlled but the authenticated user, but the destination wallet is, then a transfer in the requested state has been created'
content:
application/json:
schema:
$ref: '#/components/schemas/sendRequestPendingResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
get:
tags:
- 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'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- in: query
name: state
schema:
type: string
example: pending
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: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
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'
limit:
type: integer
offset:
type: integer
total:
type: integer
'401':
$ref: '#/components/responses/UnauthorizedError'
'/tokens/{token_uuid}/transactions':
get:
tags:
- Token details
summary: Get transaction history for a particular token
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: token_uuid
in: path
description: ''
required: true
explode: true
schema:
type: string
example: e3cd6587-ff01-419b-b2c9-44ceed4dc749
- name: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
example: 1
default: 0
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/historyResponse'
deprecated: false
'/transfers/{transfer_id}':
get:
tags:
- Transfers
summary: Get information of a single transfer
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: ''
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/transferItem'
'401':
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- 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'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: ''
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: Transfer was marked canceled
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
description: Authenticated wallet does not have access to this transfer
'404':
description: No transfer record with that id
'406':
description: Transfer with this id is not in requested or pending state
'/transfers/{transfer_id}/accept':
post:
tags:
- Transfers
summary: Accept a pending (untrusted) transfer
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: ''
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'/transfers/{transfer_id}/decline':
post:
tags:
- Transfers
summary: Decline a pending (untrusted) transfer
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: ''
required: true
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'/transfers/{transfer_id}/fulfill':
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
post:
tags:
- Transfers
summary: Fullfill 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:
- 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':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'/transfers/{transfer_id}/tokens':
get:
tags:
- Transfers
summary: Get all tokens linked to a single transfer
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: transfer_id
in: path
description: ''
required: true
schema:
$ref: '#/components/schemas/uuid'
- name: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
example: 1
default: 0
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
/trust_relationships:
get:
tags:
- Trust relationships
summary: 'Get a list of existing, requested, and pending trust relationships'
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: limit
in: query
description: Number of items to return
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 100
- name: offset
in: query
description: 'Where does the list start, 0 means start from the beginning of the list'
required: false
style: form
explode: true
schema:
type: integer
format: int32
example: 1
default: 0
- name: state
in: query
description: Filter by state of the trust relationship
required: false
style: form
schema:
type: string
examples:
Trusted:
value: trusted
description: Active trust relationship
Requested:
value: requested
description: Trust relationship pending approval
CancelledByOriginator:
value: cancelled_by_originator
description: Trust relationship was cancelled by the originator
CancelledByActor:
value: cancelled_by_actor
description: Trust relationship was cancelled by the actor
CancelledByTarget:
value: cancelled_by_target
description: Trust relationship was cancelled by the target
- name: type
in: query
description: Type of trust relationship
required: false
style: form
schema:
type: string
examples:
Send:
value: send
description: Allow actor to send to target
Deduct:
value: deduct
description: Allow actor to deduct from wallet
Manage:
value: manage
description: Allow actor to move funds from target wallet to any other wallet they control
- name: request_type
in: query
description: Type of trust relationship
required: false
style: form
schema:
type: string
examples:
Send:
value: send
description: Request to allow actor to send to target
Receive:
value: receive
description: Request a send priviledge to a wallet controlled by the originator on behalf of another sending wallet (opposite direction of send trust request)
Deduct:
value: deduct
description: Request to allow actor to deduct from wallet
Release:
value: release
description: Request a deduct priviledge from a wallet controlled by the originator on behalf of another deducting wallet (opposite direction of deduct trust request)
Manage:
value: manage
description: Request to allow actor to move funds from target wallet to any other wallet they control
Yield:
value: manage
description: Request to give manage privilege on a wallet controlled by the originator to another wallet (opposite direction of manage trust request)
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/trustRelationshipsResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
tags:
- Trust relationships
summary: Request a new trust relationship from another wallet
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/trustRequest'
responses:
'202':
description: Accepted but waiting for approval
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'/trust_relationships/{trust_relationship_id}':
delete:
tags:
- Trust relationships
summary: Remove a trust relationship linked to the autheticated wallet
description: Remove a trust relationship linked to the autheticated wallet. This could be either the actor wallet or the target wallet
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: trust_relationship_id
in: path
description: the id of the entity trust record on the server
required: true
style: simple
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'/trust_relationships/{trust_relationship_id}/accept':
post:
tags:
- Trust relationships
summary: Accept a trust relationship
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: trust_relationship_id
in: path
description: the id of the entity trust record on the server
required: true
style: simple
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'/trust_relationships/{trust_relationship_id}/decline':
post:
tags:
- Trust relationships
summary: Decline a trust relationship
parameters:
- $ref: '#/components/parameters/treetrackerApiKeyParam'
- $ref: '#/components/parameters/contentTypeJsonHeader'
- name: trust_relationship_id
in: path
description: the id of the entity trust record on the server
required: true
style: simple
schema:
$ref: '#/components/schemas/uuid'
responses:
'200':
description: ''
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
components:
parameters:
treetrackerApiKeyParam:
name: TREETRACKER-API-KEY
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{apiKey}}'
contentTypeJsonHeader:
name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json
schemas:
authrequest:
title: Authentication Request
required:
- wallet
- password
type: object
properties:
wallet:
oneOf:
- type: string
format: string
example: zaven
- type: string
format: uuid
example: 21af8154-b7f1-48d3-8520-2e376efae45e
password:
type: string
example: walnut
bearerToken:
title: Successful Authentication Response
type: object
properties:
bearer:
type: string
tokens:
title: Token query response
type: object
properties:
tokens:
type: array
items:
$ref: '#/components/schemas/tokenItem'
tokenItem:
title: Token Item
type: object
properties:
id:
type: string
format: uuid
capture_id:
type: string
format: uuid
wallet_id:
type: string
format: uuid
transfer_pending:
type: boolean
transfer_pending_id:
type: string
format: uuid
created_at:
type: string
format: date
updated_at:
type: string
format: date
links:
type: object
properties:
capture:
type: string
example:
id: "ca1a99c3-9797-465d-8ee3-8dbd26a08faa"
capture_id: "8df635f6-2df8-496f-93da-3060fc1e3180"
wallet_id: "c63da6b3-d7a3-444a-9ff0-10644036eccd"
transfer_pending: false
transfer_pending_id: null
created_at: "2021-07-02T18:31:07.208Z"
updated_at: "2021-07-02T18:31:07.208Z"
links:
type: object
properties:
capture: "/webmap/tree?uuid=8df635f6-2df8-496f-93da-3060fc1e3180"
accountrequest:
title: accountrequest
required:
- wallet
type: object
properties:
wallet:
type: string
example:
wallet: sprinter_van_2004
walletsResponse:
title: Wallets Response
properties:
wallets:
type: array
items:
$ref: '#/components/schemas/walletItem'
total:
type: integer
description: total count of wallets satisfying the query condition
example: 1
query:
type: object
properties:
offset:
type: integer
example: 0
limit:
type: integer
example: 5
walletItem:
title: Wallet Details
properties:
id:
type: string
format: uuid
example: 482bf306-30c7-4cea-833a-1cdda3d96573
name:
type: string
example: test11
logo_url:
type: string
format: url
example: https://www.placehold.co/192x192
created_at:
type: string
format: date-time
example: 2023-08-08T06:28:39.766Z
tokens_in_wallet:
type: integer
example: 12
transferItem:
title: Transfer Details
properties:
id:
type: string
format: uuid
description: Transfer ID
example: cf0ce129-8c12-45cf-b914-a8f1cb6b7dc5
type:
type: string
enum:
- send
- deduct
- managed
description: Transfer type
example: send
parameters:
type: object
oneOf:
- properties:
bundle:
type: object
properties:
bundleSize:
type: integer
description: Number of tokens associated with the transfer
example: 2
required:
- bundleSize
- properties:
tokens:
type: array
items:
$ref: '#/components/schemas/tokenItem'
state:
type: string
enum:
- pending
- completed
- requested
- cancelled
- failed
example: completed
created_at:
type: string
format: date-time
example: 2023-08-02T21:46:35.134Z
closed_at:
type: string
format: date-time
example: 2023-08-02T21:46:35.134Z
active:
type: boolean
example: true
claim:
type: boolean
example: false
originating_wallet:
type: string
example: testuser
source_wallet:
type: string
example: testuser
destination_wallet:
type: string
example: wallet22
token_count:
type: integer
example: 1
transferrequest:
title: transferrequest
oneOf:
- properties:
tokens:
type: array
items:
type: string
description: 'Explicitly transfer tokens'
sender_wallet:
oneOf:
- type: string
- type: number
receiver_wallet:
oneOf:
- type: string
- type: number
required:
- tokens
- sender_wallet
- receiver_wallet
- properties:
bundle:
type: object
description: 'Transfer some amount of token'
properties:
bundle_size:
type: integer
description: required number of trees to transfer
sender_wallet:
oneOf:
- type: string
- type: number
receiver_wallet:
oneOf:
- type: string
- type: number
required:
- bundle
- sender_wallet
- receiver_wallet
transferbundlerequest:
title: transferbundlerequest
required:
- parameters
- sender_wallet
- receiver_wallet
type: object
properties:
parameters:
$ref: '#/components/schemas/requestBundleRequestParameters'
sender_wallet:
oneOf:
- type: string
- type: number
receiver_wallet:
oneOf:
- type: string
- type: number
example:
bundle_size: 500
sender_wallet: zaven
receiver_wallet: GreenEarthAppeal
sendrequest:
title: sendrequest
required:
- tokens
- receiver_wallet
type: object
properties:
tokens:
type: array
items:
type: string
description: ''
receiver_wallet:
oneOf:
- type: string
- type: number
example:
tokens:
- e1b278e8-f025-44b7-9dd8-36ffb2d58f7e
- e533653e-2dbf-48cd-940a-a87e5a393158
receiver_wallet: zaven
sendRequestProcessedResponse:
title: sendRequestProcessedResponse
type: object
properties:
id:
type: string
format: uuid
description: The unique ID for this transfer
originating_wallet:
type: string
example: johnwallet1
source_wallet:
type: string
example: planeter
destination_wallet:
type: string
example: just.a.guy
type:
type: string
description: 'the type of transfer. send, deduct, or managed. the value is computed by the server based on the submitted request'
example: send
parameters:
$ref: '#/components/schemas/requestBundleRequestParameters'
state:
type: string
description: 'the state of the transfer. requested, pending, completed, cancelled, or failed'
example: completed
created_at:
type: string
format: date-time
example: 2020-07-09T00:41:49+00:00
closed_at:
type: string
format: date-time
example: 2020-07-09T00:41:49+00:00
sendRequestPendingResponse:
title: sendRequestPendingResponse
sendBundleRequest:
title: sendBundleRequest
type: object
properties:
parameters:
$ref: '#/components/schemas/requestBundleRequestParameters'
receiver_wallet:
type: string