@percayso-community/cayso-contracts 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +114 -0
  3. package/dist/assertion.d.ts +867 -0
  4. package/dist/assertion.js +63 -0
  5. package/dist/assurance.d.ts +353 -0
  6. package/dist/assurance.js +551 -0
  7. package/dist/citizen-market.d.ts +468 -0
  8. package/dist/citizen-market.js +16 -0
  9. package/dist/citizenship.d.ts +215 -0
  10. package/dist/citizenship.js +26 -0
  11. package/dist/client.d.ts +288 -0
  12. package/dist/client.js +370 -0
  13. package/dist/commercial-payment.d.ts +243 -0
  14. package/dist/commercial-payment.js +16 -0
  15. package/dist/contract-schema.generated.d.ts +14 -0
  16. package/dist/contract-schema.generated.js +3107 -0
  17. package/dist/errors.d.ts +171 -0
  18. package/dist/errors.js +28 -0
  19. package/dist/index.d.ts +621 -0
  20. package/dist/index.js +624 -0
  21. package/dist/marketplace-receipt.d.ts +306 -0
  22. package/dist/marketplace-receipt.js +116 -0
  23. package/dist/marketplace-settlement.d.ts +298 -0
  24. package/dist/marketplace-settlement.js +16 -0
  25. package/dist/money.d.ts +84 -0
  26. package/dist/money.js +34 -0
  27. package/dist/organisation.d.ts +60 -0
  28. package/dist/organisation.js +16 -0
  29. package/dist/purchase.d.ts +531 -0
  30. package/dist/purchase.js +107 -0
  31. package/dist/restriction.d.ts +262 -0
  32. package/dist/restriction.js +316 -0
  33. package/dist/routes.d.ts +155 -0
  34. package/dist/routes.js +128 -0
  35. package/dist/schema-types.d.ts +101 -0
  36. package/dist/schema-types.js +16 -0
  37. package/dist/schema.d.ts +24 -0
  38. package/dist/schema.js +16 -0
  39. package/dist/wallet.d.ts +92 -0
  40. package/dist/wallet.js +59 -0
  41. package/package.json +41 -0
