-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
10751 lines (10668 loc) · 330 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Edge API
description: "Edge Payment Technologies offers payment solutions for merchants in diverse legal industries. To learn more about Edge's proposition see our [about](https://tryedge.io/about) page.\n\nBefore starting with the API, you must [create a merchant account](https://dashboard.tryedge.io/merchant_accounts/new) and obtain API keys from the [Developer tab](https://dashboard.tryedge.io/developers) in your account dashboard. You will use the “Publishable key” with Edge JavaScript SDK and the “Secret key” on your website.\n\nThe Edge API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. We speficially use the [JSON:API](https://jsonapi.org/) specification.\n\nIf you're wanting to use Edge Payment Technologies in the browser to make a charge you're going to need to include the Edge javascript SDK. The\_Edge JavaScript SDK is a toolkit for encrypting data in the browser. Using the Edge JavaScript SDK means your customer's data never leaves their browser unencrypted. Include this in your HTML:\n\n``` html\n<script\n src=\"https://assets.tryedge.io/assets/edge-028df78616a38778a73b92faac46bd2d5b1d4f3734f2902cc7d8548a0b7ffa4d.js\"\n type=\"text/javascript\"></script>\n```\n\nThen after that you need to initialize the client:\n\n``` javascript\nconst edge = new Edge('<Publishable Key>');\n\nedge.initializeForm().then(function (form) {\n // Form configuration\n});\n```\n"
version: v1
termsOfService: https://d2v8xkxkqr8ydr.cloudfront.net/end-user-terms-of-service.pdf
contact:
name: Support
url: https://www.tryedge.io/contact
email: support@tryedge.io
x-api-status-urls:
- https://api.tryedge.io
servers:
- url: https://{apiHost}
variables:
apiHost:
enum:
- api.tryedge.io
default: api.tryedge.io
type: string
tags:
- description: >
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius
ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus
ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu
diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu
pretium, at euismod justo bibendum. Fusce varius venenatis lectus a
molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros.
Etiam porta ligula nec velit posuere iaculis. In molestie et massa et
pulvinar. Orci varius natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus.
Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras
tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate
odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur.
Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis
ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur
consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem
eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit
amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar
scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec
tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum
malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend
vehicula. Vivamus imperdiet dignissim velit quis varius.
Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis.
Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed
augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit
turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet
tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet
purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus
vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.
Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam
nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis
ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas
nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit
ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit
amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget
viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper
facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin
ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis
ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit
ante.
Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem
ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id
nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est
vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet
nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et,
pulvinar ultrices enim.
name: Webhook Subscriptions
- description: >
Subscriptions allow you to charge customers recurringly for access to a
product or service. Edge supports subscriptions with billing cycles
`weekly`, `biweekly`, `monthly`, `bimonthly`, `quarterly`, `semiannual`,
and `yearly`. Edge will create a new charge against the associated payment
method when a new cycle begins.
### Events
You can listen to `subscriptions.created`, `subscription.updated` and
`subscription.deleted` events on the resource. In addition, charges would
trigger their respective events as they advance through their lifecycle.
### Detecting Failures
A subscription will be in an `active` status unless specified otherwise.
However, the customer may have entered the card details incorrectly. In
this case, the subscription `status` will transit from `active` to
`past_due`. Track this transition using `WebhookSubscription` by listening
to the `subscription.updated` event.
name: Subscriptions
- description: >
`LegalAddress` represents a physical address associated with the merchant
account opener and the beneficial owners.
### Scoping
Unlike its counterpart `ConsumerAddress` `LegalAddress` are not scoped to
modes `sandbox` or `live`.
name: Legal Addresses
- description: >
A customer in Edge represents a customer in your business. While the
customer resource is considered optional, it is highly recommended that
you create a customer for each of your customers. This will allow you to
track past transactions involving the customer and will be used as
evidence in the case of a chargeback/dispute.
name: Customers
- description: >
A `User` represents an entity with login access to a merchant account in
the Edge platform.
Users with administrative access to a merchant account (for example, the
merchant account opener) can use the Edge Dashboard to invite new users,
update existing users and to remove them.
name: Users
- description: >
`PayoutMethod` lets you link your bank account with Edge to receive
payouts. Edge handles payouts through ACH and supports checking and
savings accounts.
### Events
Currently, there are no events triggered during the lifecycle of payouts.
name: Payout Methods
- description: >
`Payout` lets you withdraw your earnings to a bank account (denoted by a
`PayoutMethod`) periodically or manually as needed. Your ability to
trigger a payout depends on your industry and perceived risks. Edge may
need to implement a rolling reserve for merchants perceived as high-risk,
which may delay your ability to trigger payouts until the reserve
requirements are met.
name: Payouts
- description: >
Use the `PaymentMethod` API to store customer credit/debit card details
for immediate (charges) or later processing (subscriptions). The API does
not accept raw card numbers or cvv values. Edge JS will provide tokenised
values for card numbers (`card_pan_token`) and cvv (`card_cvv_token`).
Edge currently supports credit and debit cards of Visa, Master, AMEX and
Discovery. Edge intends to introduce support for ACH payments soon.
name: Payment Methods
- description: >
# Details
MerchantAccount is your organization on Edge. Edge periodically reviews
the accuracy of the information provided, and keeping your merchant
account profile up-to-date is essential. You can manage this information
on the merchant dashboard and through the API.
name: Merchant Accounts
- description: >
`ConsumerAddress` represents a physical address related to a customer, a
charge (as a shipping address) or a payment method (as a billing address).
### Scoping
`ConsumerAddresses` are scoped to your current mode (`sandbox` or `live`)
denoted by the API Key.
name: Consumer Addresses
- description: >
A `Charge` instance signifies an attempt to transfer money from a
customer's payment method to your Edge merchant account.
A charge optionally belongs to a `customer`, but it is recommended to
associate a charge with the customer. Customer charge history can be used
as evidence in case of a chargeback or dispute.
### Sale
A “sale” is denoted by having a charge created with the `captured`
attribute as `true` (default). In this case, the charge would start its
lifecycle in a `pending` state and immediately get sent for processing.
Its `processor_state` would then transit to `succeeded` or `failed`.
### Pre-authorization / completion flow
Pre-authorization holds a certain amount from the customer's card. Such
requests should be completed within 2 days time, or the hold will be
removed.
You can opt into a pre-authorization by creating a charge with the
`captured` attribute set to `false`. Then to capture the charge, you would
update the charge with a value equal to or less than the value provided
when creating the charge.
### Refund a charge
TOOD
### Events
A charge through its lifecycle will emit events. You can listen to these
events as webhooks through `WebhookSubscription`.
- `charge.created`
- `charge.updated`
- `charge.refunded`
- `charge.succeeded`
- `charge.failed`
- `charge.disputed`
- `charge.deleted`
name: Charges
- description: >
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius
ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus
ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu
diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu
pretium, at euismod justo bibendum. Fusce varius venenatis lectus a
molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros.
Etiam porta ligula nec velit posuere iaculis. In molestie et massa et
pulvinar. Orci varius natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus.
Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras
tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate
odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur.
Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis
ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur
consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem
eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit
amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar
scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec
tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum
malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend
vehicula. Vivamus imperdiet dignissim velit quis varius.
Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis.
Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed
augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit
turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet
tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet
purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus
vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.
Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam
nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis
ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas
nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit
ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit
amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget
viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper
facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin
ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis
ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit
ante.
Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem
ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id
nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est
vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet
nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et,
pulvinar ultrices enim.
name: Events
- description: >
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius
ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus
ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu
diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu
pretium, at euismod justo bibendum. Fusce varius venenatis lectus a
molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros.
Etiam porta ligula nec velit posuere iaculis. In molestie et massa et
pulvinar. Orci varius natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus.
Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras
tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate
odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur.
Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis
ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur
consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem
eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit
amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar
scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec
tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum
malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend
vehicula. Vivamus imperdiet dignissim velit quis varius.
Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis.
Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed
augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit
turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet
tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet
purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus
vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.
Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam
nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis
ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas
nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit
ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit
amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget
viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper
facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin
ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis
ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit
ante.
Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem
ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id
nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est
vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet
nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et,
pulvinar ultrices enim.
name: Attachments
- description: >
The Edge API relies on authentication via public and secret keys:
- For environments exposed to the public (such as browsers) use your
public key
- For server to server communication use your secret key
To authenticate a request set the `Authorization` header to `Bearer
<YOUR_TOKEN_HERE>`.
name: Authentication
- description: "The Edge JavaScript SDK on `intializeForm()` exposes a form builder. The main function exposed by the form builder is the `inputs` function (`form.inputs(…)`). It initialises Edge Inputs, making it easy to collect encrypted cardholder data in a completely PCI-compliant environment.\n\nEdge Inputs are served within an iFrame retrieved directly from Edge’s PCI-compliant infrastructure, which can reduce your PCI DSS compliance scope to the simplest form (SAQ-A) once integrated correctly.\n\nPass the id of the element in which the iFrame should be embedded, for example:\n\n``` javascript\n// form.inputs(id: String, settings: Object);\nform.inputs('card-details', {\n theme: 'material'\n});\n```\n\n## Themes\n\nInputs can be customized to match your brand’s design system. The Edge JavaScript SDK allows additional configuration for styling both the Evervault Inputs container as well as each\_`<input>` within the container.\n\n### Supported Settings\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| theme | String | The base styling for Inputs. Currently supports default, minimal and material. |\n| height | String | The height of the Evervault Inputs iframe. |\n| primaryColor | String | The main theme color. |\n| labelColor | String | The color CSS property applied to the input labels. |\n| inputBorderColor | String | The border-color CSS property applied to inputs. |\n| inputTextColor | String | The color CSS property applied to inputs. |\n| inputBackgroundColor | String | The color CSS property applied to the ::placeholder CSS pseudo-element for inputs. |\n| inputBorderRadius | String | The border-radius CSS property applied to inputs. |\n| inputHeight | String | The height CSS property applied to inputs. |\n| cardNumberLabel | String | The label for the card number input |\n| expirationDateLabel | String | The label for the expiration date input |\n| securityCodeLabel | String | The label for the security code input |\n| expirationDatePlaceholder | String | The placeholder shown for the expiration date input |\n| invalidCardNumberLabel | String | The message shown on an invalid card number |\n| invalidExpirationDateLabel | String | The message shown on an invalid expiration date |\n| invalidSecurityCodeLabel | String | The message shown on an invalid security code |\n| fontUrl | String | Load a custom font with the Google Fonts API |\n| fontFamily | String | Set the font-family for the fontUrl |\n| inputFontSize | String | Set the font-size property of the input attribute |\n| inputBoxShadow | String | Set the box-shadow property of the input attribute |\n| labelFontSize | String | Set the font-size property of the label attribute |\n| labelWeight | String | Set the font-weight property of the label attribute |\n| disableCVV | Boolean | If true the CVV field will not be displayed |\n\n### Default Theme\n\nSet\_`theme`\_to\_`default`\_to use the\_*Default*\_theme for Inputs.\n\n\n\n### Minimal Theme\n\nSet\_`theme`\_to\_`minimal`\_to use the\_*Minimal*\_theme for Inputs.\n\n\n\n### Material Theme\n\nSet\_`theme`\_to\_`material`\_to use the\_*Material*\_theme for Inputs.\n"
name: Edge.js
paths:
/attachments/{id}:
get:
tags:
- Attachments
summary: Show
operationId: Attachments_showIndividualAttachment
security:
- bearerAuth: []
description: Shows an individual Attachment
parameters:
- name: id
in: path
required: true
schema:
description: A UUID that identifies an object
type: string
format: uuid
readOnly: true
example: 32e46c03-a4e1-53e7-93e4-936fad0196a1
example: 32e46c03-a4e1-53e7-93e4-936fad0196a1
- name: fields[records]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/attachment'
'401':
description: Unauthorized
'404':
description: Not Found
'406':
description: Not Acceptable
/charges:
get:
tags:
- Charges
summary: List of Charges
operationId: Charges_getList
security:
- bearerAuth: []
description: Lists all Charges
parameters:
- name: fields[events]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[merchant_accounts]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[customers]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[payment_methods]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[billing_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[subscriptions]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[shipping_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
- name: filter[amount_cents]
in: query
required: false
schema:
type: string
- name: filter[captured]
in: query
required: false
schema:
type: string
- name: filter[currency]
in: query
required: false
schema:
type: string
- name: filter[description]
in: query
required: false
schema:
type: string
- name: filter[fee_cents]
in: query
required: false
schema:
type: string
- name: filter[gateway_fee_cents]
in: query
required: false
schema:
type: string
- name: filter[net_cents]
in: query
required: false
schema:
type: string
- name: filter[processor_state]
in: query
required: false
schema:
type: string
- name: filter[refund_amount_cents]
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/charges'
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
post:
tags:
- Charges
summary: Create
operationId: Charges_createNewCharge
security:
- bearerAuth: []
description: Creates an new Charge
parameters:
- name: fields[events]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[merchant_accounts]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[customers]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[payment_methods]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[billing_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[subscriptions]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[shipping_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ChargesCreateNewChargeRequest'
responses:
'201':
description: Created
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/charge'
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
'415':
description: Unsupported Media Type
'422':
description: Unprocessible Entity
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/errors'
/charges/{id}:
get:
tags:
- Charges
summary: Show
operationId: Charges_showIndividualCharge
security:
- bearerAuth: []
description: Shows an individual Charge
parameters:
- name: id
in: path
required: true
schema:
description: A UUID that identifies an object
type: string
format: uuid
readOnly: true
example: 32e46c03-a4e1-53e7-93e4-936fad0196a1
example: 32e46c03-a4e1-53e7-93e4-936fad0196a1
- name: fields[events]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[merchant_accounts]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[customers]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[payment_methods]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[billing_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[subscriptions]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: fields[shipping_addresses]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/charge'
'401':
description: Unauthorized
'404':
description: Not Found
'406':
description: Not Acceptable
/consumer_addresses:
get:
tags:
- Consumer Addresses
summary: List of Consumer Addresses
operationId: ConsumerAddresses_listGetAll
security:
- bearerAuth: []
description: Lists all Consumer Addresses
parameters:
- name: fields[merchant_accounts]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
- name: filter[city]
in: query
required: false
schema:
type: string
- name: filter[country]
in: query
required: false
schema:
type: string
- name: filter[line_1]
in: query
required: false
schema:
type: string
- name: filter[line_2]
in: query
required: false
schema:
type: string
- name: filter[state]
in: query
required: false
schema:
type: string
- name: filter[zip]
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/consumer_addresses'
'401':
description: Unauthorized
'403':
description: Forbidden
'406':
description: Not Acceptable
post:
tags:
- Consumer Addresses
summary: Create
operationId: ConsumerAddresses_createNewAddress
security:
- bearerAuth: []
description: Creates an new Consumer Address
parameters:
- name: fields[merchant_accounts]
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- id
- created_at
- updated_at
required: false
- name: include
in: query
style: form
explode: false
schema:
type: array
items:
type: string
example:
- a
- a.b
- c
- c.d.e
required: false
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ConsumerAddressesCreateNewAddressRequest'
responses:
'201':