-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi3.0.json
19275 lines (19275 loc) · 574 KB
/
openapi3.0.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.0",
"servers": [
{
"url": "https://api.quickpay.net/docs/v10/"
}
],
"info": {
"title": "Quickpay API v10",
"version": "10.0",
"description": "<h2 id=\"authorization\">Authorization</h2>\n\nAuthorization is done using basic-auth. Authorization can be done with a user or an agreement.\n\n<ul>\n <li>When authorized with a user one is able to edit own settings, create new merchant or request access to existing merchant.</li>\n <li>When authorized with an agreement one is able to perform anything on the account that agreement gives permissions to.</li>\n</ul>\n\n",
"contact": {
"email": "[email protected]"
},
"termsOfService": "http://quickpay.net/terms"
},
"tags": [
{
"name": "account",
"description": "Operations about accounts"
},
{
"name": "acl-resources",
"description": "Operations about acl-resources"
},
{
"name": "acquirers",
"description": "Operations about acquirers"
},
{
"name": "activity",
"description": "Operations about activities"
},
{
"name": "agreements",
"description": "Operations about agreements"
},
{
"name": "brandings",
"description": "Operations about brandings"
},
{
"name": "cards",
"description": "Operations about cards"
},
{
"name": "changelog",
"description": "Operations about changelogs"
},
{
"name": "cryptography",
"description": "Operations about cryptographies"
},
{
"name": "fees",
"description": "Operations about fees"
},
{
"name": "fraud-rulesets",
"description": "Operations about fraud-rulesets"
},
{
"name": "operational-status",
"description": "Operations about operational-statuses"
},
{
"name": "payment-method-priority",
"description": "Operations about payment-method-priorities"
},
{
"name": "payments",
"description": "Operations about payments"
},
{
"name": "payouts",
"description": "Operations about payouts"
},
{
"name": "ping",
"description": "Operations about pings"
},
{
"name": "subscription-groups",
"description": "Operations about subscription-groups"
},
{
"name": "subscriptions",
"description": "Operations about subscriptions"
}
],
"paths": {
"/account": {
"get": {
"tags": [
"account"
],
"operationId": "GET-account---format-",
"summary": "Get merchant account",
"description": "\n",
"parameters": [
{
"in": "header",
"description": "Specify the version of the API\n",
"name": "Accept-Version",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"description": "Use Basic Auth to authorize to the API\n",
"name": "Authorization",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
}
}
},
"403": {
"description": "Not authorized"
}
}
},
"patch": {
"tags": [
"account"
],
"operationId": "PATCH-account---format-",
"summary": "Update merchant account",
"description": "\n",
"parameters": [
{
"in": "header",
"description": "Specify the version of the API\n",
"name": "Accept-Version",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"description": "Use Basic Auth to authorize to the API\n",
"name": "Authorization",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Merchant"
}
}
}
},
"400": {
"description": "Invalid parameters"
},
"403": {
"description": "Not authorized"
}
},
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"customer_address[name]": {
"description": "Name\n",
"type": "string"
},
"customer_address[att]": {
"description": "Att\n",
"type": "string"
},
"customer_address[street]": {
"description": "Street\n",
"type": "string"
},
"customer_address[city]": {
"description": "City\n",
"type": "string"
},
"customer_address[zip_code]": {
"description": "Zip code\n",
"type": "string"
},
"customer_address[region]": {
"description": "Region\n",
"type": "string"
},
"customer_address[country_code]": {
"description": "Three letter country code according to ISO 3166-1 Alpha-3\n",
"type": "string"
},
"customer_address[vat_no]": {
"description": "VAT registration number\n",
"type": "string"
},
"billing_address[name]": {
"description": "Name\n",
"type": "string"
},
"billing_address[att]": {
"description": "Att\n",
"type": "string"
},
"billing_address[street]": {
"description": "Street\n",
"type": "string"
},
"billing_address[city]": {
"description": "City\n",
"type": "string"
},
"billing_address[zip_code]": {
"description": "Zip code\n",
"type": "string"
},
"billing_address[region]": {
"description": "Region\n",
"type": "string"
},
"billing_address[country_code]": {
"description": "Three letter country code according to ISO 3166-1 Alpha-3\n",
"type": "string"
},
"billing_address[vat_no]": {
"description": "VAT registration number\n",
"type": "string"
},
"callback_url": {
"description": "Callback url\n",
"type": "string"
},
"acquirer_settings[bambora][active]": {
"description": "Enable Bambora payments\n",
"type": "boolean"
},
"acquirer_settings[bambora][identification_code]": {
"description": "Bambora identification number\n",
"type": "string"
},
"acquirer_settings[bambora][identification_code_int]": {
"description": "Bambora international identification number\n",
"type": "string"
},
"acquirer_settings[bambora][business_code]": {
"description": "Business code (assigned by Bambora)\n",
"type": "string"
},
"acquirer_settings[bambora][recurring]": {
"description": "Enable recurring payments (requires agreement with Bambora)\n",
"type": "boolean"
},
"acquirer_settings[bambora][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Bambora)\n",
"type": "boolean"
},
"acquirer_settings[bambora][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Bambora)\n",
"type": "boolean"
},
"acquirer_settings[bambora][securepay]": {
"description": "Enable SecurePay fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[bambora][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[bambora][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[bambora][visa_bin]": {
"description": "VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[bambora][mastercard_bin]": {
"description": "Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[clearhaus][active]": {
"description": "Enable ClearHaus payments\n",
"type": "boolean"
},
"acquirer_settings[clearhaus][api_key]": {
"description": "Clearhaus API key (is required but may be left empty)\n",
"type": "string"
},
"acquirer_settings[clearhaus][recurring]": {
"description": "Enable recurring payments (requires agreement with Clearhaus)\n",
"type": "boolean"
},
"acquirer_settings[clearhaus][payout]": {
"description": "Enable payouts (requires agreement with Clearhaus)\n",
"type": "boolean"
},
"acquirer_settings[clearhaus][apple_pay]": {
"description": "Enable Apple Pay (requires agreement with Clearhaus)\n",
"type": "boolean"
},
"acquirer_settings[elavon][active]": {
"description": "Enable Elavon payments\n",
"type": "boolean"
},
"acquirer_settings[elavon][identification_code]": {
"description": "Elavon identification number\n",
"type": "string"
},
"acquirer_settings[elavon][identification_code_int]": {
"description": "Elavon international identification number\n",
"type": "string"
},
"acquirer_settings[elavon][business_code]": {
"description": "Business code (assigned by Elavon)\n",
"type": "string"
},
"acquirer_settings[elavon][recurring]": {
"description": "Enable recurring payments (requires agreement with Elavon)\n",
"type": "boolean"
},
"acquirer_settings[elavon][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Elavon)\n",
"type": "boolean"
},
"acquirer_settings[elavon][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Elavon)\n",
"type": "boolean"
},
"acquirer_settings[elavon][securepay]": {
"description": "Enable SecurePay fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[elavon][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[elavon][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[elavon][visa_bin]": {
"description": "VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[elavon][mastercard_bin]": {
"description": "Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[handelsbanken][active]": {
"description": "Enable Handelsbanken payments\n",
"type": "boolean"
},
"acquirer_settings[handelsbanken][identification_code]": {
"description": "Handelsbanken identification number\n",
"type": "string"
},
"acquirer_settings[handelsbanken][identification_code_int]": {
"description": "Handelsbanken international identification number\n",
"type": "string"
},
"acquirer_settings[handelsbanken][business_code]": {
"description": "Business code (assigned by Handelsbanken)\n",
"type": "string"
},
"acquirer_settings[handelsbanken][recurring]": {
"description": "Enable recurring payments (requires agreement with Handelsbanken)\n",
"type": "boolean"
},
"acquirer_settings[handelsbanken][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Handelsbanken)\n",
"type": "boolean"
},
"acquirer_settings[handelsbanken][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Handelsbanken)\n",
"type": "boolean"
},
"acquirer_settings[handelsbanken][securepay]": {
"description": "Enable SecurePay fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[handelsbanken][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[handelsbanken][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[handelsbanken][visa_bin]": {
"description": "VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[handelsbanken][mastercard_bin]": {
"description": "Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[klarna][active]": {
"description": "Enable Klarna payments\n",
"type": "boolean"
},
"acquirer_settings[klarna][eid]": {
"description": "Klarna merchant ID\n",
"type": "integer",
"format": "int32"
},
"acquirer_settings[klarna][shared_secret]": {
"description": "Klarna shared secret\n",
"type": "string"
},
"acquirer_settings[mobilepay][active]": {
"description": "Enable MobilePay payments\n",
"type": "boolean"
},
"acquirer_settings[mobilepay][delivery_limited_to]": {
"description": "Limit MobilePay delivery address selection to theses countries. (ISO 3166-1 alpha-2 without delimiter ‘DKNOSEFI’) (Valid options are DK,NO,SE,FI)\n",
"type": "string"
},
"acquirer_settings[mobilepaysubscriptions][active]": {
"description": "Enable MobilePay Subscriptions payments\n",
"type": "boolean"
},
"acquirer_settings[mobilepaysubscriptions][auth_state]": {
"description": "Identifier MobilePay Subscriptions uses to link requests to callbacks\n",
"type": "string"
},
"acquirer_settings[mobilepaysubscriptions][code_verifier]": {
"description": "Verifies received code challenge\n",
"type": "string"
},
"acquirer_settings[mobilepaysubscriptions][last_token_refresh]": {
"description": "Unix Timestamp of last time the tokens were refreshed\n",
"type": "integer",
"format": "int32"
},
"acquirer_settings[mobilepaysubscriptions][nonce]": {
"description": "Associate client sessions with ID Tokens to mitigate replay attacks\n",
"type": "string"
},
"acquirer_settings[mobilepaysubscriptions][pending_status]": {
"description": "0: agreement inactive, 1: flow initialised, 2: tokens received, 3: flow completed\n",
"type": "integer",
"format": "int32",
"default": 0
},
"acquirer_settings[mobilepaysubscriptions][provider]": {
"description": "The provider / sales-place chosen by the merchant\n",
"type": "string"
},
"acquirer_settings[mobilepaysubscriptions][refresh_token]": {
"description": "Token to refresh access token for up to 1 year\n",
"type": "string"
},
"acquirer_settings[nets][active]": {
"description": "Enable Nets/Teller payments\n",
"type": "boolean"
},
"acquirer_settings[nets][identification_code]": {
"description": "Nets TOF number\n",
"type": "string"
},
"acquirer_settings[nets][business_code]": {
"description": "Business code (assigned by Nets)\n",
"type": "string"
},
"acquirer_settings[nets][recurring]": {
"description": "Enable recurring payments (requires agreement with Nets)\n",
"type": "boolean"
},
"acquirer_settings[nets][fbg1886]": {
"description": "Enable Forbrugsforeningen payments (requires agreement with Nets and Forbrugsforeningen)\n",
"type": "boolean"
},
"acquirer_settings[nets][secured_by_nets]": {
"description": "Enable SecuredByNets fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[nets][identification_code_int]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "string"
},
"acquirer_settings[nets][americanexpress]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "boolean"
},
"acquirer_settings[nets][dinersclub]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "boolean"
},
"acquirer_settings[nets][securepay]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "boolean",
"default": true
},
"acquirer_settings[nets][visa_bin]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "string"
},
"acquirer_settings[nets][mastercard_bin]": {
"description": "(Depricated; use Teller acquirer)\n",
"type": "string"
},
"acquirer_settings[paypal][active]": {
"description": "Enable PayPal payments\n",
"type": "boolean"
},
"acquirer_settings[paypal][recurring]": {
"description": "Enable recurring payments\n",
"type": "boolean"
},
"acquirer_settings[paypal][credit_card]": {
"description": "Allow credit-card payments. (Only for US/CA/UK merchants)\n",
"type": "boolean"
},
"acquirer_settings[paypal][token]": {
"description": "Authentication token\n",
"type": "string"
},
"acquirer_settings[paypal][token_secret]": {
"description": "Authentication token secret\n",
"type": "string"
},
"acquirer_settings[paypal][scope]": {
"description": "Authentication scope\n",
"type": "string"
},
"acquirer_settings[sofort][active]": {
"description": "Enable Sofort payments\n",
"type": "boolean"
},
"acquirer_settings[sofort][customer_number]": {
"description": "Sofort customer number\n",
"type": "integer",
"format": "int32"
},
"acquirer_settings[sofort][project_id]": {
"description": "Sofort Gateway project id\n",
"type": "integer",
"format": "int32"
},
"acquirer_settings[sofort][api_key]": {
"description": "Sofort API key\n",
"type": "string"
},
"acquirer_settings[sofort][gateway]": {
"description": "Enable Sofort Gateway feature\n",
"type": "boolean",
"default": true
},
"acquirer_settings[sofort][ideal]": {
"description": "Enable Sofort iDeal feature\n",
"type": "boolean"
},
"acquirer_settings[sofort][ideal_project_id]": {
"description": "Sofort iDeal project id\n",
"type": "integer",
"format": "int32"
},
"acquirer_settings[sofort][ideal_project_password]": {
"description": "Sofort iDeal project password\n",
"type": "string"
},
"acquirer_settings[sofort][ideal_notification_password]": {
"description": "Sofort iDeal notification password\n",
"type": "string"
},
"acquirer_settings[swedbank][active]": {
"description": "Enable Swedbank payments\n",
"type": "boolean"
},
"acquirer_settings[swedbank][identification_code]": {
"description": "Swedbank identification number\n",
"type": "string"
},
"acquirer_settings[swedbank][identification_code_int]": {
"description": "Swedbank international identification number\n",
"type": "string"
},
"acquirer_settings[swedbank][business_code]": {
"description": "Business code (assigned by Swedbank)\n",
"type": "string"
},
"acquirer_settings[swedbank][recurring]": {
"description": "Enable recurring payments (requires agreement with Swedbank)\n",
"type": "boolean"
},
"acquirer_settings[swedbank][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Swedbank)\n",
"type": "boolean"
},
"acquirer_settings[swedbank][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Swedbank)\n",
"type": "boolean"
},
"acquirer_settings[swedbank][securepay]": {
"description": "Enable SecurePay fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[swedbank][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[swedbank][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[swedbank][visa_bin]": {
"description": "VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[swedbank][mastercard_bin]": {
"description": "Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[teller][active]": {
"description": "Enable Teller payments\n",
"type": "boolean"
},
"acquirer_settings[teller][identification_code]": {
"description": "Teller TOF number\n",
"type": "string"
},
"acquirer_settings[teller][identification_code_int]": {
"description": "Teller international identification number\n",
"type": "string"
},
"acquirer_settings[teller][business_code]": {
"description": "Business code (assigned by Teller)\n",
"type": "string"
},
"acquirer_settings[teller][recurring]": {
"description": "Enable recurring payments (requires agreement with Teller)\n",
"type": "boolean"
},
"acquirer_settings[teller][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Teller)\n",
"type": "boolean"
},
"acquirer_settings[teller][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Teller)\n",
"type": "boolean"
},
"acquirer_settings[teller][securepay]": {
"description": "Enable SecurePay fraud protection. (disabling requires agreement with Teller)\n",
"type": "boolean",
"default": true
},
"acquirer_settings[teller][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[teller][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[teller][visa_bin]": {
"description": "Teller VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[teller][mastercard_bin]": {
"description": "Teller Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[valitor][active]": {
"description": "Enable Valitor payments\n",
"type": "boolean"
},
"acquirer_settings[valitor][identification_code]": {
"description": "Valitor identification number\n",
"type": "string"
},
"acquirer_settings[valitor][identification_code_int]": {
"description": "Valitor international identification number\n",
"type": "string"
},
"acquirer_settings[valitor][business_code]": {
"description": "Business code (assigned by Valitor)\n",
"type": "string"
},
"acquirer_settings[valitor][recurring]": {
"description": "Enable recurring payments (requires agreement with Valitor)\n",
"type": "boolean"
},
"acquirer_settings[valitor][americanexpress]": {
"description": "Enable AMEX payments (requires agreement with Valitor)\n",
"type": "boolean"
},
"acquirer_settings[valitor][dinersclub]": {
"description": "Enable Diners Club payments (requires agreement with Valitor)\n",
"type": "boolean"
},
"acquirer_settings[valitor][securepay]": {
"description": "Enable SecurePay fraud protection.\n",
"type": "boolean"
},
"acquirer_settings[valitor][visa_mpi_merchant_id]": {
"description": "VISA MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[valitor][mastercard_mpi_merchant_id]": {
"description": "Mastercard MPI merchant id. Used for 3D secure transactions\n",
"type": "string"
},
"acquirer_settings[valitor][visa_bin]": {
"description": "VISA acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[valitor][mastercard_bin]": {
"description": "Mastercard acquirer bin used for 3D Secure\n",
"type": "string"
},
"acquirer_settings[viabill][active]": {
"description": "Enable ViaBill payments\n",
"type": "boolean"
},
"acquirer_settings[viabill][api_key]": {
"description": "ViaBill API key\n",
"type": "string"
},
"integration_settings[economic][active]": {
"description": "Enable e-conomic integration\n",
"type": "boolean"
},
"integration_settings[economic][agreement]": {
"description": "e-conomic agreement no.\n",
"type": "string"
},
"integration_settings[economic][agreement_token]": {
"description": "economic agreement grant token\n",
"type": "string"
},
"pci[saq_a]": {
"description": "Enable SAQ A\n",
"type": "boolean"
},
"pci[saq_a_ep]": {
"description": "Enable SAQ A-EP\n",
"type": "boolean"
},
"pci[saq_b]": {
"description": "Enable SAQ B\n",
"type": "boolean"
},
"pci[saq_b_ip]": {
"description": "Enable SAQ B-IP\n",
"type": "boolean"
},
"pci[saq_c]": {
"description": "Enable SAQ C\n",
"type": "boolean"
},
"pci[saq_c_vt]": {
"description": "Enable SAQ C-VT\n",
"type": "boolean"
},
"pci[saq_d_merchant]": {
"description": "Enable SAQ D Merchant\n",
"type": "boolean"
},
"pci[saq_d_service_provider]": {
"description": "Enable SAQ D Service Provider\n",
"type": "boolean"
},
"pci[saq_p2pe_hw]": {
"description": "Enable SAQ P2PE-HW\n",
"type": "boolean"
},
"autofee": {
"description": "Add automatic fee on all payments\n",
"type": "boolean"
},
"default_payment_methods": {
"description": "Comma separated list of default payment methods\n",
"type": "string"
},
"shop_url": {
"description": "Shop URL (deprecated, use shop_urls instead)\n",
"type": "string"
},
"shop_urls": {
"description": "Shop URLs\n",
"type": "string"
},
"contact_email": {
"description": "Contact email\n",
"type": "string"
},
"shop_name": {
"description": "Shop name\n",
"type": "string"
},
"shopsystem": {
"description": "Shop system\n",
"type": "string"
},
"timezone": {
"description": "<table>\n <tbody>\n <tr>\n <td>Timezone UTC offsets in Zulu (+</td>\n <td>-)hh:mm</td>\n </tr>\n </tbody>\n</table>\n",
"type": "string"
},
"locale": {
"description": "Locale as a two letter language code\n",
"type": "string"
},
"default_branding_id": {
"description": "Id of default branding\n",
"type": "integer",
"format": "int32"
},
"logging_stops_at": {
"description": "Timestamp when logging is active\n",
"type": "string"
},
"allow_test_transactions": {
"description": "Allow test transactions\n",
"type": "boolean"
},
"default_payment_language": {
"description": "Default payment language (Two letter language code, ISO-639-1)\n",
"type": "string"
},
"default_text_on_statement": {
"description": "Text to be displayed on cardholder’s statement. Max 22 ASCII chars. Currently supported by Clearhaus only.\n",
"type": "string"
},
"default_branding_config": {
"description": "Default branding config. Can be overwritten in branding or in request to payment window\n",
"type": "string"
}
}
}
}
}
}
},
"delete": {
"tags": [
"account"
],
"operationId": "DELETE-account---format-",
"summary": "Delete merchant account",
"description": "\n",
"parameters": [
{
"in": "header",
"description": "Specify the version of the API\n",
"name": "Accept-Version",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"description": "Use Basic Auth to authorize to the API\n",
"name": "Authorization",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified"
},
"204": {
"description": "No content"
},
"403": {
"description": "Not authorized"
}
}
}
},
"/account/private-key": {
"get": {
"tags": [
"account"
],
"operationId": "GET-account-private-key---format-",
"summary": "Gets the private key of the merchant",
"description": "\n",
"parameters": [
{
"in": "header",
"description": "Specify the version of the API\n",
"name": "Accept-Version",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"description": "Use Basic Auth to authorize to the API\n",
"name": "Authorization",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PrivateKey"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrivateKey"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/PrivateKey"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PrivateKey"
}
}
}
},
"403": {
"description": "Not authorized"
}
}
},
"patch": {
"tags": [
"account"
],
"operationId": "PATCH-account-private-key---format-",
"summary": "Regenerates the private key of the merchant",
"description": "\n",
"parameters": [
{
"in": "header",
"description": "Specify the version of the API\n",
"name": "Accept-Version",
"required": true,
"schema": {
"type": "string"
}