package/dist/contract-schema.generated.js ADDED
@@ -0,0 +1,3107 @@
1
+ /*
2
+ * Copyright 2026 Percayso Community
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ export const CONTRACT_SCHEMA = {
17
+ "contractVersion": "0.23.0",
18
+ "packageName": "@percayso-community/cayso-contracts",
19
+ "capabilities": {
20
+ "wallet": "cayso.wallet",
21
+ "purchase": "cayso.purchase"
22
+ },
23
+ "routes": {
24
+ "wallet": {
25
+ "method": "GET",
26
+ "path": "/api/wallet"
27
+ },
28
+ "citizenship": {
29
+ "method": "GET",
30
+ "path": "/api/citizenship"
31
+ },
32
+ "citizenshipProvision": {
33
+ "method": "POST",
34
+ "path": "/api/citizenship/provision"
35
+ },
36
+ "citizenshipFounderClaim": {
37
+ "method": "POST",
38
+ "path": "/api/citizenship/founder-claim"
39
+ },
40
+ "organisationProvision": {
41
+ "method": "POST",
42
+ "path": "/api/organisation/provision"
43
+ },
44
+ "purchaseAuthorise": {
45
+ "method": "POST",
46
+ "path": "/api/purchases"
47
+ },
48
+ "purchaseResult": {
49
+ "method": "GET",
50
+ "path": "/api/purchases/:purchaseId"
51
+ },
52
+ "purchaseCancel": {
53
+ "method": "POST",
54
+ "path": "/api/purchases/:purchaseId/cancel"
55
+ },
56
+ "commercialPayment": {
57
+ "method": "POST",
58
+ "path": "/api/commercial-payments"
59
+ },
60
+ "citizenMarket": {
61
+ "method": "GET",
62
+ "path": "/api/citizen-market"
63
+ },
64
+ "placeQuote": {
65
+ "method": "POST",
66
+ "path": "/api/quotes"
67
+ },
68
+ "withdrawQuote": {
69
+ "method": "POST",
70
+ "path": "/api/quote-withdrawals"
71
+ },
72
+ "requestBuyBack": {
73
+ "method": "POST",
74
+ "path": "/api/buy-backs"
75
+ },
76
+ "version": {
77
+ "method": "GET",
78
+ "path": "/api/version"
79
+ }
80
+ },
81
+ "types": {
82
+ "Allowance": {
83
+ "kind": "object",
84
+ "properties": {
85
+ "organisationWalletId": {
86
+ "type": {
87
+ "scalar": "string"
88
+ },
89
+ "readonly": true,
90
+ "optional": false
91
+ },
92
+ "limitCents": {
93
+ "type": {
94
+ "ref": "Cents"
95
+ },
96
+ "readonly": true,
97
+ "optional": false
98
+ },
99
+ "spentCents": {
100
+ "type": {
101
+ "ref": "Cents"
102
+ },
103
+ "readonly": true,
104
+ "optional": false
105
+ },
106
+ "remainingCents": {
107
+ "type": {
108
+ "ref": "Cents"
109
+ },
110
+ "readonly": true,
111
+ "optional": false
112
+ }
113
+ }
114
+ },
115
+ "AssertionClaims": {
116
+ "kind": "object",
117
+ "properties": {
118
+ "iss": {
119
+ "type": {
120
+ "scalar": "string"
121
+ },
122
+ "readonly": true,
123
+ "optional": false
124
+ },
125
+ "jti": {
126
+ "type": {
127
+ "scalar": "string"
128
+ },
129
+ "readonly": true,
130
+ "optional": false
131
+ },
132
+ "sub": {
133
+ "type": {
134
+ "scalar": "string"
135
+ },
136
+ "readonly": true,
137
+ "optional": false
138
+ },
139
+ "aud": {
140
+ "type": {
141
+ "literal": "cayso"
142
+ },
143
+ "readonly": true,
144
+ "optional": false
145
+ },
146
+ "scope": {
147
+ "type": {
148
+ "array": {
149
+ "ref": "ScopeKey"
150
+ },
151
+ "readonly": true
152
+ },
153
+ "readonly": true,
154
+ "optional": false
155
+ },
156
+ "exp": {
157
+ "type": {
158
+ "scalar": "number"
159
+ },
160
+ "readonly": true,
161
+ "optional": false
162
+ },
163
+ "iat": {
164
+ "type": {
165
+ "scalar": "number"
166
+ },
167
+ "readonly": true,
168
+ "optional": false
169
+ },
170
+ "verificationStatus": {
171
+ "type": {
172
+ "ref": "VerificationStatus"
173
+ },
174
+ "readonly": true,
175
+ "optional": false
176
+ },
177
+ "verificationMethod": {
178
+ "type": {
179
+ "union": [
180
+ {
181
+ "ref": "VerificationMethod"
182
+ },
183
+ {
184
+ "null": true
185
+ }
186
+ ]
187
+ },
188
+ "readonly": true,
189
+ "optional": false
190
+ },
191
+ "assuranceProfileVersion": {
192
+ "type": {
193
+ "scalar": "string"
194
+ },
195
+ "readonly": true,
196
+ "optional": false
197
+ },
198
+ "subjectPersonhood": {
199
+ "type": {
200
+ "ref": "SubjectPersonhood"
201
+ },
202
+ "readonly": true,
203
+ "optional": true
204
+ },
205
+ "organisationAuthority": {
206
+ "type": {
207
+ "scalar": "string"
208
+ },
209
+ "readonly": true,
210
+ "optional": true
211
+ },
212
+ "founderClaimReference": {
213
+ "type": {
214
+ "scalar": "string"
215
+ },
216
+ "readonly": true,
217
+ "optional": true
218
+ },
219
+ "mandateFor": {
220
+ "type": {
221
+ "array": {
222
+ "scalar": "string"
223
+ },
224
+ "readonly": true
225
+ },
226
+ "readonly": true,
227
+ "optional": true
228
+ },
229
+ "recoveredAt": {
230
+ "type": {
231
+ "scalar": "number"
232
+ },
233
+ "readonly": true,
234
+ "optional": true
235
+ },
236
+ "sessionAgeSeconds": {
237
+ "type": {
238
+ "scalar": "number"
239
+ },
240
+ "readonly": true,
241
+ "optional": true
242
+ }
243
+ }
244
+ },
245
+ "AssertionEnvelope": {
246
+ "kind": "object",
247
+ "properties": {
248
+ "header": {
249
+ "type": {
250
+ "ref": "AssertionHeader"
251
+ },
252
+ "readonly": true,
253
+ "optional": false
254
+ },
255
+ "claims": {
256
+ "type": {
257
+ "ref": "AssertionClaims"
258
+ },
259
+ "readonly": true,
260
+ "optional": false
261
+ }
262
+ }
263
+ },
264
+ "AssertionHeader": {
265
+ "kind": "object",
266
+ "properties": {
267
+ "alg": {
268
+ "type": {
269
+ "scalar": "string"
270
+ },
271
+ "readonly": true,
272
+ "optional": false
273
+ },
274
+ "kid": {
275
+ "type": {
276
+ "scalar": "string"
277
+ },
278
+ "readonly": true,
279
+ "optional": false
280
+ }
281
+ }
282
+ },
283
+ "Balance": {
284
+ "kind": "object",
285
+ "properties": {
286
+ "cents": {
287
+ "type": {
288
+ "ref": "Cents"
289
+ },
290
+ "readonly": true,
291
+ "optional": false
292
+ },
293
+ "restrictedCents": {
294
+ "type": {
295
+ "ref": "Cents"
296
+ },
297
+ "readonly": true,
298
+ "optional": false
299
+ },
300
+ "unrestrictedCents": {
301
+ "type": {
302
+ "ref": "Cents"
303
+ },
304
+ "readonly": true,
305
+ "optional": false
306
+ },
307
+ "publishedValuePence": {
308
+ "type": {
309
+ "scalar": "number"
310
+ },
311
+ "readonly": true,
312
+ "optional": false
313
+ },
314
+ "asOf": {
315
+ "type": {
316
+ "ref": "Millis"
317
+ },
318
+ "readonly": true,
319
+ "optional": false
320
+ }
321
+ }
322
+ },
323
+ "BookLevel": {
324
+ "kind": "object",
325
+ "properties": {
326
+ "limitPricePence": {
327
+ "type": {
328
+ "scalar": "number"
329
+ },
330
+ "readonly": true,
331
+ "optional": false
332
+ },
333
+ "sizeQuoteUnits": {
334
+ "type": {
335
+ "scalar": "number"
336
+ },
337
+ "readonly": true,
338
+ "optional": false
339
+ }
340
+ }
341
+ },
342
+ "BuyBack": {
343
+ "kind": "object",
344
+ "properties": {
345
+ "buyBackId": {
346
+ "type": {
347
+ "scalar": "string"
348
+ },
349
+ "readonly": true,
350
+ "optional": false
351
+ },
352
+ "sizeQuoteUnits": {
353
+ "type": {
354
+ "scalar": "number"
355
+ },
356
+ "readonly": true,
357
+ "optional": false
358
+ },
359
+ "cents": {
360
+ "type": {
361
+ "ref": "Cents"
362
+ },
363
+ "readonly": true,
364
+ "optional": false
365
+ },
366
+ "publishedValuePence": {
367
+ "type": {
368
+ "scalar": "number"
369
+ },
370
+ "readonly": true,
371
+ "optional": false
372
+ },
373
+ "floorReferencePence": {
374
+ "type": {
375
+ "scalar": "number"
376
+ },
377
+ "readonly": true,
378
+ "optional": false
379
+ },
380
+ "sterlingPence": {
381
+ "type": {
382
+ "scalar": "number"
383
+ },
384
+ "readonly": true,
385
+ "optional": false
386
+ },
387
+ "boughtBackAt": {
388
+ "type": {
389
+ "ref": "Millis"
390
+ },
391
+ "readonly": true,
392
+ "optional": false
393
+ }
394
+ }
395
+ },
396
+ "BuyBackMade": {
397
+ "kind": "object",
398
+ "properties": {
399
+ "outcome": {
400
+ "type": {
401
+ "literal": "bought-back"
402
+ },
403
+ "readonly": true,
404
+ "optional": false
405
+ },
406
+ "buyBack": {
407
+ "type": {
408
+ "ref": "BuyBack"
409
+ },
410
+ "readonly": true,
411
+ "optional": false
412
+ }
413
+ }
414
+ },
415
+ "BuyBackRefusal": {
416
+ "kind": "alias",
417
+ "of": {
418
+ "union": [
419
+ {
420
+ "literal": "assurance_not_money_grade"
421
+ },
422
+ {
423
+ "literal": "wallet_not_a_citizens"
424
+ },
425
+ {
426
+ "literal": "wallet_has_no_live_binding"
427
+ },
428
+ {
429
+ "literal": "size_not_whole_quote_units"
430
+ },
431
+ {
432
+ "literal": "unrestricted_cents_insufficient"
433
+ },
434
+ {
435
+ "literal": "published_value_unavailable"
436
+ },
437
+ {
438
+ "literal": "eligible_sterling_insufficient"
439
+ },
440
+ {
441
+ "literal": "idempotency_key_reused_for_a_different_buy_back"
442
+ },
443
+ {
444
+ "literal": "carve_contended"
445
+ }
446
+ ]
447
+ }
448
+ },
449
+ "BuyBackRefused": {
450
+ "kind": "object",
451
+ "properties": {
452
+ "outcome": {
453
+ "type": {
454
+ "literal": "refused"
455
+ },
456
+ "readonly": true,
457
+ "optional": false
458
+ },
459
+ "error": {
460
+ "type": {
461
+ "ref": "BuyBackRefusal"
462
+ },
463
+ "readonly": true,
464
+ "optional": false
465
+ }
466
+ }
467
+ },
468
+ "BuyBackRequest": {
469
+ "kind": "object",
470
+ "properties": {
471
+ "sizeQuoteUnits": {
472
+ "type": {
473
+ "scalar": "number"
474
+ },
475
+ "readonly": true,
476
+ "optional": false
477
+ },
478
+ "idempotencyKey": {
479
+ "type": {
480
+ "scalar": "string"
481
+ },
482
+ "readonly": true,
483
+ "optional": false
484
+ }
485
+ }
486
+ },
487
+ "BuyBackResponse": {
488
+ "kind": "alias",
489
+ "of": {
490
+ "union": [
491
+ {
492
+ "ref": "BuyBackMade"
493
+ },
494
+ {
495
+ "ref": "BuyBackRefused"
496
+ }
497
+ ]
498
+ }
499
+ },
500
+ "CaysoApiErrorCode": {
501
+ "kind": "alias",
502
+ "of": {
503
+ "union": [
504
+ {
505
+ "literal": "unauthenticated"
506
+ },
507
+ {
508
+ "literal": "assertion_invalid"
509
+ },
510
+ {
511
+ "literal": "assertion_expired"
512
+ },
513
+ {
514
+ "literal": "assertion_issuer_refused"
515
+ },
516
+ {
517
+ "literal": "assertion_key_refused"
518
+ },
519
+ {
520
+ "literal": "assertion_algorithm_refused"
521
+ },
522
+ {
523
+ "literal": "assertion_subject_refused"
524
+ },
525
+ {
526
+ "literal": "assertion_replayed"
527
+ },
528
+ {
529
+ "literal": "assertion_scope_refused"
530
+ },
531
+ {
532
+ "literal": "request_rate_limited"
533
+ },
534
+ {
535
+ "literal": "verifier_not_configured"
536
+ },
537
+ {
538
+ "literal": "issuer_registry_not_configured"
539
+ },
540
+ {
541
+ "literal": "wallet_store_not_configured"
542
+ },
543
+ {
544
+ "literal": "balance_reader_not_configured"
545
+ },
546
+ {
547
+ "literal": "citizenship_store_not_configured"
548
+ },
549
+ {
550
+ "literal": "founder_claim_store_not_configured"
551
+ },
552
+ {
553
+ "literal": "sign_up_grant_not_configured"
554
+ },
555
+ {
556
+ "literal": "sign_up_grant_envelope_policy_not_configured"
557
+ },
558
+ {
559
+ "literal": "sign_up_grant_exceeds_tier_envelope"
560
+ },
561
+ {
562
+ "literal": "purchase_store_not_configured"
563
+ },
564
+ {
565
+ "literal": "purchase_result_reader_not_configured"
566
+ },
567
+ {
568
+ "literal": "purchase_cancel_store_not_configured"
569
+ },
570
+ {
571
+ "literal": "published_value_not_configured"
572
+ },
573
+ {
574
+ "literal": "gateway_not_configured"
575
+ },
576
+ {
577
+ "literal": "schema_version_reader_not_configured"
578
+ },
579
+ {
580
+ "literal": "commercial_payment_store_not_configured"
581
+ },
582
+ {
583
+ "literal": "citizen_market_not_configured"
584
+ },
585
+ {
586
+ "literal": "buy_back_not_configured"
587
+ },
588
+ {
589
+ "literal": "sterling_not_observed"
590
+ },
591
+ {
592
+ "literal": "receipt_signing_not_configured"
593
+ },
594
+ {
595
+ "literal": "invalid_request"
596
+ },
597
+ {
598
+ "literal": "not_found"
599
+ },
600
+ {
601
+ "literal": "internal_error"
602
+ },
603
+ {
604
+ "ref": "PurchaseFailureReason"
605
+ },
606
+ {
607
+ "ref": "PurchaseCancelRefusalReason"
608
+ },
609
+ {
610
+ "ref": "FounderClaimRefusal"
611
+ },
612
+ {
613
+ "ref": "CommercialPaymentRefusal"
614
+ },
615
+ {
616
+ "ref": "QuotePlacementRefusal"
617
+ },
618
+ {
619
+ "ref": "QuoteWithdrawalRefusal"
620
+ },
621
+ {
622
+ "ref": "BuyBackRefusal"
623
+ },
624
+ {
625
+ "ref": "MarketplaceReceiptReadRefusal"
626
+ },
627
+ {
628
+ "ref": "MarketplaceOrderRefusal"
629
+ },
630
+ {
631
+ "ref": "MarketplaceRefundRefusal"
632
+ }
633
+ ]
634
+ }
635
+ },
636
+ "CaysoErrorResponse": {
637
+ "kind": "object",
638
+ "properties": {
639
+ "error": {
640
+ "type": {
641
+ "ref": "CaysoApiErrorCode"
642
+ },
643
+ "readonly": true,
644
+ "optional": false
645
+ }
646
+ }
647
+ },
648
+ "Cents": {
649
+ "kind": "alias",
650
+ "of": {
651
+ "scalar": "number"
652
+ }
653
+ },
654
+ "CitizenMarketResponse": {
655
+ "kind": "alias",
656
+ "of": {
657
+ "union": [
658
+ {
659
+ "ref": "CitizenMarketViewed"
660
+ },
661
+ {
662
+ "ref": "CitizenMarketViewRefused"
663
+ }
664
+ ]
665
+ }
666
+ },
667
+ "CitizenMarketView": {
668
+ "kind": "object",
669
+ "properties": {
670
+ "publishedValuePence": {
671
+ "type": {
672
+ "scalar": "number"
673
+ },
674
+ "readonly": true,
675
+ "optional": false
676
+ },
677
+ "band": {
678
+ "type": {
679
+ "scalar": "number"
680
+ },
681
+ "readonly": true,
682
+ "optional": false
683
+ },
684
+ "publishedValuePerQuoteUnitPence": {
685
+ "type": {
686
+ "scalar": "number"
687
+ },
688
+ "readonly": true,
689
+ "optional": false
690
+ },
691
+ "floorReferencePence": {
692
+ "type": {
693
+ "scalar": "number"
694
+ },
695
+ "readonly": true,
696
+ "optional": false
697
+ },
698
+ "quoteUnitCents": {
699
+ "type": {
700
+ "ref": "Cents"
701
+ },
702
+ "readonly": true,
703
+ "optional": false
704
+ },
705
+ "priceTickPence": {
706
+ "type": {
707
+ "scalar": "number"
708
+ },
709
+ "readonly": true,
710
+ "optional": false
711
+ },
712
+ "bestBid": {
713
+ "type": {
714
+ "union": [
715
+ {
716
+ "ref": "BookLevel"
717
+ },
718
+ {
719
+ "null": true
720
+ }
721
+ ]
722
+ },
723
+ "readonly": true,
724
+ "optional": false
725
+ },
726
+ "bestAsk": {
727
+ "type": {
728
+ "union": [
729
+ {
730
+ "ref": "BookLevel"
731
+ },
732
+ {
733
+ "null": true
734
+ }
735
+ ]
736
+ },
737
+ "readonly": true,
738
+ "optional": false
739
+ },
740
+ "ownQuotes": {
741
+ "type": {
742
+ "array": {
743
+ "ref": "OwnQuote"
744
+ },
745
+ "readonly": true
746
+ },
747
+ "readonly": true,
748
+ "optional": false
749
+ }
750
+ }
751
+ },
752
+ "CitizenMarketViewRefusal": {
753
+ "kind": "alias",
754
+ "of": {
755
+ "union": [
756
+ {
757
+ "literal": "wallet_not_a_citizens"
758
+ },
759
+ {
760
+ "literal": "wallet_has_no_live_binding"
761
+ },
762
+ {
763
+ "literal": "published_value_unavailable"
764
+ }
765
+ ]
766
+ }
767
+ },
768
+ "CitizenMarketViewRefused": {
769
+ "kind": "object",
770
+ "properties": {
771
+ "outcome": {
772
+ "type": {
773
+ "literal": "refused"
774
+ },
775
+ "readonly": true,
776
+ "optional": false
777
+ },
778
+ "error": {
779
+ "type": {
780
+ "ref": "CitizenMarketViewRefusal"
781
+ },
782
+ "readonly": true,
783
+ "optional": false
784
+ }
785
+ }
786
+ },
787
+ "CitizenMarketViewed": {
788
+ "kind": "object",
789
+ "properties": {
790
+ "outcome": {
791
+ "type": {
792
+ "literal": "viewed"
793
+ },
794
+ "readonly": true,
795
+ "optional": false
796
+ },
797
+ "market": {
798
+ "type": {
799
+ "ref": "CitizenMarketView"
800
+ },
801
+ "readonly": true,
802
+ "optional": false
803
+ }
804
+ }
805
+ },
806
+ "Citizenship": {
807
+ "kind": "alias",
808
+ "of": {
809
+ "union": [
810
+ {
811
+ "ref": "CitizenshipNotProvisioned"
812
+ },
813
+ {
814
+ "ref": "CitizenshipProvisioned"
815
+ },
816
+ {
817
+ "ref": "CitizenshipFounderClaimed"
818
+ }
819
+ ]
820
+ }
821
+ },
822
+ "CitizenshipFounderClaimed": {
823
+ "kind": "object",
824
+ "properties": {
825
+ "state": {
826
+ "type": {
827
+ "literal": "founder-claimed"
828
+ },
829
+ "readonly": true,
830
+ "optional": false
831
+ },
832
+ "wallet": {
833
+ "type": {
834
+ "ref": "WalletRecord"
835
+ },
836
+ "readonly": true,
837
+ "optional": false
838
+ }
839
+ }
840
+ },
841
+ "CitizenshipNotProvisioned": {
842
+ "kind": "object",
843
+ "properties": {
844
+ "state": {
845
+ "type": {
846
+ "literal": "not-provisioned"
847
+ },
848
+ "readonly": true,
849
+ "optional": false
850
+ }
851
+ }
852
+ },
853
+ "CitizenshipProvisioned": {
854
+ "kind": "object",
855
+ "properties": {
856
+ "state": {
857
+ "type": {
858
+ "literal": "provisioned"
859
+ },
860
+ "readonly": true,
861
+ "optional": false
862
+ },
863
+ "wallet": {
864
+ "type": {
865
+ "ref": "WalletRecord"
866
+ },
867
+ "readonly": true,
868
+ "optional": false
869
+ },
870
+ "signUpGrant": {
871
+ "type": {
872
+ "ref": "SignUpGrant"
873
+ },
874
+ "readonly": true,
875
+ "optional": false
876
+ }
877
+ }
878
+ },
879
+ "CitizenshipView": {
880
+ "kind": "object",
881
+ "properties": {
882
+ "terms": {
883
+ "type": {
884
+ "ref": "SignUpGrantTerms"
885
+ },
886
+ "readonly": true,
887
+ "optional": false
888
+ },
889
+ "citizenship": {
890
+ "type": {
891
+ "ref": "Citizenship"
892
+ },
893
+ "readonly": true,
894
+ "optional": false
895
+ }
896
+ }
897
+ },
898
+ "CommercialPayment": {
899
+ "kind": "object",
900
+ "properties": {
901
+ "movementId": {
902
+ "type": {
903
+ "scalar": "string"
904
+ },
905
+ "readonly": true,
906
+ "optional": false
907
+ },
908
+ "payingWalletId": {
909
+ "type": {
910
+ "scalar": "string"
911
+ },
912
+ "readonly": true,
913
+ "optional": false
914
+ },
915
+ "payeeWalletId": {
916
+ "type": {
917
+ "scalar": "string"
918
+ },
919
+ "readonly": true,
920
+ "optional": false
921
+ },
922
+ "cents": {
923
+ "type": {
924
+ "ref": "Cents"
925
+ },
926
+ "readonly": true,
927
+ "optional": false
928
+ },
929
+ "paidAt": {
930
+ "type": {
931
+ "ref": "Millis"
932
+ },
933
+ "readonly": true,
934
+ "optional": false
935
+ }
936
+ }
937
+ },
938
+ "CommercialPaymentAuthority": {
939
+ "kind": "alias",
940
+ "of": {
941
+ "union": [
942
+ {
943
+ "literal": "mandate"
944
+ },
945
+ {
946
+ "literal": "payment-allowance"
947
+ }
948
+ ]
949
+ }
950
+ },
951
+ "CommercialPaymentMade": {
952
+ "kind": "object",
953
+ "properties": {
954
+ "outcome": {
955
+ "type": {
956
+ "literal": "paid"
957
+ },
958
+ "readonly": true,
959
+ "optional": false
960
+ },
961
+ "payment": {
962
+ "type": {
963
+ "ref": "CommercialPayment"
964
+ },
965
+ "readonly": true,
966
+ "optional": false
967
+ }
968
+ }
969
+ },
970
+ "CommercialPaymentRefusal": {
971
+ "kind": "alias",
972
+ "of": {
973
+ "union": [
974
+ {
975
+ "literal": "mandate_claim_absent"
976
+ },
977
+ {
978
+ "literal": "mandate_claim_does_not_cover_the_paying_wallet"
979
+ },
980
+ {
981
+ "literal": "assurance_not_money_grade"
982
+ },
983
+ {
984
+ "literal": "acting_party_has_no_citizen_wallet"
985
+ },
986
+ {
987
+ "literal": "no_live_allowance"
988
+ },
989
+ {
990
+ "literal": "allowance_revoked"
991
+ },
992
+ {
993
+ "literal": "allowance_does_not_convey_payment"
994
+ },
995
+ {
996
+ "literal": "allowance_limit_insufficient"
997
+ },
998
+ {
999
+ "literal": "payment_above_authorised_user_threshold"
1000
+ },
1001
+ {
1002
+ "literal": "authorised_user_threshold_not_configured"
1003
+ },
1004
+ {
1005
+ "literal": "authorised_user_threshold_published_value_unavailable"
1006
+ },
1007
+ {
1008
+ "literal": "paying_wallet_not_an_organisations"
1009
+ },
1010
+ {
1011
+ "literal": "payee_wallet_not_found"
1012
+ },
1013
+ {
1014
+ "literal": "payee_wallet_not_a_citizens"
1015
+ },
1016
+ {
1017
+ "literal": "payee_wallet_has_no_live_binding"
1018
+ },
1019
+ {
1020
+ "literal": "payee_is_the_acting_party"
1021
+ },
1022
+ {
1023
+ "literal": "amount_not_positive_whole_cents"
1024
+ },
1025
+ {
1026
+ "literal": "unrestricted_cents_insufficient"
1027
+ },
1028
+ {
1029
+ "literal": "cents_frozen"
1030
+ },
1031
+ {
1032
+ "literal": "idempotency_key_reused_for_a_different_payment"
1033
+ },
1034
+ {
1035
+ "literal": "carve_contended"
1036
+ }
1037
+ ]
1038
+ }
1039
+ },
1040
+ "CommercialPaymentRefused": {
1041
+ "kind": "object",
1042
+ "properties": {
1043
+ "outcome": {
1044
+ "type": {
1045
+ "literal": "refused"
1046
+ },
1047
+ "readonly": true,
1048
+ "optional": false
1049
+ },
1050
+ "error": {
1051
+ "type": {
1052
+ "ref": "CommercialPaymentRefusal"
1053
+ },
1054
+ "readonly": true,
1055
+ "optional": false
1056
+ }
1057
+ }
1058
+ },
1059
+ "CommercialPaymentRequest": {
1060
+ "kind": "object",
1061
+ "properties": {
1062
+ "authority": {
1063
+ "type": {
1064
+ "ref": "CommercialPaymentAuthority"
1065
+ },
1066
+ "readonly": true,
1067
+ "optional": false
1068
+ },
1069
+ "payingWalletId": {
1070
+ "type": {
1071
+ "scalar": "string"
1072
+ },
1073
+ "readonly": true,
1074
+ "optional": false
1075
+ },
1076
+ "payeeWalletId": {
1077
+ "type": {
1078
+ "scalar": "string"
1079
+ },
1080
+ "readonly": true,
1081
+ "optional": false
1082
+ },
1083
+ "cents": {
1084
+ "type": {
1085
+ "ref": "Cents"
1086
+ },
1087
+ "readonly": true,
1088
+ "optional": false
1089
+ },
1090
+ "idempotencyKey": {
1091
+ "type": {
1092
+ "scalar": "string"
1093
+ },
1094
+ "readonly": true,
1095
+ "optional": false
1096
+ }
1097
+ }
1098
+ },
1099
+ "CommercialPaymentResponse": {
1100
+ "kind": "alias",
1101
+ "of": {
1102
+ "union": [
1103
+ {
1104
+ "ref": "CommercialPaymentMade"
1105
+ },
1106
+ {
1107
+ "ref": "CommercialPaymentRefused"
1108
+ }
1109
+ ]
1110
+ }
1111
+ },
1112
+ "ContractOperation": {
1113
+ "kind": "alias",
1114
+ "of": {
1115
+ "union": [
1116
+ {
1117
+ "literal": "read-own-wallet"
1118
+ },
1119
+ {
1120
+ "literal": "read-purchase-result"
1121
+ },
1122
+ {
1123
+ "literal": "authorise-purchase"
1124
+ },
1125
+ {
1126
+ "literal": "cancel-purchase"
1127
+ },
1128
+ {
1129
+ "literal": "provision-citizenship"
1130
+ },
1131
+ {
1132
+ "literal": "read-own-citizenship"
1133
+ },
1134
+ {
1135
+ "literal": "provision-organisation"
1136
+ },
1137
+ {
1138
+ "literal": "claim-founder-wallet"
1139
+ },
1140
+ {
1141
+ "literal": "make-commercial-payment"
1142
+ },
1143
+ {
1144
+ "literal": "place-quote"
1145
+ },
1146
+ {
1147
+ "literal": "withdraw-quote"
1148
+ },
1149
+ {
1150
+ "literal": "request-buy-back"
1151
+ },
1152
+ {
1153
+ "literal": "read-citizen-market"
1154
+ },
1155
+ {
1156
+ "literal": "read-marketplace-receipt"
1157
+ },
1158
+ {
1159
+ "literal": "settle-marketplace-order"
1160
+ },
1161
+ {
1162
+ "literal": "settle-marketplace-refund"
1163
+ }
1164
+ ]
1165
+ }
1166
+ },
1167
+ "FounderClaimRefusal": {
1168
+ "kind": "alias",
1169
+ "of": {
1170
+ "union": [
1171
+ {
1172
+ "literal": "founder_genesis_not_performed"
1173
+ },
1174
+ {
1175
+ "literal": "founder_claim_reference_unknown"
1176
+ },
1177
+ {
1178
+ "literal": "founder_wallet_already_claimed"
1179
+ },
1180
+ {
1181
+ "literal": "founder_wallet_lapsed"
1182
+ },
1183
+ {
1184
+ "literal": "citizen_already_holds_a_wallet"
1185
+ }
1186
+ ]
1187
+ }
1188
+ },
1189
+ "HolderType": {
1190
+ "kind": "alias",
1191
+ "of": {
1192
+ "union": [
1193
+ {
1194
+ "literal": "citizen"
1195
+ },
1196
+ {
1197
+ "literal": "organisation"
1198
+ }
1199
+ ]
1200
+ }
1201
+ },
1202
+ "HousePublisherChargeReceiptStatement": {
1203
+ "kind": "object",
1204
+ "properties": {
1205
+ "movementKind": {
1206
+ "type": {
1207
+ "literal": "charge"
1208
+ },
1209
+ "readonly": true,
1210
+ "optional": false
1211
+ },
1212
+ "saleKind": {
1213
+ "type": {
1214
+ "literal": "house-publisher"
1215
+ },
1216
+ "readonly": true,
1217
+ "optional": false
1218
+ },
1219
+ "movementId": {
1220
+ "type": {
1221
+ "scalar": "string"
1222
+ },
1223
+ "readonly": true,
1224
+ "optional": false
1225
+ },
1226
+ "orderDigest": {
1227
+ "type": {
1228
+ "scalar": "string"
1229
+ },
1230
+ "readonly": true,
1231
+ "optional": false
1232
+ },
1233
+ "idempotencyKey": {
1234
+ "type": {
1235
+ "scalar": "string"
1236
+ },
1237
+ "readonly": true,
1238
+ "optional": false
1239
+ },
1240
+ "buyerWalletId": {
1241
+ "type": {
1242
+ "scalar": "string"
1243
+ },
1244
+ "readonly": true,
1245
+ "optional": false
1246
+ },
1247
+ "communityLeg": {
1248
+ "type": {
1249
+ "ref": "MarketplaceReceiptLeg"
1250
+ },
1251
+ "readonly": true,
1252
+ "optional": false
1253
+ },
1254
+ "allocationPolicyVersion": {
1255
+ "type": {
1256
+ "scalar": "string"
1257
+ },
1258
+ "readonly": true,
1259
+ "optional": false
1260
+ },
1261
+ "writtenAt": {
1262
+ "type": {
1263
+ "ref": "Millis"
1264
+ },
1265
+ "readonly": true,
1266
+ "optional": false
1267
+ },
1268
+ "keyId": {
1269
+ "type": {
1270
+ "ref": "MarketplaceReceiptKeyId"
1271
+ },
1272
+ "readonly": true,
1273
+ "optional": false
1274
+ }
1275
+ }
1276
+ },
1277
+ "HousePublisherRefundReceiptStatement": {
1278
+ "kind": "object",
1279
+ "properties": {
1280
+ "movementKind": {
1281
+ "type": {
1282
+ "literal": "marketplace_refund"
1283
+ },
1284
+ "readonly": true,
1285
+ "optional": false
1286
+ },
1287
+ "saleKind": {
1288
+ "type": {
1289
+ "literal": "house-publisher"
1290
+ },
1291
+ "readonly": true,
1292
+ "optional": false
1293
+ },
1294
+ "movementId": {
1295
+ "type": {
1296
+ "scalar": "string"
1297
+ },
1298
+ "readonly": true,
1299
+ "optional": false
1300
+ },
1301
+ "orderDigest": {
1302
+ "type": {
1303
+ "scalar": "string"
1304
+ },
1305
+ "readonly": true,
1306
+ "optional": false
1307
+ },
1308
+ "idempotencyKey": {
1309
+ "type": {
1310
+ "scalar": "string"
1311
+ },
1312
+ "readonly": true,
1313
+ "optional": false
1314
+ },
1315
+ "buyerWalletId": {
1316
+ "type": {
1317
+ "scalar": "string"
1318
+ },
1319
+ "readonly": true,
1320
+ "optional": false
1321
+ },
1322
+ "communityLeg": {
1323
+ "type": {
1324
+ "ref": "MarketplaceReceiptLeg"
1325
+ },
1326
+ "readonly": true,
1327
+ "optional": false
1328
+ },
1329
+ "allocationPolicyVersion": {
1330
+ "type": {
1331
+ "scalar": "string"
1332
+ },
1333
+ "readonly": true,
1334
+ "optional": false
1335
+ },
1336
+ "writtenAt": {
1337
+ "type": {
1338
+ "ref": "Millis"
1339
+ },
1340
+ "readonly": true,
1341
+ "optional": false
1342
+ },
1343
+ "keyId": {
1344
+ "type": {
1345
+ "ref": "MarketplaceReceiptKeyId"
1346
+ },
1347
+ "readonly": true,
1348
+ "optional": false
1349
+ }
1350
+ }
1351
+ },
1352
+ "InternalOperation": {
1353
+ "kind": "alias",
1354
+ "of": {
1355
+ "scalar": "string"
1356
+ }
1357
+ },
1358
+ "LivePurchaseStatus": {
1359
+ "kind": "alias",
1360
+ "of": {
1361
+ "union": [
1362
+ {
1363
+ "literal": "pending"
1364
+ },
1365
+ {
1366
+ "literal": "issued_uncaptured"
1367
+ }
1368
+ ]
1369
+ }
1370
+ },
1371
+ "MarketplaceNoMovement": {
1372
+ "kind": "object",
1373
+ "properties": {
1374
+ "outcome": {
1375
+ "type": {
1376
+ "literal": "no-movement"
1377
+ },
1378
+ "readonly": true,
1379
+ "optional": false
1380
+ }
1381
+ }
1382
+ },
1383
+ "MarketplaceOrderReceipt": {
1384
+ "kind": "object",
1385
+ "properties": {
1386
+ "statement": {
1387
+ "type": {
1388
+ "union": [
1389
+ {
1390
+ "ref": "MarketplaceSettlementReceiptStatement"
1391
+ },
1392
+ {
1393
+ "ref": "HousePublisherChargeReceiptStatement"
1394
+ }
1395
+ ]
1396
+ },
1397
+ "readonly": true,
1398
+ "optional": false
1399
+ },
1400
+ "signature": {
1401
+ "type": {
1402
+ "scalar": "string"
1403
+ },
1404
+ "readonly": true,
1405
+ "optional": false
1406
+ }
1407
+ }
1408
+ },
1409
+ "MarketplaceOrderRefusal": {
1410
+ "kind": "alias",
1411
+ "of": {
1412
+ "union": [
1413
+ {
1414
+ "literal": "assurance_not_money_grade"
1415
+ },
1416
+ {
1417
+ "literal": "wallet_has_no_live_binding"
1418
+ },
1419
+ {
1420
+ "literal": "order_key_not_recognised"
1421
+ },
1422
+ {
1423
+ "literal": "order_signature_invalid"
1424
+ },
1425
+ {
1426
+ "literal": "order_digest_mismatch"
1427
+ },
1428
+ {
1429
+ "literal": "order_payer_wallet_not_the_buyers"
1430
+ },
1431
+ {
1432
+ "literal": "idempotency_key_reused_for_a_different_order"
1433
+ },
1434
+ {
1435
+ "literal": "allocation_policy_version_not_configured"
1436
+ },
1437
+ {
1438
+ "literal": "payee_wallet_not_found"
1439
+ },
1440
+ {
1441
+ "literal": "payee_wallet_not_a_citizens"
1442
+ },
1443
+ {
1444
+ "literal": "payee_wallet_has_no_live_binding"
1445
+ },
1446
+ {
1447
+ "literal": "unrestricted_cents_insufficient"
1448
+ },
1449
+ {
1450
+ "literal": "cents_insufficient"
1451
+ },
1452
+ {
1453
+ "literal": "cents_frozen"
1454
+ },
1455
+ {
1456
+ "literal": "carve_contended"
1457
+ }
1458
+ ]
1459
+ }
1460
+ },
1461
+ "MarketplaceOrderRefused": {
1462
+ "kind": "object",
1463
+ "properties": {
1464
+ "outcome": {
1465
+ "type": {
1466
+ "literal": "refused"
1467
+ },
1468
+ "readonly": true,
1469
+ "optional": false
1470
+ },
1471
+ "error": {
1472
+ "type": {
1473
+ "ref": "MarketplaceOrderRefusal"
1474
+ },
1475
+ "readonly": true,
1476
+ "optional": false
1477
+ }
1478
+ }
1479
+ },
1480
+ "MarketplaceOrderRequest": {
1481
+ "kind": "object",
1482
+ "properties": {
1483
+ "signedOrder": {
1484
+ "type": {
1485
+ "ref": "StoreSignedStatement"
1486
+ },
1487
+ "readonly": true,
1488
+ "optional": false
1489
+ }
1490
+ }
1491
+ },
1492
+ "MarketplaceOrderResponse": {
1493
+ "kind": "alias",
1494
+ "of": {
1495
+ "union": [
1496
+ {
1497
+ "ref": "MarketplaceOrderSettled"
1498
+ },
1499
+ {
1500
+ "ref": "MarketplaceOrderRefused"
1501
+ }
1502
+ ]
1503
+ }
1504
+ },
1505
+ "MarketplaceOrderSettled": {
1506
+ "kind": "object",
1507
+ "properties": {
1508
+ "outcome": {
1509
+ "type": {
1510
+ "literal": "settled"
1511
+ },
1512
+ "readonly": true,
1513
+ "optional": false
1514
+ },
1515
+ "receipt": {
1516
+ "type": {
1517
+ "ref": "MarketplaceOrderReceipt"
1518
+ },
1519
+ "readonly": true,
1520
+ "optional": false
1521
+ }
1522
+ }
1523
+ },
1524
+ "MarketplaceReceipt": {
1525
+ "kind": "object",
1526
+ "properties": {
1527
+ "statement": {
1528
+ "type": {
1529
+ "ref": "MarketplaceReceiptStatement"
1530
+ },
1531
+ "readonly": true,
1532
+ "optional": false
1533
+ },
1534
+ "signature": {
1535
+ "type": {
1536
+ "scalar": "string"
1537
+ },
1538
+ "readonly": true,
1539
+ "optional": false
1540
+ }
1541
+ }
1542
+ },
1543
+ "MarketplaceReceiptFound": {
1544
+ "kind": "object",
1545
+ "properties": {
1546
+ "outcome": {
1547
+ "type": {
1548
+ "literal": "receipt"
1549
+ },
1550
+ "readonly": true,
1551
+ "optional": false
1552
+ },
1553
+ "receipt": {
1554
+ "type": {
1555
+ "ref": "MarketplaceReceipt"
1556
+ },
1557
+ "readonly": true,
1558
+ "optional": false
1559
+ }
1560
+ }
1561
+ },
1562
+ "MarketplaceReceiptKeyId": {
1563
+ "kind": "alias",
1564
+ "of": {
1565
+ "scalar": "string"
1566
+ }
1567
+ },
1568
+ "MarketplaceReceiptLeg": {
1569
+ "kind": "object",
1570
+ "properties": {
1571
+ "walletId": {
1572
+ "type": {
1573
+ "scalar": "string"
1574
+ },
1575
+ "readonly": true,
1576
+ "optional": false
1577
+ },
1578
+ "cents": {
1579
+ "type": {
1580
+ "ref": "Cents"
1581
+ },
1582
+ "readonly": true,
1583
+ "optional": false
1584
+ }
1585
+ }
1586
+ },
1587
+ "MarketplaceReceiptReadRefusal": {
1588
+ "kind": "alias",
1589
+ "of": {
1590
+ "literal": "wallet_has_no_live_binding"
1591
+ }
1592
+ },
1593
+ "MarketplaceReceiptReadRefused": {
1594
+ "kind": "object",
1595
+ "properties": {
1596
+ "outcome": {
1597
+ "type": {
1598
+ "literal": "refused"
1599
+ },
1600
+ "readonly": true,
1601
+ "optional": false
1602
+ },
1603
+ "error": {
1604
+ "type": {
1605
+ "ref": "MarketplaceReceiptReadRefusal"
1606
+ },
1607
+ "readonly": true,
1608
+ "optional": false
1609
+ }
1610
+ }
1611
+ },
1612
+ "MarketplaceReceiptReadRequest": {
1613
+ "kind": "object",
1614
+ "properties": {
1615
+ "idempotencyKey": {
1616
+ "type": {
1617
+ "scalar": "string"
1618
+ },
1619
+ "readonly": true,
1620
+ "optional": false
1621
+ }
1622
+ }
1623
+ },
1624
+ "MarketplaceReceiptReadResponse": {
1625
+ "kind": "alias",
1626
+ "of": {
1627
+ "union": [
1628
+ {
1629
+ "ref": "MarketplaceReceiptFound"
1630
+ },
1631
+ {
1632
+ "ref": "MarketplaceNoMovement"
1633
+ },
1634
+ {
1635
+ "ref": "MarketplaceReceiptReadRefused"
1636
+ }
1637
+ ]
1638
+ }
1639
+ },
1640
+ "MarketplaceReceiptSignatureAlgorithm": {
1641
+ "kind": "alias",
1642
+ "of": {
1643
+ "literal": "ES256"
1644
+ }
1645
+ },
1646
+ "MarketplaceReceiptStatement": {
1647
+ "kind": "alias",
1648
+ "of": {
1649
+ "union": [
1650
+ {
1651
+ "ref": "MarketplaceSettlementReceiptStatement"
1652
+ },
1653
+ {
1654
+ "ref": "HousePublisherChargeReceiptStatement"
1655
+ },
1656
+ {
1657
+ "ref": "ThirdPartyRefundReceiptStatement"
1658
+ },
1659
+ {
1660
+ "ref": "HousePublisherRefundReceiptStatement"
1661
+ }
1662
+ ]
1663
+ }
1664
+ },
1665
+ "MarketplaceRefundReceipt": {
1666
+ "kind": "object",
1667
+ "properties": {
1668
+ "statement": {
1669
+ "type": {
1670
+ "union": [
1671
+ {
1672
+ "ref": "ThirdPartyRefundReceiptStatement"
1673
+ },
1674
+ {
1675
+ "ref": "HousePublisherRefundReceiptStatement"
1676
+ }
1677
+ ]
1678
+ },
1679
+ "readonly": true,
1680
+ "optional": false
1681
+ },
1682
+ "signature": {
1683
+ "type": {
1684
+ "scalar": "string"
1685
+ },
1686
+ "readonly": true,
1687
+ "optional": false
1688
+ }
1689
+ }
1690
+ },
1691
+ "MarketplaceRefundRefusal": {
1692
+ "kind": "alias",
1693
+ "of": {
1694
+ "union": [
1695
+ {
1696
+ "literal": "assurance_not_money_grade"
1697
+ },
1698
+ {
1699
+ "literal": "wallet_has_no_live_binding"
1700
+ },
1701
+ {
1702
+ "literal": "refund_decision_key_not_recognised"
1703
+ },
1704
+ {
1705
+ "literal": "refund_decision_signature_invalid"
1706
+ },
1707
+ {
1708
+ "literal": "sale_not_found"
1709
+ },
1710
+ {
1711
+ "literal": "idempotency_key_reused_for_a_different_refund"
1712
+ },
1713
+ {
1714
+ "literal": "refund_window_passed"
1715
+ },
1716
+ {
1717
+ "literal": "listing_already_refunded"
1718
+ },
1719
+ {
1720
+ "literal": "refund_figure_not_configured"
1721
+ },
1722
+ {
1723
+ "literal": "publisher_unrestricted_cents_insufficient"
1724
+ },
1725
+ {
1726
+ "literal": "cents_frozen"
1727
+ },
1728
+ {
1729
+ "literal": "carve_contended"
1730
+ }
1731
+ ]
1732
+ }
1733
+ },
1734
+ "MarketplaceRefundRefused": {
1735
+ "kind": "object",
1736
+ "properties": {
1737
+ "outcome": {
1738
+ "type": {
1739
+ "literal": "refused"
1740
+ },
1741
+ "readonly": true,
1742
+ "optional": false
1743
+ },
1744
+ "error": {
1745
+ "type": {
1746
+ "ref": "MarketplaceRefundRefusal"
1747
+ },
1748
+ "readonly": true,
1749
+ "optional": false
1750
+ }
1751
+ }
1752
+ },
1753
+ "MarketplaceRefundRequest": {
1754
+ "kind": "object",
1755
+ "properties": {
1756
+ "signedRefundDecision": {
1757
+ "type": {
1758
+ "ref": "StoreSignedStatement"
1759
+ },
1760
+ "readonly": true,
1761
+ "optional": false
1762
+ }
1763
+ }
1764
+ },
1765
+ "MarketplaceRefundResponse": {
1766
+ "kind": "alias",
1767
+ "of": {
1768
+ "union": [
1769
+ {
1770
+ "ref": "MarketplaceRefundSettled"
1771
+ },
1772
+ {
1773
+ "ref": "MarketplaceRefundRefused"
1774
+ }
1775
+ ]
1776
+ }
1777
+ },
1778
+ "MarketplaceRefundSettled": {
1779
+ "kind": "object",
1780
+ "properties": {
1781
+ "outcome": {
1782
+ "type": {
1783
+ "literal": "refunded"
1784
+ },
1785
+ "readonly": true,
1786
+ "optional": false
1787
+ },
1788
+ "receipt": {
1789
+ "type": {
1790
+ "ref": "MarketplaceRefundReceipt"
1791
+ },
1792
+ "readonly": true,
1793
+ "optional": false
1794
+ }
1795
+ }
1796
+ },
1797
+ "MarketplaceSaleKind": {
1798
+ "kind": "alias",
1799
+ "of": {
1800
+ "union": [
1801
+ {
1802
+ "literal": "third-party"
1803
+ },
1804
+ {
1805
+ "literal": "house-publisher"
1806
+ }
1807
+ ]
1808
+ }
1809
+ },
1810
+ "MarketplaceSettlementReceiptStatement": {
1811
+ "kind": "object",
1812
+ "properties": {
1813
+ "movementKind": {
1814
+ "type": {
1815
+ "literal": "marketplace_settlement"
1816
+ },
1817
+ "readonly": true,
1818
+ "optional": false
1819
+ },
1820
+ "saleKind": {
1821
+ "type": {
1822
+ "literal": "third-party"
1823
+ },
1824
+ "readonly": true,
1825
+ "optional": false
1826
+ },
1827
+ "movementId": {
1828
+ "type": {
1829
+ "scalar": "string"
1830
+ },
1831
+ "readonly": true,
1832
+ "optional": false
1833
+ },
1834
+ "orderDigest": {
1835
+ "type": {
1836
+ "scalar": "string"
1837
+ },
1838
+ "readonly": true,
1839
+ "optional": false
1840
+ },
1841
+ "idempotencyKey": {
1842
+ "type": {
1843
+ "scalar": "string"
1844
+ },
1845
+ "readonly": true,
1846
+ "optional": false
1847
+ },
1848
+ "buyerWalletId": {
1849
+ "type": {
1850
+ "scalar": "string"
1851
+ },
1852
+ "readonly": true,
1853
+ "optional": false
1854
+ },
1855
+ "publisherLeg": {
1856
+ "type": {
1857
+ "ref": "MarketplaceReceiptLeg"
1858
+ },
1859
+ "readonly": true,
1860
+ "optional": false
1861
+ },
1862
+ "communityLeg": {
1863
+ "type": {
1864
+ "ref": "MarketplaceReceiptLeg"
1865
+ },
1866
+ "readonly": true,
1867
+ "optional": false
1868
+ },
1869
+ "allocationPolicyVersion": {
1870
+ "type": {
1871
+ "scalar": "string"
1872
+ },
1873
+ "readonly": true,
1874
+ "optional": false
1875
+ },
1876
+ "writtenAt": {
1877
+ "type": {
1878
+ "ref": "Millis"
1879
+ },
1880
+ "readonly": true,
1881
+ "optional": false
1882
+ },
1883
+ "keyId": {
1884
+ "type": {
1885
+ "ref": "MarketplaceReceiptKeyId"
1886
+ },
1887
+ "readonly": true,
1888
+ "optional": false
1889
+ }
1890
+ }
1891
+ },
1892
+ "Millis": {
1893
+ "kind": "alias",
1894
+ "of": {
1895
+ "scalar": "number"
1896
+ }
1897
+ },
1898
+ "OrganisationView": {
1899
+ "kind": "object",
1900
+ "properties": {
1901
+ "wallet": {
1902
+ "type": {
1903
+ "ref": "WalletRecord"
1904
+ },
1905
+ "readonly": true,
1906
+ "optional": false
1907
+ }
1908
+ }
1909
+ },
1910
+ "OwnQuote": {
1911
+ "kind": "alias",
1912
+ "of": {
1913
+ "union": [
1914
+ {
1915
+ "ref": "OwnQuoteNotWithdrawn"
1916
+ },
1917
+ {
1918
+ "ref": "OwnQuoteWithdrawn"
1919
+ }
1920
+ ]
1921
+ }
1922
+ },
1923
+ "OwnQuoteNotWithdrawn": {
1924
+ "kind": "object",
1925
+ "properties": {
1926
+ "quoteId": {
1927
+ "type": {
1928
+ "scalar": "string"
1929
+ },
1930
+ "readonly": true,
1931
+ "optional": false
1932
+ },
1933
+ "side": {
1934
+ "type": {
1935
+ "ref": "QuoteSide"
1936
+ },
1937
+ "readonly": true,
1938
+ "optional": false
1939
+ },
1940
+ "limitPricePence": {
1941
+ "type": {
1942
+ "scalar": "number"
1943
+ },
1944
+ "readonly": true,
1945
+ "optional": false
1946
+ },
1947
+ "sizeQuoteUnits": {
1948
+ "type": {
1949
+ "scalar": "number"
1950
+ },
1951
+ "readonly": true,
1952
+ "optional": false
1953
+ },
1954
+ "placedAt": {
1955
+ "type": {
1956
+ "ref": "Millis"
1957
+ },
1958
+ "readonly": true,
1959
+ "optional": false
1960
+ },
1961
+ "expiresAt": {
1962
+ "type": {
1963
+ "ref": "Millis"
1964
+ },
1965
+ "readonly": true,
1966
+ "optional": false
1967
+ },
1968
+ "filledQuoteUnits": {
1969
+ "type": {
1970
+ "scalar": "number"
1971
+ },
1972
+ "readonly": true,
1973
+ "optional": false
1974
+ },
1975
+ "withdrawableFrom": {
1976
+ "type": {
1977
+ "ref": "Millis"
1978
+ },
1979
+ "readonly": true,
1980
+ "optional": false
1981
+ },
1982
+ "status": {
1983
+ "type": {
1984
+ "union": [
1985
+ {
1986
+ "literal": "resting"
1987
+ },
1988
+ {
1989
+ "literal": "filled"
1990
+ },
1991
+ {
1992
+ "literal": "expired"
1993
+ }
1994
+ ]
1995
+ },
1996
+ "readonly": true,
1997
+ "optional": false
1998
+ }
1999
+ }
2000
+ },
2001
+ "OwnQuoteWithdrawn": {
2002
+ "kind": "object",
2003
+ "properties": {
2004
+ "quoteId": {
2005
+ "type": {
2006
+ "scalar": "string"
2007
+ },
2008
+ "readonly": true,
2009
+ "optional": false
2010
+ },
2011
+ "side": {
2012
+ "type": {
2013
+ "ref": "QuoteSide"
2014
+ },
2015
+ "readonly": true,
2016
+ "optional": false
2017
+ },
2018
+ "limitPricePence": {
2019
+ "type": {
2020
+ "scalar": "number"
2021
+ },
2022
+ "readonly": true,
2023
+ "optional": false
2024
+ },
2025
+ "sizeQuoteUnits": {
2026
+ "type": {
2027
+ "scalar": "number"
2028
+ },
2029
+ "readonly": true,
2030
+ "optional": false
2031
+ },
2032
+ "placedAt": {
2033
+ "type": {
2034
+ "ref": "Millis"
2035
+ },
2036
+ "readonly": true,
2037
+ "optional": false
2038
+ },
2039
+ "expiresAt": {
2040
+ "type": {
2041
+ "ref": "Millis"
2042
+ },
2043
+ "readonly": true,
2044
+ "optional": false
2045
+ },
2046
+ "filledQuoteUnits": {
2047
+ "type": {
2048
+ "scalar": "number"
2049
+ },
2050
+ "readonly": true,
2051
+ "optional": false
2052
+ },
2053
+ "withdrawableFrom": {
2054
+ "type": {
2055
+ "ref": "Millis"
2056
+ },
2057
+ "readonly": true,
2058
+ "optional": false
2059
+ },
2060
+ "status": {
2061
+ "type": {
2062
+ "literal": "withdrawn"
2063
+ },
2064
+ "readonly": true,
2065
+ "optional": false
2066
+ },
2067
+ "withdrawalReason": {
2068
+ "type": {
2069
+ "ref": "QuoteWithdrawalReason"
2070
+ },
2071
+ "readonly": true,
2072
+ "optional": false
2073
+ }
2074
+ }
2075
+ },
2076
+ "PurchaseAuthorisationResponse": {
2077
+ "kind": "alias",
2078
+ "of": {
2079
+ "union": [
2080
+ {
2081
+ "ref": "PurchaseAuthorised"
2082
+ },
2083
+ {
2084
+ "ref": "PurchaseTerminal"
2085
+ },
2086
+ {
2087
+ "ref": "PurchaseUnresolved"
2088
+ },
2089
+ {
2090
+ "ref": "PurchaseRefused"
2091
+ }
2092
+ ]
2093
+ }
2094
+ },
2095
+ "PurchaseAuthorised": {
2096
+ "kind": "object",
2097
+ "properties": {
2098
+ "outcome": {
2099
+ "type": {
2100
+ "literal": "authorised"
2101
+ },
2102
+ "readonly": true,
2103
+ "optional": false
2104
+ },
2105
+ "purchaseId": {
2106
+ "type": {
2107
+ "scalar": "string"
2108
+ },
2109
+ "readonly": true,
2110
+ "optional": false
2111
+ },
2112
+ "cents": {
2113
+ "type": {
2114
+ "ref": "Cents"
2115
+ },
2116
+ "readonly": true,
2117
+ "optional": false
2118
+ },
2119
+ "publishedValuePence": {
2120
+ "type": {
2121
+ "scalar": "number"
2122
+ },
2123
+ "readonly": true,
2124
+ "optional": false
2125
+ },
2126
+ "paymentClientSecret": {
2127
+ "type": {
2128
+ "scalar": "string"
2129
+ },
2130
+ "readonly": true,
2131
+ "optional": false
2132
+ },
2133
+ "expiresAt": {
2134
+ "type": {
2135
+ "ref": "Millis"
2136
+ },
2137
+ "readonly": true,
2138
+ "optional": false
2139
+ }
2140
+ }
2141
+ },
2142
+ "PurchaseCancelRefusalReason": {
2143
+ "kind": "alias",
2144
+ "of": {
2145
+ "union": [
2146
+ {
2147
+ "literal": "already_succeeded"
2148
+ },
2149
+ {
2150
+ "literal": "already_failed"
2151
+ },
2152
+ {
2153
+ "literal": "already_issued"
2154
+ }
2155
+ ]
2156
+ }
2157
+ },
2158
+ "PurchaseCancelRefused": {
2159
+ "kind": "object",
2160
+ "properties": {
2161
+ "outcome": {
2162
+ "type": {
2163
+ "literal": "refused"
2164
+ },
2165
+ "readonly": true,
2166
+ "optional": false
2167
+ },
2168
+ "error": {
2169
+ "type": {
2170
+ "ref": "PurchaseCancelRefusalReason"
2171
+ },
2172
+ "readonly": true,
2173
+ "optional": false
2174
+ }
2175
+ }
2176
+ },
2177
+ "PurchaseCancelResponse": {
2178
+ "kind": "alias",
2179
+ "of": {
2180
+ "union": [
2181
+ {
2182
+ "ref": "PurchaseCancelled"
2183
+ },
2184
+ {
2185
+ "ref": "PurchaseCancelRefused"
2186
+ }
2187
+ ]
2188
+ }
2189
+ },
2190
+ "PurchaseCancelled": {
2191
+ "kind": "object",
2192
+ "properties": {
2193
+ "outcome": {
2194
+ "type": {
2195
+ "literal": "cancelled"
2196
+ },
2197
+ "readonly": true,
2198
+ "optional": false
2199
+ },
2200
+ "purchaseId": {
2201
+ "type": {
2202
+ "scalar": "string"
2203
+ },
2204
+ "readonly": true,
2205
+ "optional": false
2206
+ },
2207
+ "status": {
2208
+ "type": {
2209
+ "literal": "cancelled"
2210
+ },
2211
+ "readonly": true,
2212
+ "optional": false
2213
+ },
2214
+ "cents": {
2215
+ "type": {
2216
+ "ref": "Cents"
2217
+ },
2218
+ "readonly": true,
2219
+ "optional": false
2220
+ },
2221
+ "publishedValuePence": {
2222
+ "type": {
2223
+ "scalar": "number"
2224
+ },
2225
+ "readonly": true,
2226
+ "optional": false
2227
+ }
2228
+ }
2229
+ },
2230
+ "PurchaseFailureReason": {
2231
+ "kind": "alias",
2232
+ "of": {
2233
+ "union": [
2234
+ {
2235
+ "literal": "verification_refused"
2236
+ },
2237
+ {
2238
+ "literal": "card_declined"
2239
+ },
2240
+ {
2241
+ "literal": "ceiling_exceeded"
2242
+ },
2243
+ {
2244
+ "literal": "expired"
2245
+ },
2246
+ {
2247
+ "literal": "not_authorised_for_wallet"
2248
+ },
2249
+ {
2250
+ "literal": "gateway_unavailable"
2251
+ },
2252
+ {
2253
+ "literal": "not_provisioned"
2254
+ },
2255
+ {
2256
+ "literal": "amount_mismatch"
2257
+ },
2258
+ {
2259
+ "literal": "amount_not_priceable"
2260
+ },
2261
+ {
2262
+ "literal": "capture_failed"
2263
+ },
2264
+ {
2265
+ "literal": "holder_erased"
2266
+ }
2267
+ ]
2268
+ }
2269
+ },
2270
+ "PurchaseRefused": {
2271
+ "kind": "object",
2272
+ "properties": {
2273
+ "outcome": {
2274
+ "type": {
2275
+ "literal": "refused"
2276
+ },
2277
+ "readonly": true,
2278
+ "optional": false
2279
+ },
2280
+ "error": {
2281
+ "type": {
2282
+ "ref": "PurchaseFailureReason"
2283
+ },
2284
+ "readonly": true,
2285
+ "optional": false
2286
+ }
2287
+ }
2288
+ },
2289
+ "PurchaseRequest": {
2290
+ "kind": "object",
2291
+ "properties": {
2292
+ "sterlingPence": {
2293
+ "type": {
2294
+ "scalar": "number"
2295
+ },
2296
+ "readonly": true,
2297
+ "optional": false
2298
+ },
2299
+ "idempotencyKey": {
2300
+ "type": {
2301
+ "scalar": "string"
2302
+ },
2303
+ "readonly": true,
2304
+ "optional": false
2305
+ },
2306
+ "onBehalfOfWalletId": {
2307
+ "type": {
2308
+ "scalar": "string"
2309
+ },
2310
+ "readonly": true,
2311
+ "optional": true
2312
+ }
2313
+ }
2314
+ },
2315
+ "PurchaseResult": {
2316
+ "kind": "object",
2317
+ "properties": {
2318
+ "purchaseId": {
2319
+ "type": {
2320
+ "scalar": "string"
2321
+ },
2322
+ "readonly": true,
2323
+ "optional": false
2324
+ },
2325
+ "status": {
2326
+ "type": {
2327
+ "ref": "PurchaseStatus"
2328
+ },
2329
+ "readonly": true,
2330
+ "optional": false
2331
+ },
2332
+ "cents": {
2333
+ "type": {
2334
+ "ref": "Cents"
2335
+ },
2336
+ "readonly": true,
2337
+ "optional": true
2338
+ },
2339
+ "publishedValuePence": {
2340
+ "type": {
2341
+ "scalar": "number"
2342
+ },
2343
+ "readonly": true,
2344
+ "optional": true
2345
+ },
2346
+ "failureReason": {
2347
+ "type": {
2348
+ "ref": "PurchaseFailureReason"
2349
+ },
2350
+ "readonly": true,
2351
+ "optional": true
2352
+ }
2353
+ }
2354
+ },
2355
+ "PurchaseStatus": {
2356
+ "kind": "alias",
2357
+ "of": {
2358
+ "union": [
2359
+ {
2360
+ "ref": "LivePurchaseStatus"
2361
+ },
2362
+ {
2363
+ "ref": "TerminalPurchaseStatus"
2364
+ }
2365
+ ]
2366
+ }
2367
+ },
2368
+ "PurchaseTerminal": {
2369
+ "kind": "object",
2370
+ "properties": {
2371
+ "outcome": {
2372
+ "type": {
2373
+ "literal": "terminal"
2374
+ },
2375
+ "readonly": true,
2376
+ "optional": false
2377
+ },
2378
+ "purchaseId": {
2379
+ "type": {
2380
+ "scalar": "string"
2381
+ },
2382
+ "readonly": true,
2383
+ "optional": false
2384
+ },
2385
+ "status": {
2386
+ "type": {
2387
+ "ref": "TerminalPurchaseStatus"
2388
+ },
2389
+ "readonly": true,
2390
+ "optional": false
2391
+ },
2392
+ "cents": {
2393
+ "type": {
2394
+ "ref": "Cents"
2395
+ },
2396
+ "readonly": true,
2397
+ "optional": false
2398
+ },
2399
+ "publishedValuePence": {
2400
+ "type": {
2401
+ "scalar": "number"
2402
+ },
2403
+ "readonly": true,
2404
+ "optional": false
2405
+ },
2406
+ "failureReason": {
2407
+ "type": {
2408
+ "union": [
2409
+ {
2410
+ "ref": "PurchaseFailureReason"
2411
+ },
2412
+ {
2413
+ "null": true
2414
+ }
2415
+ ]
2416
+ },
2417
+ "readonly": true,
2418
+ "optional": false
2419
+ }
2420
+ }
2421
+ },
2422
+ "PurchaseUnresolved": {
2423
+ "kind": "object",
2424
+ "properties": {
2425
+ "outcome": {
2426
+ "type": {
2427
+ "literal": "unresolved"
2428
+ },
2429
+ "readonly": true,
2430
+ "optional": false
2431
+ },
2432
+ "purchaseId": {
2433
+ "type": {
2434
+ "scalar": "string"
2435
+ },
2436
+ "readonly": true,
2437
+ "optional": false
2438
+ },
2439
+ "status": {
2440
+ "type": {
2441
+ "literal": "issued_uncaptured"
2442
+ },
2443
+ "readonly": true,
2444
+ "optional": false
2445
+ },
2446
+ "cents": {
2447
+ "type": {
2448
+ "ref": "Cents"
2449
+ },
2450
+ "readonly": true,
2451
+ "optional": false
2452
+ },
2453
+ "publishedValuePence": {
2454
+ "type": {
2455
+ "scalar": "number"
2456
+ },
2457
+ "readonly": true,
2458
+ "optional": false
2459
+ }
2460
+ }
2461
+ },
2462
+ "Quote": {
2463
+ "kind": "object",
2464
+ "properties": {
2465
+ "quoteId": {
2466
+ "type": {
2467
+ "scalar": "string"
2468
+ },
2469
+ "readonly": true,
2470
+ "optional": false
2471
+ },
2472
+ "side": {
2473
+ "type": {
2474
+ "ref": "QuoteSide"
2475
+ },
2476
+ "readonly": true,
2477
+ "optional": false
2478
+ },
2479
+ "limitPricePence": {
2480
+ "type": {
2481
+ "scalar": "number"
2482
+ },
2483
+ "readonly": true,
2484
+ "optional": false
2485
+ },
2486
+ "sizeQuoteUnits": {
2487
+ "type": {
2488
+ "scalar": "number"
2489
+ },
2490
+ "readonly": true,
2491
+ "optional": false
2492
+ },
2493
+ "placedAt": {
2494
+ "type": {
2495
+ "ref": "Millis"
2496
+ },
2497
+ "readonly": true,
2498
+ "optional": false
2499
+ },
2500
+ "expiresAt": {
2501
+ "type": {
2502
+ "ref": "Millis"
2503
+ },
2504
+ "readonly": true,
2505
+ "optional": false
2506
+ }
2507
+ }
2508
+ },
2509
+ "QuoteEntryRefusal": {
2510
+ "kind": "alias",
2511
+ "of": {
2512
+ "union": [
2513
+ {
2514
+ "literal": "assurance_not_money_grade"
2515
+ },
2516
+ {
2517
+ "literal": "wallet_not_a_citizens"
2518
+ },
2519
+ {
2520
+ "literal": "wallet_has_no_live_binding"
2521
+ },
2522
+ {
2523
+ "literal": "size_not_whole_quote_units"
2524
+ },
2525
+ {
2526
+ "literal": "price_not_whole_ticks"
2527
+ },
2528
+ {
2529
+ "literal": "price_below_floor_reference"
2530
+ },
2531
+ {
2532
+ "literal": "price_above_published_value"
2533
+ },
2534
+ {
2535
+ "literal": "unrestricted_cents_insufficient"
2536
+ },
2537
+ {
2538
+ "literal": "quote_would_cross_own_quote"
2539
+ },
2540
+ {
2541
+ "literal": "quote_size_above_limit"
2542
+ },
2543
+ {
2544
+ "literal": "resting_quotes_at_limit"
2545
+ },
2546
+ {
2547
+ "literal": "quote_rate_limit_reached"
2548
+ },
2549
+ {
2550
+ "literal": "holder_volume_limit_reached"
2551
+ },
2552
+ {
2553
+ "literal": "published_value_unavailable"
2554
+ }
2555
+ ]
2556
+ }
2557
+ },
2558
+ "QuotePlaced": {
2559
+ "kind": "object",
2560
+ "properties": {
2561
+ "outcome": {
2562
+ "type": {
2563
+ "literal": "placed"
2564
+ },
2565
+ "readonly": true,
2566
+ "optional": false
2567
+ },
2568
+ "quote": {
2569
+ "type": {
2570
+ "ref": "Quote"
2571
+ },
2572
+ "readonly": true,
2573
+ "optional": false
2574
+ }
2575
+ }
2576
+ },
2577
+ "QuotePlacementRefusal": {
2578
+ "kind": "alias",
2579
+ "of": {
2580
+ "union": [
2581
+ {
2582
+ "ref": "QuoteEntryRefusal"
2583
+ },
2584
+ {
2585
+ "literal": "idempotency_key_reused_for_a_different_quote"
2586
+ },
2587
+ {
2588
+ "literal": "sterling_leg_unavailable"
2589
+ }
2590
+ ]
2591
+ }
2592
+ },
2593
+ "QuoteRefused": {
2594
+ "kind": "object",
2595
+ "properties": {
2596
+ "outcome": {
2597
+ "type": {
2598
+ "literal": "refused"
2599
+ },
2600
+ "readonly": true,
2601
+ "optional": false
2602
+ },
2603
+ "error": {
2604
+ "type": {
2605
+ "ref": "QuotePlacementRefusal"
2606
+ },
2607
+ "readonly": true,
2608
+ "optional": false
2609
+ }
2610
+ }
2611
+ },
2612
+ "QuoteRequest": {
2613
+ "kind": "object",
2614
+ "properties": {
2615
+ "side": {
2616
+ "type": {
2617
+ "ref": "QuoteSide"
2618
+ },
2619
+ "readonly": true,
2620
+ "optional": false
2621
+ },
2622
+ "limitPricePence": {
2623
+ "type": {
2624
+ "scalar": "number"
2625
+ },
2626
+ "readonly": true,
2627
+ "optional": false
2628
+ },
2629
+ "sizeQuoteUnits": {
2630
+ "type": {
2631
+ "scalar": "number"
2632
+ },
2633
+ "readonly": true,
2634
+ "optional": false
2635
+ },
2636
+ "idempotencyKey": {
2637
+ "type": {
2638
+ "scalar": "string"
2639
+ },
2640
+ "readonly": true,
2641
+ "optional": false
2642
+ }
2643
+ }
2644
+ },
2645
+ "QuoteResponse": {
2646
+ "kind": "alias",
2647
+ "of": {
2648
+ "union": [
2649
+ {
2650
+ "ref": "QuotePlaced"
2651
+ },
2652
+ {
2653
+ "ref": "QuoteRefused"
2654
+ }
2655
+ ]
2656
+ }
2657
+ },
2658
+ "QuoteSide": {
2659
+ "kind": "alias",
2660
+ "of": {
2661
+ "union": [
2662
+ {
2663
+ "literal": "bid"
2664
+ },
2665
+ {
2666
+ "literal": "ask"
2667
+ }
2668
+ ]
2669
+ }
2670
+ },
2671
+ "QuoteStatus": {
2672
+ "kind": "alias",
2673
+ "of": {
2674
+ "union": [
2675
+ {
2676
+ "literal": "resting"
2677
+ },
2678
+ {
2679
+ "literal": "filled"
2680
+ },
2681
+ {
2682
+ "literal": "withdrawn"
2683
+ },
2684
+ {
2685
+ "literal": "expired"
2686
+ }
2687
+ ]
2688
+ }
2689
+ },
2690
+ "QuoteWithdrawal": {
2691
+ "kind": "object",
2692
+ "properties": {
2693
+ "quoteId": {
2694
+ "type": {
2695
+ "scalar": "string"
2696
+ },
2697
+ "readonly": true,
2698
+ "optional": false
2699
+ },
2700
+ "withdrawnQuoteUnits": {
2701
+ "type": {
2702
+ "scalar": "number"
2703
+ },
2704
+ "readonly": true,
2705
+ "optional": false
2706
+ },
2707
+ "withdrawnAt": {
2708
+ "type": {
2709
+ "ref": "Millis"
2710
+ },
2711
+ "readonly": true,
2712
+ "optional": false
2713
+ }
2714
+ }
2715
+ },
2716
+ "QuoteWithdrawalReason": {
2717
+ "kind": "alias",
2718
+ "of": {
2719
+ "union": [
2720
+ {
2721
+ "literal": "holder_withdrew"
2722
+ },
2723
+ {
2724
+ "literal": "below_floor_reference"
2725
+ },
2726
+ {
2727
+ "literal": "no_live_binding"
2728
+ },
2729
+ {
2730
+ "literal": "authorisation_refused"
2731
+ }
2732
+ ]
2733
+ }
2734
+ },
2735
+ "QuoteWithdrawalRefusal": {
2736
+ "kind": "alias",
2737
+ "of": {
2738
+ "union": [
2739
+ {
2740
+ "literal": "assurance_not_money_grade"
2741
+ },
2742
+ {
2743
+ "literal": "wallet_has_no_live_binding"
2744
+ },
2745
+ {
2746
+ "literal": "quote_not_found"
2747
+ },
2748
+ {
2749
+ "literal": "quote_not_resting"
2750
+ },
2751
+ {
2752
+ "literal": "quote_minimum_resting_time_not_reached"
2753
+ }
2754
+ ]
2755
+ }
2756
+ },
2757
+ "QuoteWithdrawalRefused": {
2758
+ "kind": "object",
2759
+ "properties": {
2760
+ "outcome": {
2761
+ "type": {
2762
+ "literal": "refused"
2763
+ },
2764
+ "readonly": true,
2765
+ "optional": false
2766
+ },
2767
+ "error": {
2768
+ "type": {
2769
+ "ref": "QuoteWithdrawalRefusal"
2770
+ },
2771
+ "readonly": true,
2772
+ "optional": false
2773
+ }
2774
+ }
2775
+ },
2776
+ "QuoteWithdrawalRequest": {
2777
+ "kind": "object",
2778
+ "properties": {
2779
+ "quoteId": {
2780
+ "type": {
2781
+ "scalar": "string"
2782
+ },
2783
+ "readonly": true,
2784
+ "optional": false
2785
+ }
2786
+ }
2787
+ },
2788
+ "QuoteWithdrawalResponse": {
2789
+ "kind": "alias",
2790
+ "of": {
2791
+ "union": [
2792
+ {
2793
+ "ref": "QuoteWithdrawn"
2794
+ },
2795
+ {
2796
+ "ref": "QuoteWithdrawalRefused"
2797
+ }
2798
+ ]
2799
+ }
2800
+ },
2801
+ "QuoteWithdrawn": {
2802
+ "kind": "object",
2803
+ "properties": {
2804
+ "outcome": {
2805
+ "type": {
2806
+ "literal": "withdrawn"
2807
+ },
2808
+ "readonly": true,
2809
+ "optional": false
2810
+ },
2811
+ "withdrawal": {
2812
+ "type": {
2813
+ "ref": "QuoteWithdrawal"
2814
+ },
2815
+ "readonly": true,
2816
+ "optional": false
2817
+ }
2818
+ }
2819
+ },
2820
+ "ScopeKey": {
2821
+ "kind": "alias",
2822
+ "of": {
2823
+ "union": [
2824
+ {
2825
+ "ref": "ContractOperation"
2826
+ },
2827
+ {
2828
+ "ref": "InternalOperation"
2829
+ }
2830
+ ]
2831
+ }
2832
+ },
2833
+ "SignUpGrant": {
2834
+ "kind": "object",
2835
+ "properties": {
2836
+ "movementId": {
2837
+ "type": {
2838
+ "scalar": "string"
2839
+ },
2840
+ "readonly": true,
2841
+ "optional": false
2842
+ },
2843
+ "cents": {
2844
+ "type": {
2845
+ "ref": "Cents"
2846
+ },
2847
+ "readonly": true,
2848
+ "optional": false
2849
+ },
2850
+ "restriction": {
2851
+ "type": {
2852
+ "literal": "restricted"
2853
+ },
2854
+ "readonly": true,
2855
+ "optional": false
2856
+ },
2857
+ "expiresAt": {
2858
+ "type": {
2859
+ "ref": "Millis"
2860
+ },
2861
+ "readonly": true,
2862
+ "optional": false
2863
+ },
2864
+ "grantedAt": {
2865
+ "type": {
2866
+ "ref": "Millis"
2867
+ },
2868
+ "readonly": true,
2869
+ "optional": false
2870
+ }
2871
+ }
2872
+ },
2873
+ "SignUpGrantTerms": {
2874
+ "kind": "object",
2875
+ "properties": {
2876
+ "cents": {
2877
+ "type": {
2878
+ "ref": "Cents"
2879
+ },
2880
+ "readonly": true,
2881
+ "optional": false
2882
+ },
2883
+ "restrictionMonths": {
2884
+ "type": {
2885
+ "scalar": "number"
2886
+ },
2887
+ "readonly": true,
2888
+ "optional": false
2889
+ }
2890
+ }
2891
+ },
2892
+ "StoreSignedStatement": {
2893
+ "kind": "object",
2894
+ "properties": {
2895
+ "statement": {
2896
+ "type": {
2897
+ "scalar": "string"
2898
+ },
2899
+ "readonly": true,
2900
+ "optional": false
2901
+ },
2902
+ "signature": {
2903
+ "type": {
2904
+ "scalar": "string"
2905
+ },
2906
+ "readonly": true,
2907
+ "optional": false
2908
+ }
2909
+ }
2910
+ },
2911
+ "SubjectPersonhood": {
2912
+ "kind": "alias",
2913
+ "of": {
2914
+ "union": [
2915
+ {
2916
+ "literal": "natural-person"
2917
+ },
2918
+ {
2919
+ "literal": "shared-credential"
2920
+ }
2921
+ ]
2922
+ }
2923
+ },
2924
+ "TerminalPurchaseStatus": {
2925
+ "kind": "alias",
2926
+ "of": {
2927
+ "union": [
2928
+ {
2929
+ "literal": "succeeded"
2930
+ },
2931
+ {
2932
+ "literal": "failed"
2933
+ },
2934
+ {
2935
+ "literal": "cancelled"
2936
+ }
2937
+ ]
2938
+ }
2939
+ },
2940
+ "ThirdPartyRefundReceiptStatement": {
2941
+ "kind": "object",
2942
+ "properties": {
2943
+ "movementKind": {
2944
+ "type": {
2945
+ "literal": "marketplace_refund"
2946
+ },
2947
+ "readonly": true,
2948
+ "optional": false
2949
+ },
2950
+ "saleKind": {
2951
+ "type": {
2952
+ "literal": "third-party"
2953
+ },
2954
+ "readonly": true,
2955
+ "optional": false
2956
+ },
2957
+ "movementId": {
2958
+ "type": {
2959
+ "scalar": "string"
2960
+ },
2961
+ "readonly": true,
2962
+ "optional": false
2963
+ },
2964
+ "orderDigest": {
2965
+ "type": {
2966
+ "scalar": "string"
2967
+ },
2968
+ "readonly": true,
2969
+ "optional": false
2970
+ },
2971
+ "idempotencyKey": {
2972
+ "type": {
2973
+ "scalar": "string"
2974
+ },
2975
+ "readonly": true,
2976
+ "optional": false
2977
+ },
2978
+ "buyerWalletId": {
2979
+ "type": {
2980
+ "scalar": "string"
2981
+ },
2982
+ "readonly": true,
2983
+ "optional": false
2984
+ },
2985
+ "publisherLeg": {
2986
+ "type": {
2987
+ "ref": "MarketplaceReceiptLeg"
2988
+ },
2989
+ "readonly": true,
2990
+ "optional": false
2991
+ },
2992
+ "communityLeg": {
2993
+ "type": {
2994
+ "ref": "MarketplaceReceiptLeg"
2995
+ },
2996
+ "readonly": true,
2997
+ "optional": false
2998
+ },
2999
+ "allocationPolicyVersion": {
3000
+ "type": {
3001
+ "scalar": "string"
3002
+ },
3003
+ "readonly": true,
3004
+ "optional": false
3005
+ },
3006
+ "writtenAt": {
3007
+ "type": {
3008
+ "ref": "Millis"
3009
+ },
3010
+ "readonly": true,
3011
+ "optional": false
3012
+ },
3013
+ "keyId": {
3014
+ "type": {
3015
+ "ref": "MarketplaceReceiptKeyId"
3016
+ },
3017
+ "readonly": true,
3018
+ "optional": false
3019
+ }
3020
+ }
3021
+ },
3022
+ "VerificationMethod": {
3023
+ "kind": "alias",
3024
+ "of": {
3025
+ "union": [
3026
+ {
3027
+ "literal": "dev-bypass"
3028
+ },
3029
+ {
3030
+ "literal": "document"
3031
+ },
3032
+ {
3033
+ "literal": "document-and-biometric"
3034
+ }
3035
+ ]
3036
+ }
3037
+ },
3038
+ "VerificationStatus": {
3039
+ "kind": "alias",
3040
+ "of": {
3041
+ "union": [
3042
+ {
3043
+ "literal": "unverified"
3044
+ },
3045
+ {
3046
+ "literal": "verified"
3047
+ }
3048
+ ]
3049
+ }
3050
+ },
3051
+ "WalletRecord": {
3052
+ "kind": "object",
3053
+ "properties": {
3054
+ "walletId": {
3055
+ "type": {
3056
+ "scalar": "string"
3057
+ },
3058
+ "readonly": true,
3059
+ "optional": false
3060
+ },
3061
+ "holderType": {
3062
+ "type": {
3063
+ "ref": "HolderType"
3064
+ },
3065
+ "readonly": true,
3066
+ "optional": false
3067
+ },
3068
+ "createdAt": {
3069
+ "type": {
3070
+ "ref": "Millis"
3071
+ },
3072
+ "readonly": true,
3073
+ "optional": false
3074
+ }
3075
+ }
3076
+ },
3077
+ "WalletView": {
3078
+ "kind": "object",
3079
+ "properties": {
3080
+ "wallet": {
3081
+ "type": {
3082
+ "ref": "WalletRecord"
3083
+ },
3084
+ "readonly": true,
3085
+ "optional": false
3086
+ },
3087
+ "balance": {
3088
+ "type": {
3089
+ "ref": "Balance"
3090
+ },
3091
+ "readonly": true,
3092
+ "optional": false
3093
+ },
3094
+ "allowances": {
3095
+ "type": {
3096
+ "array": {
3097
+ "ref": "Allowance"
3098
+ },
3099
+ "readonly": true
3100
+ },
3101
+ "readonly": true,
3102
+ "optional": false
3103
+ }
3104
+ }
3105
+ }
3106
+ }
3107
+ };