-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger SA CIB Investec for Intermediaries Foreign Exchange API.json
2895 lines (2895 loc) · 77.1 KB
/
swagger SA CIB Investec for Intermediaries Foreign Exchange API.json
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.1",
"info": {
"title": "SA CIB Investec for Intermediaries Foreign Exchange API",
"description": "# Introduction\n The Forex Settlement API allows Investec Forex Intermediary clients to access trade details and provide settlement documentation (Balance of Payments (BOP) plus supporting documentation) via an API. This API allows you to access and manage the following BOP report actions: \n * Retrieve \n * Update \n * Validate \n * Supporting documents \n ## Getting started \n To start using the Forex Settlement API, you'll need API credentials which you can setup using your [Investec Online Profile](https://login.secure.investec.com/). Create a new API key (x-api-key) with the scopes you want it to access. \n \n Optionally, use the [OAuth-2 - Sandbox](#section/Authentication/OAuth-2-Sandbox) account and credentials to generate mock responses to test your applications. You can use the Sandbox account without the need to open an Investec account. \n ## Making a request\n To successfully submit a request ensure that you have a valid token which you can obtain using the authentication method. Add the token as an authentication header to your requests. \n\n ## Known issues\n\n Clarity on scenarios or field mapping confusion you might run into. \n\n **Report.locationCountry**: The location country field is to identify which country is involved in supplying/receiving a service or from which country goods were imported or to which country goods were exported. \n\n **Report. MonetaryAmount.locationCountry**: This indicates the country where the goods or services were procured or rendered. E.g. if importing from Germany it would be 'DE'.\n\n **Report.NonResident.Individual.Address.Country**: This cannot be 'ZA'. in cases where the actual value is ZA, using the country of the currency being paid is the correct approach.\n\n **Report.OriginatingCountry**: The country code of the originating bank (The bank from which the funds are being sent)\n\n **Report.ReceivingCountry**: The country code of the receiving bank (The bank to which the funds are being sent)\n\n **Report.Resident.Individual.TaxNumber**: We do run a SARS checksum validation on the TaxNumber provided. We will provide a warning (not an error) if the number provided does not validate successfully against the checksum. There are instances where a Tax number is valid but fails the checksum. \n\n **Report.counterpartyStatus**: This is the status of the Remitter or beneficiary (NonResident). The only valid values for this field are 'South African Resident' or 'Non Resident'. \n\n \n # Authentication\n The Investec For Intermediaries API supports both 3 Legged OAuth as well as OAuth 2. For making authenticated requests on behalf of your users we recommend using 3 Legged OAuth. For system-to-system integration we recommend the OAuth-2 flow.\n\n ## OAuth-2\n Follow instructions here `https://developer.investec.com/za/api-products/documentation/SA_Open_API_-_Authorization` \n\n ## OAuth-2-Sandbox \n\n To use the sandbox environment use the base url `https://openapisandbox.investec.com` for authentication and all subsequent api requests. \n\n Authenticating: \n* **Auth URL (POST):** `https://openapisandbox.investec.com/identity/v2/oauth2/token` \n* **header** `Authorization: Basic Z09VVlFab0ozQXlUejIyT0hjSVFBSkpMeklHMER5MVk6UnplNWNjSVNGNG1Gckdlaw==` \n* **header** `x-api-key: Z09VVlFab0ozQXlUejIyT0hjSVFBSkpMeklHMER5MVk6YVc1MlpYTjBaV010ZW1FdGFXWnBMV1p2Y21WNExXbHVkbVZ6ZEdWak0yeHZZUzF6WVc1a1ltOTQ=` \n* **header** `Content-Type: application/x-www-form-urlencoded` \n* **data-urlencode** `grant_type=client_credentials` \n\n The basic authorization header are as follows: \n\n *clientId:* `gOUVQZoJ3AyTz22OHcIQAJJLzIG0Dy1Y`\n\n *secret:* `Rze5ccISF4mFrGek` \n\n Eg. Base64-encode ( {clientId}:{secret} ) \n\n# Release Notes\n\n 2024-02-14\n\n* **Release**: Added Multiple Monetary Amounts allowing more than 1 sequence and SARB Authorization Code validation to allow for more Bulk reporting arrangements. Updated SDA forex allowances endpoint\n\n 2023-11-14\n\n* **Release**: Added support for Bulk reporting with SARB Approval. This allows the resident (applicant) data to be submitted via the API when the required SARB approval is in place and recorded on Investec's systems\n\n 2023-07-07\n\n* **Release**: Amended bop report request and response payloads to move the tax clearance certificate indicator to only the monetary amount section \n\n 2023-07-04\n\n* **Release**: Updated bop report request payload \n\n 2022-07-28\n\n* **Release**: First release deployed \n\n # Bulk Reporting\n\n For bulk reporting you are required to have a SARB Authorisation Application Number. This enables you to report offshore payments without the need to onboard the underlying client (applicant) with Investec. \n\n Reporting: \n\n Submit a PUT request on the [Update a single BOP report](#tag/BOP-Reports/paths/~1za~1ifi~1v1~1forex~1bop-reports~1%7BtransactionReference%7D/put) endpoint: \n* Enhance the \"resident\" object of the payload with your applicant data \n* **report.monetaryAmount.sarbAuth.sarbAuthAppNumber** = {YOUR_SARB_AUTHORISATION_APPLICATION_NUMBER} \n* **report.monetaryAmount.sarbAuth.sarbAuthDate** = {SARB_AUTH_DATE} \n* **report.monetaryAmount.sarbAuth.sarbAuthRefNumber** = {YOUR_SARB_AUTHORISATION_REFERENCE_NUMBER} \n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->",
"version": "1.0",
"termsOfService": "https://developer.investec.com/za/terms-of-use"
},
"servers": [
{
"url": "https://openapi.investec.com"
}
],
"paths": {
"/za/ifi/v1/forex/bop-reports": {
"get": {
"tags": [
"BOP Reports"
],
"summary": "Get BOP reports",
"description": "Retrieves all BOP reports for the specified list type",
"parameters": [
{
"name": "type",
"in": "query",
"required": true,
"schema": {
"enum": [
"all",
"New",
"Incomplete",
"DocsRequired",
"DocsReceived",
"Completed",
"Cancelled"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Collection of BOP report summary records",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportSummaryModelListSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/bop-reports/{transactionReference}": {
"get": {
"tags": [
"BOP Reports"
],
"summary": "Get BOP Report by transaction reference",
"description": "Retrieves BOP report details for the specified transaction reference",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "BOP report details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportDetailsQueryModelSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
},
"put": {
"tags": [
"BOP Reports"
],
"summary": "Update a single BOP report",
"description": "Updates a BOP report with the values provided",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/FxBopReportDetailsBulkReportingCommandModel"
},
{
"$ref": "#/components/schemas/FxBopReportDetailsCommandModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated the BOP report."
},
"400": {
"description": "A validation error has occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportValidationModelListSuccessResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/bop-reports/{transactionReference}/validation": {
"post": {
"tags": [
"BOP Reports"
],
"summary": "Validate BOP report details",
"description": "Simply validates the submitted BOP report details",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/FxBopReportDetailsBulkReportingCommandModel"
},
{
"$ref": "#/components/schemas/FxBopReportDetailsCommandModel"
}
]
}
}
}
},
"responses": {
"200": {
"description": "BOP report validation results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportValidationModelListSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/bop-reports/{transactionReference}/documents": {
"get": {
"tags": [
"BOP Reports"
],
"summary": "Get required documents by transaction reference",
"description": "Retrieves the collection of supporting documents required and attached to the BOP report",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "BOP report supporting documents",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportDocumentDetailsModelListSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/bop-reports/{transactionReference}/documents/{documentHandle}": {
"put": {
"tags": [
"BOP Reports"
],
"summary": "Upload file contents",
"description": "Upload file contents for the provided document handle",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentHandle",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Document contents successfully uploaded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportDocumentDetailsModelSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
},
"get": {
"tags": [
"BOP Reports"
],
"summary": "Get document by the document handle",
"description": "Retrieves the base64 encoded content of the supporting document identified by the document handle",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "documentHandle",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Base64 encoded content of supporting document",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportDocumentModelSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/bop-reports/{transactionReference}:{action}": {
"patch": {
"tags": [
"BOP Reports"
],
"summary": "Execute action on transaction",
"description": "Perfoms the specified action against the BOP report identified by the transaction reference",
"parameters": [
{
"name": "transactionReference",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "path",
"required": true,
"schema": {
"enum": [
"Approve"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The status of the BOP report identified by the transaction reference",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxBopReportStatusModelSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
},
"/za/ifi/v1/forex/allowances/{accountNo}/balance": {
"get": {
"tags": [
"Forex"
],
"summary": "Get FX allowance balance by account number",
"description": "Retrieves forex allowance balances for the provided account number",
"parameters": [
{
"name": "accountNo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Forex allowance balances",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FxAllowanceBalancesModelSuccessResponseModel"
}
}
}
},
"400": {
"description": "Request validation errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"bearer": []
}
]
}
}
},
"components": {
"schemas": {
"AddressCommandModel": {
"type": "object",
"properties": {
"addressLine2": {
"type": "string",
"nullable": true
},
"addressLine1": {
"type": "string",
"nullable": true
},
"suburb": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"province": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AddressQueryModel": {
"type": "object",
"properties": {
"addressLine2": {
"type": "string",
"nullable": true
},
"addressLine1": {
"type": "string",
"nullable": true
},
"suburb": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"province": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BeneficiaryBankCommandModel": {
"type": "object",
"properties": {
"swiftbic": {
"type": "string",
"nullable": true
},
"branchCode": {
"type": "string",
"nullable": true
},
"bankName": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BeneficiaryBankQueryModel": {
"type": "object",
"properties": {
"swiftbic": {
"type": "string",
"nullable": true
},
"branchCode": {
"type": "string",
"nullable": true
},
"bankName": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ContactDetailsCommandModel": {
"type": "object",
"properties": {
"contactSurname": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"telephone": {
"type": "string",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ContactDetailsQueryModel": {
"type": "object",
"properties": {
"contactSurname": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"telephone": {
"type": "string",
"nullable": true
},
"fax": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CorrespondentBankCommandModel": {
"type": "object",
"properties": {
"bankName": {
"type": "string",
"nullable": true
},
"swiftbic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CorrespondentBankQueryModel": {
"type": "object",
"properties": {
"bankName": {
"type": "string",
"nullable": true
},
"swiftbic": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FxAllowanceBalancesModel": {
"required": [
"limits",
"valueDate"
],
"type": "object",
"properties": {
"valueDate": {
"type": "string",
"format": "date-time"
},
"limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Limit"
}
}
},
"additionalProperties": false
},
"FxAllowanceBalancesModelSuccessResponseModel": {
"required": [
"data",
"links"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FxAllowanceBalancesModel"
}
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"nullable": true
},
"first": {
"type": "string",
"nullable": true
},
"last": {
"type": "string",
"nullable": true
},
"prev": {
"type": "string",
"nullable": true
},
"next": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"FxBopReportDetailsBulkReportingCommandModel": {
"type": "object",
"properties": {
"state": {
"type": "string",
"nullable": true
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/MetaCommandModel"
}
],
"nullable": true
},
"report": {
"allOf": [
{
"$ref": "#/components/schemas/ReportAllCommandModel"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FxBopReportDetailsCommandModel": {
"type": "object",
"properties": {
"state": {
"type": "string",
"nullable": true
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/MetaCommandModel"
}
],
"nullable": true
},
"report": {
"allOf": [
{
"$ref": "#/components/schemas/ReportCommandModel"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FxBopReportDetailsQueryModel": {
"required": [
"meta"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"nullable": true
},
"meta": {
"allOf": [
{
"$ref": "#/components/schemas/MetaQueryModel"
}
]
},
"report": {
"allOf": [
{
"$ref": "#/components/schemas/ReportQueryModel"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"FxBopReportDetailsQueryModelSuccessResponseModel": {
"required": [
"data",
"links"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FxBopReportDetailsQueryModel"
}
]
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"nullable": true
},
"first": {
"type": "string",
"nullable": true
},
"last": {
"type": "string",
"nullable": true
},
"prev": {
"type": "string",
"nullable": true
},
"next": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"FxBopReportDocumentDetailsModel": {
"type": "object",
"properties": {
"documentHandle": {
"type": "string",
"nullable": true
},
"scope": {
"type": "string",
"nullable": true
},
"reportingSpace": {
"type": "string",
"nullable": true
},
"transactionReference": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"uploaded": {
"type": "boolean",
"nullable": true
},
"acknowledged": {
"type": "boolean",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FxBopReportDocumentDetailsModelListSuccessResponseModel": {
"required": [
"data",
"links"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FxBopReportDocumentDetailsModel"
}
},
"links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"nullable": true
},
"first": {
"type": "string",