-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.ts
executable file
·5621 lines (5419 loc) · 257 KB
/
index.ts
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
/**
* MarketPay API
* API for Smart Contracts and Payments
*
* OpenAPI spec version: v2.01
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import * as querystring from "querystring";
import * as url from "url";
import * as isomorphicFetch from "isomorphic-fetch";
import * as assign from "core-js/library/fn/object/assign";
interface Dictionary<T> { [index: string]: T; }
export interface FetchAPI { (url: string, init?: any): Promise<any>; }
const BASE_PATH = "https://localhost/".replace(/\/+$/, "");
export interface FetchArgs {
url: string;
options: any;
}
export class BaseAPI {
basePath: string;
fetch: FetchAPI;
constructor(fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) {
this.basePath = basePath;
this.fetch = fetch;
}
};
export interface Address {
/**
* The first line of the address
*/
"addressLine1": string;
/**
* The second line of the address
*/
"addressLine2"?: string;
/**
* The city of the address
*/
"city": string;
/**
* The region of the address - this is optional except if the Country is US, CA or MX
*/
"region"?: string;
/**
* The postal code of the address - can be alphanumeric, dashes or spaces
*/
"postalCode": string;
/**
* The Country where the bank account is held
*/
"country": AddressCountryEnum;
}
export type AddressCountryEnum = "NotSpecified" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
export interface AplazameOrderItem {
"id"?: string;
"name": string;
"url"?: string;
"imageUrl"?: string;
"quantity"?: number;
"price": number;
"description"?: string;
"taxRate"?: number;
}
export interface AplazamePayByWebPost {
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* Whether to save or not the card for future use. SaveCard and CardId are mutually exclusive
*/
"userId"?: number;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId"?: string;
/**
* Information about the funds that are being debited
*/
"debitedFunds": Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees"?: Money;
"shipping"?: Money;
/**
* Dirección (relativa a la tienda) a la que redirigirá en caso de error en el pago.
*/
"cancelUrl": string;
/**
* Dirección (relativa a la tienda) a la que redirigirá cuando se haya completado el pago.
*/
"successUrl": string;
/**
* Dirección a la que se redirigirá el usuario si escoge volver a la tienda (por omisión '/').
*/
"checkoutUrl"?: string;
"orderItems": Array<AplazameOrderItem>;
/**
* Customer data. Optional user info. If it is not set, Marketpay will try to use the data it does currently have about the user, but it will fail if existing data is not enough.
*/
"customer": Customer;
}
export interface AplazamePayByWebResponse {
"payInId"?: string;
"checkoutData"?: string;
}
export interface AplazamePayInsResponse {
/**
* Information about the funds that are being debited
*/
"debitedFunds"?: Money;
/**
* Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
*/
"creditedFunds"?: Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees"?: Money;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId"?: string;
/**
* The nature of the transaction
*/
"nature"?: AplazamePayInsResponseNatureEnum;
/**
* The status of the transaction
*/
"status"?: AplazamePayInsResponseStatusEnum;
/**
* When the transaction happened
*/
"executionDate"?: number;
/**
* The result code
*/
"resultCode"?: string;
/**
* A verbal explanation of the ResultCode
*/
"resultMessage"?: string;
/**
* The type of the transaction
*/
"type"?: AplazamePayInsResponseTypeEnum;
/**
* The type of payin
*/
"paymentType"?: AplazamePayInsResponsePaymentTypeEnum;
/**
* The type of execution for the payin
*/
"executionType"?: AplazamePayInsResponseExecutionTypeEnum;
/**
* The Id of the card saved, if any.
*/
"cardId"?: string;
/**
* A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces
*/
"statementDescriptor"?: string;
/**
* A user's ID
*/
"authorId"?: string;
/**
* The user ID who was credited
*/
"creditedUserId"?: string;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type AplazamePayInsResponseNatureEnum = "REGULAR" | "REFUND" | "REPUDIATION" | "SETTLEMENT";
export type AplazamePayInsResponseStatusEnum = "CREATED" | "SUCCEEDED" | "FAILED";
export type AplazamePayInsResponseTypeEnum = "PAYIN" | "PAYOUT" | "TRANSFER";
export type AplazamePayInsResponsePaymentTypeEnum = "NotSpecified" | "CARD" | "BANK_WIRE" | "DIRECT_DEBIT" | "PREAUTHORIZED";
export type AplazamePayInsResponseExecutionTypeEnum = "NotSpecified" | "WEB" | "DIRECT";
export interface AplazameRefundPaymentPost {
/**
* Custom data that you can add to this item
*/
"tag"?: string;
"debitedFunds": Money;
"fees": Money;
}
export interface AplazameRefundResponse {
/**
* Information about the funds that are being debited
*/
"debitedFunds"?: Money;
/**
* Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
*/
"creditedFunds"?: Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees"?: Money;
/**
* The ID of the wallet that was debited
*/
"debitedWalletId"?: string;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId"?: string;
/**
* A user's ID
*/
"authorId"?: string;
/**
* The user ID who was credited
*/
"creditedUserId"?: string;
/**
* The nature of the transaction
*/
"nature"?: AplazameRefundResponseNatureEnum;
/**
* The status of the transaction
*/
"status"?: AplazameRefundResponseStatusEnum;
/**
* When the transaction happened
*/
"executionDate"?: number;
/**
* The result code
*/
"resultCode"?: string;
/**
* A verbal explanation of the ResultCode
*/
"resultMessage"?: string;
/**
* The type of the transaction
*/
"type"?: AplazameRefundResponseTypeEnum;
/**
* The initial transaction ID
*/
"initialTransactionId"?: string;
/**
* The initial transaction type
*/
"initialTransactionType"?: AplazameRefundResponseInitialTransactionTypeEnum;
/**
* Contains info about the reason for refund
*/
"refundReason"?: RefundReason;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type AplazameRefundResponseNatureEnum = "REGULAR" | "REFUND" | "REPUDIATION" | "SETTLEMENT";
export type AplazameRefundResponseStatusEnum = "CREATED" | "SUCCEEDED" | "FAILED";
export type AplazameRefundResponseTypeEnum = "PAYIN" | "PAYOUT" | "TRANSFER";
export type AplazameRefundResponseInitialTransactionTypeEnum = "NotSpecified" | "PAYIN" | "TRANSFER" | "PAYOUT";
export interface BankAccountCaPost {
/**
* The branch code of the bank where the bank account. Must be numbers only, and 5 digits long
*/
"branchCode"?: string;
/**
* The institution number of the bank account. Must be numbers only, and 3 or 4 digits long
*/
"institutionNumber"?: string;
/**
* The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits
*/
"accountNumber"?: string;
/**
* The name of the bank where the account is held. Must be letters or numbers only and maximum 50 characters long
*/
"bankName"?: string;
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
}
export interface BankAccountGbPost {
/**
* The sort code of the bank account. Must be numbers only, and 6 digits long
*/
"sortCode"?: string;
/**
* The account number of the bank account. Must be numbers only. GB account numbers must be 8 digits long
*/
"accountNumber"?: string;
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
}
export interface BankAccountIbanPost {
/**
* The IBAN of the bank account
*/
"iBAN"?: string;
/**
* The BIC of the bank account
*/
"bIC"?: string;
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
}
export interface BankAccountOtherPost {
/**
* The Country where the bank account is held
*/
"country"?: BankAccountOtherPostCountryEnum;
/**
* The BIC of the bank account
*/
"bIC"?: string;
/**
* The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits
*/
"accountNumber"?: string;
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
}
export type BankAccountOtherPostCountryEnum = "NotSpecified" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
export interface BankAccountResponse {
/**
* The type of bank account
*/
"type"?: BankAccountResponseTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountResponseCa {
/**
* The branch code of the bank where the bank account. Must be numbers only, and 5 digits long
*/
"branchCode"?: string;
/**
* The institution number of the bank account. Must be numbers only, and 3 or 4 digits long
*/
"institutionNumber"?: string;
/**
* The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits
*/
"accountNumber"?: string;
/**
* The name of the bank where the account is held. Must be letters or numbers only and maximum 50 characters long
*/
"bankName"?: string;
/**
* The type of bank account
*/
"type"?: BankAccountResponseCaTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseCaTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountResponseGb {
/**
* The sort code of the bank account. Must be numbers only, and 6 digits long
*/
"sortCode"?: string;
/**
* The account number of the bank account. Must be numbers only. GB account numbers must be 8 digits long
*/
"accountNumber"?: string;
/**
* The type of bank account
*/
"type"?: BankAccountResponseGbTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseGbTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountResponseIban {
/**
* The IBAN of the bank account
*/
"iBAN"?: string;
/**
* The BIC of the bank account
*/
"bIC"?: string;
/**
* The type of bank account
*/
"type"?: BankAccountResponseIbanTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseIbanTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountResponseOther {
/**
* The Country where the bank account is held
*/
"country"?: BankAccountResponseOtherCountryEnum;
/**
* The BIC of the bank account
*/
"bIC"?: string;
/**
* The account number of the bank account. Must be numbers only. Canadian account numbers must be a maximum of 20 digits
*/
"accountNumber"?: string;
/**
* The type of bank account
*/
"type"?: BankAccountResponseOtherTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseOtherCountryEnum = "NotSpecified" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW";
export type BankAccountResponseOtherTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountResponseUs {
/**
* The account number of the bank account. US account numbers must be digits only
*/
"accountNumber"?: string;
/**
* The ABA of the bank account. Must be numbers only, and 9 digits long
*/
"aBA"?: string;
/**
* The type of account
*/
"depositAccountType"?: BankAccountResponseUsDepositAccountTypeEnum;
/**
* The type of bank account
*/
"type"?: BankAccountResponseUsTypeEnum;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* Whether the bank account is active or not
*/
"active"?: boolean;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type BankAccountResponseUsDepositAccountTypeEnum = "NotSpecified" | "CHECKING" | "SAVINGS";
export type BankAccountResponseUsTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountType {
"type"?: BankAccountTypeTypeEnum;
"ownerAddress"?: Address;
"ownerName"?: string;
"iBAN"?: string;
"bIC"?: string;
}
export type BankAccountTypeTypeEnum = "IBAN" | "GB" | "US" | "CA" | "OTHER";
export interface BankAccountUsPost {
/**
* The account number of the bank account. US account numbers must be digits only
*/
"accountNumber"?: string;
/**
* The ABA of the bank account. Must be numbers only, and 9 digits long
*/
"aBA"?: string;
/**
* The type of account
*/
"depositAccountType"?: BankAccountUsPostDepositAccountTypeEnum;
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The address of the owner of the bank account
*/
"ownerAddress"?: Address;
/**
* The name of the owner of the bank account
*/
"ownerName"?: string;
}
export type BankAccountUsPostDepositAccountTypeEnum = "NotSpecified" | "CHECKING" | "SAVINGS";
export interface CardPut {
/**
* Whether the card is active or not
*/
"active"?: boolean;
}
export interface CardResponse {
/**
* The object owner's UserId
*/
"userId"?: string;
/**
* The expiry date of the card - must be in format MMYY
*/
"expirationDate"?: string;
/**
* A partially obfuscated version of the credit card number
*/
"alias"?: string;
/**
* The provider of the card
*/
"cardProvider"?: string;
/**
* The type of card
*/
"cardType"?: CardResponseCardTypeEnum;
/**
* The Country where the bank account is held
*/
"country"?: string;
/**
* The card product type
*/
"product"?: string;
/**
*
*/
"bankCode"?: string;
/**
* Whether the card is active or not
*/
"active"?: boolean;
/**
* The currency - should be ISO_4217 format
*/
"currency"?: CardResponseCurrencyEnum;
/**
* Whether the card is valid or not. Once they process (or attempt to process) a payment with the card we are able to indicate if it is \"valid\" or \"invalid\". If they didn’t process a payment yet the \"Validity\" stay at \"unknown\"
*/
"validity"?: CardResponseValidityEnum;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type CardResponseCardTypeEnum = "NotSpecified" | "CB_VISA_MASTERCARD" | "AMEX" | "DINERS" | "MASTERPASS" | "MAESTRO" | "P24" | "IDEAL" | "BCMC" | "PAYLIB";
export type CardResponseCurrencyEnum = "NotSpecified" | "XXX" | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "USS" | "UYI" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XBT" | "XCD" | "XDR" | "XFU" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "YER" | "ZAR" | "ZMW" | "ZWD";
export type CardResponseValidityEnum = "NotSpecified" | "UNKNOWN" | "VALID" | "INVALID";
export interface CustomApiErrorResponse {
"message"?: string;
"type"?: string;
"id"?: string;
"date"?: number;
"errors"?: { [key: string]: string; };
}
export interface Customer {
"email": string;
"firstName"?: string;
"lastName"?: string;
"telephone"?: Telephone;
"address": Address;
}
export interface CustomerDetail {
"firstName"?: string;
"lastName"?: string;
"telephone"?: Telephone;
"address": Address;
}
export interface ExampleUserNaturalPost {
}
export interface Money {
/**
* The currency - should be ISO_4217 format
*/
"currency"?: MoneyCurrencyEnum;
/**
* An amount of money in cents, e.g. 12.60€ would be represented as 1260
*/
"amount"?: number;
}
export type MoneyCurrencyEnum = "NotSpecified" | "XXX" | "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYR" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "CNY" | "COP" | "COU" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "USS" | "UYI" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XBT" | "XCD" | "XDR" | "XFU" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "YER" | "ZAR" | "ZMW" | "ZWD";
export interface PayInBankwirePost {
"tag"?: string;
"creditedWalletId": string;
"debitedFunds": Money;
"fees": Money;
}
export interface PayInBankwireResponse {
"debitedFunds"?: Money;
"creditedFunds"?: Money;
"fees"?: Money;
"creditedWalletId"?: string;
"nature"?: PayInBankwireResponseNatureEnum;
"status"?: PayInBankwireResponseStatusEnum;
"executionDate"?: number;
"resultCode"?: string;
"resultMessage"?: string;
"type"?: PayInBankwireResponseTypeEnum;
"paymentType"?: PayInBankwireResponsePaymentTypeEnum;
"executionType"?: PayInBankwireResponseExecutionTypeEnum;
"authorId"?: string;
"creditedUserId"?: string;
"wireReference"?: string;
"bankAccount"?: BankAccountType;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type PayInBankwireResponseNatureEnum = "REGULAR" | "REFUND" | "REPUDIATION" | "SETTLEMENT";
export type PayInBankwireResponseStatusEnum = "CREATED" | "SUCCEEDED" | "FAILED";
export type PayInBankwireResponseTypeEnum = "PAYIN" | "PAYOUT" | "TRANSFER";
export type PayInBankwireResponsePaymentTypeEnum = "NotSpecified" | "CARD" | "BANK_WIRE" | "DIRECT_DEBIT" | "PREAUTHORIZED";
export type PayInBankwireResponseExecutionTypeEnum = "NotSpecified" | "WEB" | "DIRECT";
export interface PayOutBankwirePost {
"tag"?: string;
"debitedFunds"?: Money;
"fees"?: Money;
"bankAccountId"?: string;
"debitedWalletId"?: string;
"bankWireRef"?: string;
}
export interface PayOutBankwireResponse {
"authorId"?: string;
"creditedUserId"?: string;
"debitedFunds"?: Money;
"creditedFunds"?: Money;
"fees"?: Money;
"status"?: PayOutBankwireResponseStatusEnum;
"resultCode"?: string;
"resultMessage"?: string;
"executionDate"?: number;
"type"?: PayOutBankwireResponseTypeEnum;
"nature"?: PayOutBankwireResponseNatureEnum;
"debitedWalletId"?: string;
"creditedWalletId"?: string;
"paymentType"?: PayOutBankwireResponsePaymentTypeEnum;
"bankAccountId"?: string;
"bankWireRef"?: string;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type PayOutBankwireResponseStatusEnum = "CREATED" | "SUCCEEDED" | "FAILED";
export type PayOutBankwireResponseTypeEnum = "PAYIN" | "PAYOUT" | "TRANSFER";
export type PayOutBankwireResponseNatureEnum = "REGULAR" | "REFUND" | "REPUDIATION" | "SETTLEMENT";
export type PayOutBankwireResponsePaymentTypeEnum = "NotSpecified" | "BANK_WIRE";
export interface PaymentRedsysData {
"dsOrder"?: string;
"dsAuthorisationCode"?: string;
}
export interface PaymentUniversalPayData {
"transactionId"?: string;
}
export interface PreauthorizationRedsysData {
"dsOrder"?: string;
"dsAuthorisationCode"?: string;
}
export interface Product {
"insuredValue"?: number;
}
export interface RedsysPayByWebPost {
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* Whether to save or not the card for future use. SaveCard and CardId are mutually exclusive
*/
"saveCard"?: boolean;
/**
* The id of a previous saved card. SaveCard and CardId are mutually exclusive
*/
"cardId"?: string;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId": string;
/**
* A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces
*/
"statementDescriptor"?: string;
/**
* Dirección (relativa a la tienda) a la que redirigirá cuando se haya completado el pago.
*/
"successUrl": string;
/**
* Url to redirect the browser in case the payment is completed successfully
*/
"urlOk"?: string;
/**
* Dirección (relativa a la tienda) a la que redirigirá en caso de error en el pago.
*/
"cancelUrl": string;
/**
* Url to redirect the browser in case the payment is not completed successfully
*/
"urlKo"?: string;
/**
* Information about the funds that are being debited
*/
"debitedFunds": Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees": Money;
}
export interface RedsysPayByWebResponse {
/**
* Id of the payment
*/
"payInId"?: string;
/**
* Url to post from the user's browser
*/
"url"?: string;
/**
* This paramater must be include in the Post to the Url
*/
"dsSignatureVersion"?: string;
/**
* This paramater must be include in the Post to the Url
*/
"dsMerchantParameters"?: string;
/**
* This paramater must be include in the Post to the Url
*/
"dsSignature"?: string;
}
export interface RedsysPayInsResponse {
/**
* Information about the funds that are being debited
*/
"debitedFunds"?: Money;
/**
* Details about the funds that are being credited (DebitedFunds – Fees = CreditedFunds)
*/
"creditedFunds"?: Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees"?: Money;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId"?: string;
/**
* The nature of the transaction
*/
"nature"?: RedsysPayInsResponseNatureEnum;
/**
* The status of the transaction
*/
"status"?: RedsysPayInsResponseStatusEnum;
/**
* When the transaction happened
*/
"executionDate"?: number;
/**
* The result code
*/
"resultCode"?: string;
/**
* A verbal explanation of the ResultCode
*/
"resultMessage"?: string;
/**
* The type of the transaction
*/
"type"?: RedsysPayInsResponseTypeEnum;
/**
* The type of payin
*/
"paymentType"?: RedsysPayInsResponsePaymentTypeEnum;
/**
* The type of execution for the payin
*/
"executionType"?: RedsysPayInsResponseExecutionTypeEnum;
/**
* The Id of the card saved, if any.
*/
"cardId"?: string;
/**
* A custom description to appear on the user's bank statement. It can be up to 10 characters long, and can only include alphanumeric characters or spaces
*/
"statementDescriptor"?: string;
/**
* A user's ID
*/
"authorId"?: string;
/**
* The user ID who was credited
*/
"creditedUserId"?: string;
/**
* Redsys related data
*/
"provider"?: PaymentRedsysData;
"id"?: string;
"creationDate"?: number;
"tag"?: string;
}
export type RedsysPayInsResponseNatureEnum = "REGULAR" | "REFUND" | "REPUDIATION" | "SETTLEMENT";
export type RedsysPayInsResponseStatusEnum = "CREATED" | "SUCCEEDED" | "FAILED";
export type RedsysPayInsResponseTypeEnum = "PAYIN" | "PAYOUT" | "TRANSFER";
export type RedsysPayInsResponsePaymentTypeEnum = "NotSpecified" | "CARD" | "BANK_WIRE" | "DIRECT_DEBIT" | "PREAUTHORIZED";
export type RedsysPayInsResponseExecutionTypeEnum = "NotSpecified" | "WEB" | "DIRECT";
export interface RedsysPreauthorizationCancellationPost {
}
export interface RedsysPreauthorizationCancellationResponse {
}
export interface RedsysPreauthorizationConfirmationPost {
/**
* Custom data that you can add to this item
*/
"tag"?: string;
/**
* The ID of the wallet where money will be credited
*/
"creditedWalletId"?: string;
/**
* Information about the funds that are being debited. This value must be equal o less than the value informed at the Preauthorization creation
*/
"debitedFunds"?: Money;
/**
* Information about the fees that were taken by the client for this transaction (and were hence transferred to the Client's platform wallet)
*/
"fees"?: Money;