-
Notifications
You must be signed in to change notification settings - Fork 4
/
wyre-openapi.yaml
15225 lines (15221 loc) · 470 KB
/
wyre-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.0
info:
title: Wyre API
description: Wyre's Public API
contact: {}
version: "3.0"
servers:
- url: "https://api.testwyre.com"
description: ""
variables: {}
- url: "https://api.sendwyre.com"
description: ""
variables: {}
paths:
/v2/sessions/auth/key:
post:
tags:
- Authentication
summary: Submit Auth Token
description: Submit a client-generated secret key that can be used as an Auth Token and generate a corresponding API Key for it
operationId: SubmitAuthToken
parameters: []
requestBody:
description: The client-generated secret key
content:
application/json:
schema:
$ref: "#/components/schemas/SubmitAuthTokenRequest"
example:
secretKey: SK-XXXXX-XXXXX-XXXXX-XXXXX
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/SubmitAuthTokenResponse"
example:
apiKey: AK-XXXXX-XXXXX-XXXXX-XXXXX
authenticatedAs: "`null`"
deprecated: false
security: []
servers:
- url: "https://api.testwyre.com"
variables: {}
/v2/apiKeys:
post:
tags:
- Authentication
summary: Create API Key
description: Generate a new set of API credentials
operationId: CreateAPIKey
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/CreateAPIKeyRequest"
example:
desc: User key
type: FULL
ipWhitelist:
- 123.45.67.89
- 123.45.67.90
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/CreateAPIKeyResponse"
example:
sessionId: RGFXT9DWMYR
owner: "account:AC_XXXXXXXXXXX"
createdAt: 1628091367671
expiresAt: null
apiKey: AK-XXXX-XXXX-XXXX-XXXX
type: FULL
desc: User key
ipWhitelist:
- 123.45.67.89
- 123.45.67.90
destSrnWhitelist: []
secretKey: SK-XXXX-XXXX-XXXX-XXXX
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v2/apiKey/{apiKey}":
delete:
tags:
- Authentication
summary: Delete API Key
description: Delete an existing API Key
operationId: DeleteAPIKey
parameters:
- name: apiKey
in: path
description: The API Key you wish to delete
required: true
style: simple
schema:
type: string
example: AK-XXXX-XXXX-XXXX-XXXX
responses:
"204":
description: No Content
headers: {}
content: {}
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/widget/limits/calculate:
post:
tags:
- Hosted Checkout
summary: Check Limits
description: Check current limits for a given wallet order billing address
operationId: CheckLimits
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/LimitsAPIRequest"
examples:
example:
value:
accountId: AC_XXXXXXXXXX
sourceCurrency: USD
address:
street1: 1234 Fake St
city: San Francisco
state: CA
postalCode: "94105"
country: US
firstName: Crash
lastName: Bandicoot
cellNumber: "+15558675309"
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/LimitsAPIResponse"
examples:
example:
value:
dailyTotalSpent: 0
weeklyTotalSpent: 0
yearlyTotalSpent: 0
dailyTotal: 250
weeklyTotal: 1000
yearlyTotal: 1500
usdConversionRate: 1
sourceCurrency: USD
dailyRemaining: 250
weeklyRemaining: 1000
yearlyRemaining: 1500
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
security: []
/v3/orders/reserve:
post:
tags:
- Hosted Checkout
summary: Create Wallet Order Reservation
description: Lock in wallet order via API before allowing widget operation
operationId: CreateWalletOrderReservation
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletOrderReservationRequest"
example:
sourceAmount: "10"
paymentMethod: debit-card
amountIncludeFees: true
sourceCurrency: USD
destCurrency: ETH
redirectUrl: "https://www.sendwyre.com/success"
autoRedirect: true
failureRedirectUrl: "https://www.sendwyre.com/failure"
referrerAccountId: AC_YV8LCV3C9HZ
dest: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
country: US
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletOrderReservationResponse"
examples:
example:
value:
url: "https://pay.testwyre.com/purchase?accountId=AC_XXXXXXXXXX&country=US&failureRedirectUrl=https%3A%2F%2Fwww.sendwyre.com&amount=10&redirectUrl=https%3A%2F%2Fwww.sendeyre.com&utm_campaign=AC_Y22RAQXEYV6&utm_medium=widget&paymentMethod=debit-card&reservation=EFX6DN9ECRPTPDJBEL6U&sourceCurrency=USD&utm_source=checkout"
reservation: EFX6DN9ECRPTPDJBEL6U
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/orders/quote/partner:
post:
tags:
- Hosted Checkout
summary: Create Wallet Order Quotation
description: Wallet Order Quotation
operationId: CreateWalletOrderQuotation
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletOrderQuotationRequest"
example:
amount: "5.0"
sourceCurrency: USD
destCurrency: ETH
dest: "ethereum:0x89205A3A3b2A69De6Dbf7f01ED13B2108B2c43e7"
accountId: AC_XXXXXXXX
country: US
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/CreateWalletOrderQuotationResponse"
examples:
example:
value:
sourceCurrency: USD
sourceAmount: 5.95
destCurrency: ETH
destAmount: 0.00988023952095808
exchangeRate: 0.00197604790419162
equivalencies:
CAD: 4.95
USDC: 0.00992
BTC: 0.00040198
ETH: 0.00988023952095808
GBP: 4.95
DAI: 4.15415123387597
AUD: 3.87
EUR: 4.95
WETH: 0.00988023952095808
USD: 4.95
MXN: 4.95
fees:
ETH: 0.001
USD: 0.45
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v3/orders/{orderId}":
get:
tags:
- Hosted Checkout
summary: Get Wallet Order
description: Track a wallet order by identifier
operationId: GetWalletOrder
parameters:
- name: orderId
in: path
required: true
style: simple
schema:
type: string
example: WO_XXXXXXXXXX
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/GetWalletOrderResponse"
examples:
example:
value:
id: WO_ELTUVYCAFPG
createdAt: 1576263687643
owner: "account:AC_RNWQNRAZFPC"
status: PROCESSING
sourceAmount: 1.84
sourceCurrency: USD
destCurrency: ETH
dest: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
walletType: APPLE_PAY
transferId: null
errorMessage: null
accountId: AC_RNWQNRAZFPC
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
security: []
parameters:
- schema:
type: string
name: orderId
in: path
required: true
description: the wallet order id
"/v3/orders/{orderId}/full":
get:
tags:
- Hosted Checkout
summary: Get Wallet Order Full
description: Track a wallet order with full details
operationId: GetWalletOrderFull
parameters:
- name: orderId
in: path
required: true
style: simple
schema:
type: string
example: WO_XXXXXXXXXX
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/GetWalletOrderFullResponse"
examples:
example:
value:
id: WO_L74RZHNL4BV
createdAt: 1586716453000
owner: "account:AC_QXWVTRWPM3U"
status: FAILED
sourceAmount: 208.26
sourceCurrency: USD
destCurrency: ETH
dest: "ethereum:0xea8dd9381571D618119912AF553CE81c3c0dFF12"
walletType: APPLE_PAY
transferId: null
errorMessage: We are unable to process your order at this time.
accountId: AC_QXWVTRWPM3U
orderType: INTERNATIONAL
purchaseAmount: 200
authCodesRequested: false
errorCategory: GENERAL
failureReason: null
paymentNetworkErrorCode: ISO_8583_05
internalErrorCode: DO_NOT_HONOR
usdSourceAmount: 208.26
usdPurchaseAmount: 200
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/orders/list:
get:
tags:
- Hosted Checkout
summary: List Orders Paginated
description: List all wallet orders by pagination
operationId: ListOrdersPaginated
parameters:
- name: offset
in: query
style: form
explode: true
schema:
type: string
description: Determines how many entries to be skipped
- name: limit
in: query
description: Determines the maximum number of items returned from the query
style: form
explode: true
schema:
type: string
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/ListOrdersPaginatedResponse"
examples:
example:
value:
data:
- id: WO_L74RZHNL4BV
createdAt: 1586716453000
owner: "account:AC_QXWVTRWPM3U"
status: FAILED
orderType: INTERNATIONAL
sourceAmount: 208.26
purchaseAmount: 200
sourceCurrency: USD
destCurrency: ETH
transferId: null
dest: "ethereum:0xea8dd9381571D618119912AF553CE81c3c0dFF12"
authCodesRequested: false
errorCategory: GENERAL
errorMessage: We are unable to process your order at this time.
failureReason: null
accountId: AC_QXWVTRWPM3U
paymentNetworkErrorCode: ISO_8583_05
internalErrorCode: DO_NOT_HONOR
walletType: TOKENIZED_PAYMENT_METHOD
usdSourceAmount: 208.6
usdPurchaseAmount: 200
- id: WO_LCMCZRD6RJ
createdAt: 1605882139000
owner: "account:AC_HNW9ED7XARH"
status: PROCESSING
orderType: DOMESTIC
sourceAmount: 15
purchaseAmount: 9.48
sourceCurrency: USD
destCurrency: ETH
transferId: TF_FWVEF7N9Q37
dest: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
authCodesRequested: true
errorCategory: null
errorCode: null
errorMessage: null
failureReason: null
accountId: AC_HNW9ED7XARH
internalErrorCode: null
paymentNetworkErrorCode: null
walletType: TOKENIZED_PAYMENT_METHOD
usdSourceAmount: 15
usdPurchaseAmount: 9.48
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v2/transfer/{transferId}/track":
get:
tags:
- Hosted Checkout
summary: Track Widget Order
description: Track a wallet order by the transfer identifier
operationId: TrackWidgetOrder
parameters:
- name: transferId
in: path
description: The transfer identifier
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/TrackWidgetOrderResponse"
examples:
example:
value:
transferId: TF_MDA6MAY848D
feeCurrency: USD
fee: 0.84
fees:
ETH: 0.001
USD: 0.33
sourceCurrency: USD
destCurrency: ETH
sourceAmount: 1.84
destAmount: 0.001985533306564713
destSrn: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
from: Walletorderholding WO_ELTUVYCAFPG
to: null
rate: 0.0019760479041916164
customId: null
status: COMPLETED
blockchainNetworkTx: null
message: null
transferHistoryEntryType: OUTGOING
successTimeline:
- statusDetails: Initiating Transfer
state: INITIATED
createdAt: 1576263690000
- statusDetails: Processing Exchange
state: PENDING
createdAt: 1576263690000
- statusDetails: Processing Deposit
state: PENDING
createdAt: 1576263690000
failedTimeline: []
failureReason: null
reversalReason: null
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/widget/supportedCountries:
get:
tags:
- Hosted Checkout
summary: Get Supported Countries
description: Retrieve the countries currently supported by the Wyre widget
operationId: GetSupportedCountries
parameters: []
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/SupportedCountriesResponse"
examples:
example:
value:
- DZ
- AR
- AU
- AT
- BE
- BO
- BR
- CA
- CL
- CO
- CR
- CY
- CZ
- DK
- DO
- EE
- FI
- FR
- DE
- GR
- HK
- IS
- IN
- ID
- IE
- IL
- IT
- JP
- LV
- LT
- LU
- MY
- MX
- NP
- NL
- NZ
- "NO"
- PY
- PE
- PH
- PL
- PT
- SG
- SK
- SI
- ZA
- KR
- ES
- SE
- CH
- TZ
- TH
- TR
- GB
- US
- VN
deprecated: false
security: []
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v3/orders/reservation/{reservationId}":
get:
tags:
- Hosted Checkout
summary: Get Rate Locked Reservation
description: Get a Rate Locked Reservation by its identifier
operationId: GetRateLockedReservation
parameters:
- name: reservationId
in: path
description: The reservation identifier
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/GetReservationResponse"
examples:
example:
value:
amount: null
sourceCurrency: USD
destCurrency: ETH
dest: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
referrerAccountId: AC______AAAA
sourceAmount: null
destAmount: 0.02
amountIncludeFees: true
street1: 1550 Bryant Street
city: San Francisco
state: CA
postalCode: "94103"
country: US
firstName: ""
lastName: ""
phone: ...
email: ""
lockFields:
- sourceAmount
- destAmount
- amountIncludeFees
- paymentMethod
- country
- sourceCurrency
- destCurrency
- dest
- referrerAccountId
redirectUrl: "http://google.com"
failureRedirectUrl: "http://google.com"
paymentMethod: debit-card
referenceId: null
hideTrackBtn: null
quote:
sourceCurrency: USD
sourceAmount: 8.89
sourceAmountWithoutFees: 5.45
destCurrency: ETH
destAmount: 0.013
exchangeRate: 0.0023886138613861386
equivalencies:
GUSD: 5.26
USDC: 5.255737
EUR: 4.44
USDT: 5.255217
GBP: 4.03
DAI: 6.081825531005859
USD: 5.25
CAD: 6.93
BUSD: 5.255736808466775
USDS: 5.255737
HUSD: 5.25573681
BTC: 0.00039169
ETH: 0.013
AUD: 7.38
PAX: 5.255736808466775
WETH: 0.013
fees:
ETH: 0.007
USD: 0.51
quoteLockRequest: true
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v3/debitcard/authorization/{orderId}":
get:
tags:
- White-Label Card Processing
summary: Get Authorization
description: Determine if a card order requires two-factor authentication
operationId: GetAuthorization
parameters:
- name: orderId
in: path
description: ""
required: true
style: simple
schema:
type: string
example: WO_9PUXWLZD888
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/GetAuthorizationResponse"
examples:
SMS Needed Example:
value:
walletOrderId: WO_9PUXWLZD888
smsNeeded: true
card2faNeeded: false
authorization3dsUrl: null
Auth via 3DS Example:
value:
walletOrderId: WO_V4VXVBJQLF
smsNeeded: false
card2faNeeded: false
authorization3dsUrl: "https://pay.testwyre.com/bank-authorization/WO_V4VXVBJQLF"
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/debitcard/process/partner:
post:
tags:
- White-Label Card Processing
summary: Create Order
description: Create a card payment order
operationId: CreateOrder
parameters: []
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderRequest"
examples:
example:
value:
debitCard:
number: "4111111111111111"
year: "2023"
month: "01"
cvv: "123"
reservationId: 9BTU8777E4YXFMRCYBTM
trigger3ds: true
amount: "10"
sourceCurrency: USD
destCurrency: BTC
dest: "bitcoin:tb1q6yn0ajs733xsk25vefrhwjey4629qt9c67y6ma"
referrerAccountId: AC_Y22RAQSKYV6
givenName: Crash
familyName: Bandicoot
email: [email protected]
ipAddress: 1.1.1.1
phone: "+18538299555"
referenceId: AC_Y22RAQSKYV6
address:
street1: 1234 Test Ave
city: Los Angeles
state: CA
postalCode: "91423"
country: US
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderResponse"
examples:
example:
value:
id: WO_TBFQRFMJ6Q
createdAt: 1667243925956
owner: account:AC_XRNGHME6A72
status: RUNNING_CHECKS
orderType: DOMESTIC
sourceAmount: 15
purchaseAmount: 10
sourceCurrency: USD
destCurrency: BTC
transferId: null
dest: "bitcoin:tb1q6yn0ajs733xsk25vefrhwjey4629qt9c67y6ma"
authCodesRequested: false
blockchainNetworkTx: null
authenticationUrl: "https://pay.testwyre.com/authentication/WO_TBFQRFMJ6Q?accountId=AC_RYMU7EZFFJY&reservation=HZT9DUXCPJ2HBLAP6T4R&customerId=AC_XRNGHME6A72&autoRedirect=false&redirectUrl=&failureRedirectUrl=&flow=CARD_API"
accountId: AC_XRNGHME6A72
paymentMethodName: null
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/debitcard/authorize/partner:
post:
tags:
- White-Label Card Processing
summary: Submit Authorization
description: Submit two-factor authentication for a card order
operationId: SubmitAuthorization
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/SubmitAuthorizationRequest"
example:
type: SMS
walletOrderId: WO_Y74E8FXVWJ2
reservation: NHEA3UYXEXCUX4Y2HG78
sms: "0"
card2fa: "0"
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/SubmitAuthorizationResponse"
examples:
example:
value:
walletOrderId: WO_DX6B3UAVN8B
success: true
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v3/orders/{orderId}/refund/partner":
post:
tags:
- White-Label Card Processing
summary: Refund Order
description: Request the refund of a wallet order
operationId: RefundOrder
parameters:
- name: orderId
in: path
description: The wallet order identifier
required: true
style: simple
schema:
type: string
example: WO_Y74E8FXVWJ2
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/RefundOrderResponse"
examples:
example:
value:
walletOrderId: WO_Q9PYNDY8LX
createdAt: 1611685410000
requester: "account:AC_8VF3YWMBZ8X"
status: COMPLETED
finishedAt: 1611685411000
failedReason: null
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
"/v3/orders/{orderId}/refund":
get:
tags:
- White-Label Card Processing
summary: Get Refund Details
description: Retrieve the details of a wallet order refund request
operationId: GetRefundDetails
parameters:
- name: orderId
in: path
description: The wallet order identifier
required: true
style: simple
schema:
type: string
example: WO_Y74E8FXVWJ2
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/RefundOrderResponse"
examples:
example:
value:
walletOrderId: WO_Q9PYNDY8LX
createdAt: 1611685410000
requester: "account:AC_8VF3YWMBZ8X"
status: COMPLETED
finishedAt: 1611685411000
failedReason: null
deprecated: false
servers:
- url: "https://api.testwyre.com"
variables: {}
/v3/apple-pay/process/partner:
post:
tags:
- White-Label Card Processing
summary: Create Apple Pay Order
description: Create an Apple Pay wallet order
operationId: CreateApplePayOrder
parameters: []
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateApplePayOrderRequest"
examples:
example:
value:
partnerId: YOUR_PARTNER_ACCOUNT_ID
payload:
paymentObject:
billingContact:
addressLines:
- street address line 1
- street address line 2
administrativeArea: IL
country: United States
countryCode: US
familyName: LastName
givenName: Your 1st name
locality: San Francisco
postalCode: "94103"
subAdministrativeArea: ""
subLocality: ""
shippingContact:
addressLines:
- street address 1
administrativeArea: CA
country: United States
countryCode: US
emailAddress: [email protected]
familyName: name
givenName: last name
locality: San Francisco
phoneNumber: "+14100000000"
postalCode: "60606"
subAdministrativeArea: ""
subLocality: ""
token:
paymentData:
version: ""
data: ""
signature: ...
header:
ephemeralPublicKey: ""
publicKeyHash: ""
transactionId: ""
paymentMethod:
displayName: Visa 1234
network: Visa
type: debit
transactionIdentifier: ""
orderRequest:
amount: "1.84"
destCurrency: ETH
sourceCurrency: USD
ipAddress: end_user_ip_address
reservationId: reservationId
dest: "ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341"
referenceId: for_your_reference
referrerAccountId: AC_XXXXXXXX
required: true
responses:
"200":
description: ""
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/CreateOrderResponse"
examples:
example:
value:
id: WO_ELTUVYCAFPG
createdAt: 1576263687643
owner: "account:AC_RNWQNRAZFPC"
status: PROCESSING
transferId: TF_MDA6MAY848D