@wix/ecom 1.0.722 → 1.0.724
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -4750,7 +4750,7 @@ interface CalculationErrorsNonNullableFields$9 {
|
|
|
4750
4750
|
membershipError?: DetailsNonNullableFields$9;
|
|
4751
4751
|
discountsCalculationError?: DetailsNonNullableFields$9;
|
|
4752
4752
|
}
|
|
4753
|
-
interface MembershipNameNonNullableFields$
|
|
4753
|
+
interface MembershipNameNonNullableFields$b {
|
|
4754
4754
|
original: string;
|
|
4755
4755
|
}
|
|
4756
4756
|
interface MembershipPaymentCreditsNonNullableFields$7 {
|
|
@@ -4760,7 +4760,7 @@ interface MembershipPaymentCreditsNonNullableFields$7 {
|
|
|
4760
4760
|
interface MembershipNonNullableFields$7 {
|
|
4761
4761
|
id: string;
|
|
4762
4762
|
appId: string;
|
|
4763
|
-
name?: MembershipNameNonNullableFields$
|
|
4763
|
+
name?: MembershipNameNonNullableFields$b;
|
|
4764
4764
|
lineItemIds: string[];
|
|
4765
4765
|
credits?: MembershipPaymentCreditsNonNullableFields$7;
|
|
4766
4766
|
}
|
|
@@ -6627,7 +6627,7 @@ interface CalculationErrorsNonNullableFields$8 {
|
|
|
6627
6627
|
membershipError?: DetailsNonNullableFields$8;
|
|
6628
6628
|
discountsCalculationError?: DetailsNonNullableFields$8;
|
|
6629
6629
|
}
|
|
6630
|
-
interface MembershipNameNonNullableFields$
|
|
6630
|
+
interface MembershipNameNonNullableFields$a {
|
|
6631
6631
|
original: string;
|
|
6632
6632
|
}
|
|
6633
6633
|
interface MembershipPaymentCreditsNonNullableFields$6 {
|
|
@@ -6637,7 +6637,7 @@ interface MembershipPaymentCreditsNonNullableFields$6 {
|
|
|
6637
6637
|
interface MembershipNonNullableFields$6 {
|
|
6638
6638
|
_id: string;
|
|
6639
6639
|
appId: string;
|
|
6640
|
-
name?: MembershipNameNonNullableFields$
|
|
6640
|
+
name?: MembershipNameNonNullableFields$a;
|
|
6641
6641
|
lineItemIds: string[];
|
|
6642
6642
|
credits?: MembershipPaymentCreditsNonNullableFields$6;
|
|
6643
6643
|
}
|
|
@@ -8596,7 +8596,7 @@ interface CalculationErrorsNonNullableFields$7 {
|
|
|
8596
8596
|
membershipError?: DetailsNonNullableFields$7;
|
|
8597
8597
|
discountsCalculationError?: DetailsNonNullableFields$7;
|
|
8598
8598
|
}
|
|
8599
|
-
interface MembershipNameNonNullableFields$
|
|
8599
|
+
interface MembershipNameNonNullableFields$9 {
|
|
8600
8600
|
original: string;
|
|
8601
8601
|
}
|
|
8602
8602
|
interface MembershipPaymentCreditsNonNullableFields$5 {
|
|
@@ -8606,7 +8606,7 @@ interface MembershipPaymentCreditsNonNullableFields$5 {
|
|
|
8606
8606
|
interface MembershipNonNullableFields$5 {
|
|
8607
8607
|
id: string;
|
|
8608
8608
|
appId: string;
|
|
8609
|
-
name?: MembershipNameNonNullableFields$
|
|
8609
|
+
name?: MembershipNameNonNullableFields$9;
|
|
8610
8610
|
lineItemIds: string[];
|
|
8611
8611
|
credits?: MembershipPaymentCreditsNonNullableFields$5;
|
|
8612
8612
|
}
|
|
@@ -10433,7 +10433,7 @@ interface CalculationErrorsNonNullableFields$6 {
|
|
|
10433
10433
|
membershipError?: DetailsNonNullableFields$6;
|
|
10434
10434
|
discountsCalculationError?: DetailsNonNullableFields$6;
|
|
10435
10435
|
}
|
|
10436
|
-
interface MembershipNameNonNullableFields$
|
|
10436
|
+
interface MembershipNameNonNullableFields$8 {
|
|
10437
10437
|
original: string;
|
|
10438
10438
|
}
|
|
10439
10439
|
interface MembershipPaymentCreditsNonNullableFields$4 {
|
|
@@ -10443,7 +10443,7 @@ interface MembershipPaymentCreditsNonNullableFields$4 {
|
|
|
10443
10443
|
interface MembershipNonNullableFields$4 {
|
|
10444
10444
|
_id: string;
|
|
10445
10445
|
appId: string;
|
|
10446
|
-
name?: MembershipNameNonNullableFields$
|
|
10446
|
+
name?: MembershipNameNonNullableFields$8;
|
|
10447
10447
|
lineItemIds: string[];
|
|
10448
10448
|
credits?: MembershipPaymentCreditsNonNullableFields$4;
|
|
10449
10449
|
}
|
|
@@ -12540,7 +12540,7 @@ interface CreatedByNonNullableFields$5 {
|
|
|
12540
12540
|
visitorId: string;
|
|
12541
12541
|
appId: string;
|
|
12542
12542
|
}
|
|
12543
|
-
interface MembershipNameNonNullableFields$
|
|
12543
|
+
interface MembershipNameNonNullableFields$7 {
|
|
12544
12544
|
original: string;
|
|
12545
12545
|
}
|
|
12546
12546
|
interface MembershipPaymentCreditsNonNullableFields$3 {
|
|
@@ -12550,7 +12550,7 @@ interface MembershipPaymentCreditsNonNullableFields$3 {
|
|
|
12550
12550
|
interface MembershipNonNullableFields$3 {
|
|
12551
12551
|
id: string;
|
|
12552
12552
|
appId: string;
|
|
12553
|
-
name?: MembershipNameNonNullableFields$
|
|
12553
|
+
name?: MembershipNameNonNullableFields$7;
|
|
12554
12554
|
lineItemIds: string[];
|
|
12555
12555
|
credits?: MembershipPaymentCreditsNonNullableFields$3;
|
|
12556
12556
|
}
|
|
@@ -14604,7 +14604,7 @@ interface CreatedByNonNullableFields$4 {
|
|
|
14604
14604
|
visitorId: string;
|
|
14605
14605
|
appId: string;
|
|
14606
14606
|
}
|
|
14607
|
-
interface MembershipNameNonNullableFields$
|
|
14607
|
+
interface MembershipNameNonNullableFields$6 {
|
|
14608
14608
|
original: string;
|
|
14609
14609
|
}
|
|
14610
14610
|
interface MembershipPaymentCreditsNonNullableFields$2 {
|
|
@@ -14614,7 +14614,7 @@ interface MembershipPaymentCreditsNonNullableFields$2 {
|
|
|
14614
14614
|
interface MembershipNonNullableFields$2 {
|
|
14615
14615
|
_id: string;
|
|
14616
14616
|
appId: string;
|
|
14617
|
-
name?: MembershipNameNonNullableFields$
|
|
14617
|
+
name?: MembershipNameNonNullableFields$6;
|
|
14618
14618
|
lineItemIds: string[];
|
|
14619
14619
|
credits?: MembershipPaymentCreditsNonNullableFields$2;
|
|
14620
14620
|
}
|
|
@@ -18533,6 +18533,11 @@ interface BalanceSummary$3 {
|
|
|
18533
18533
|
* @readonly
|
|
18534
18534
|
*/
|
|
18535
18535
|
balance?: Balance$3;
|
|
18536
|
+
/**
|
|
18537
|
+
* Sum of all authorized payments.
|
|
18538
|
+
* @readonly
|
|
18539
|
+
*/
|
|
18540
|
+
authorized?: Price$7;
|
|
18536
18541
|
}
|
|
18537
18542
|
/**
|
|
18538
18543
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -19350,7 +19355,10 @@ declare enum ActivityType$3 {
|
|
|
19350
19355
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
19351
19356
|
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
19352
19357
|
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
19353
|
-
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED"
|
|
19358
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
19359
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
19360
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
19361
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED"
|
|
19354
19362
|
}
|
|
19355
19363
|
declare enum AttributionSource$3 {
|
|
19356
19364
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -20030,6 +20038,27 @@ interface AuthorizedPaymentVoidedNonNullableFields$3 {
|
|
|
20030
20038
|
paymentId: string;
|
|
20031
20039
|
amount?: PriceNonNullableFields$7;
|
|
20032
20040
|
}
|
|
20041
|
+
interface RegularPaymentRefundNonNullableFields$3 {
|
|
20042
|
+
amount?: PriceNonNullableFields$7;
|
|
20043
|
+
}
|
|
20044
|
+
interface RefundedPaymentNonNullableFields$3 {
|
|
20045
|
+
regular?: RegularPaymentRefundNonNullableFields$3;
|
|
20046
|
+
paymentId: string;
|
|
20047
|
+
externalRefund: boolean;
|
|
20048
|
+
}
|
|
20049
|
+
interface RefundInitiatedNonNullableFields$3 {
|
|
20050
|
+
refundId: string;
|
|
20051
|
+
amount?: PriceNonNullableFields$7;
|
|
20052
|
+
payments: RefundedPaymentNonNullableFields$3[];
|
|
20053
|
+
}
|
|
20054
|
+
interface PaymentRefundedNonNullableFields$3 {
|
|
20055
|
+
refundId: string;
|
|
20056
|
+
payment?: RefundedPaymentNonNullableFields$3;
|
|
20057
|
+
}
|
|
20058
|
+
interface PaymentRefundFailedNonNullableFields$3 {
|
|
20059
|
+
refundId: string;
|
|
20060
|
+
payment?: RefundedPaymentNonNullableFields$3;
|
|
20061
|
+
}
|
|
20033
20062
|
interface ActivityNonNullableFields$3 {
|
|
20034
20063
|
customActivity?: CustomActivityNonNullableFields$3;
|
|
20035
20064
|
merchantComment?: MerchantCommentNonNullableFields$3;
|
|
@@ -20041,6 +20070,9 @@ interface ActivityNonNullableFields$3 {
|
|
|
20041
20070
|
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields$3;
|
|
20042
20071
|
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields$3;
|
|
20043
20072
|
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields$3;
|
|
20073
|
+
refundInitiated?: RefundInitiatedNonNullableFields$3;
|
|
20074
|
+
paymentRefunded?: PaymentRefundedNonNullableFields$3;
|
|
20075
|
+
paymentRefundFailed?: PaymentRefundFailedNonNullableFields$3;
|
|
20044
20076
|
type: ActivityType$3;
|
|
20045
20077
|
}
|
|
20046
20078
|
interface V1CreatedByNonNullableFields$1 {
|
|
@@ -20996,6 +21028,11 @@ interface BalanceSummary$2 {
|
|
|
20996
21028
|
* @readonly
|
|
20997
21029
|
*/
|
|
20998
21030
|
balance?: Balance$2;
|
|
21031
|
+
/**
|
|
21032
|
+
* Sum of all authorized payments.
|
|
21033
|
+
* @readonly
|
|
21034
|
+
*/
|
|
21035
|
+
authorized?: Price$6;
|
|
20999
21036
|
}
|
|
21000
21037
|
/**
|
|
21001
21038
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -21807,7 +21844,10 @@ declare enum ActivityType$2 {
|
|
|
21807
21844
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
21808
21845
|
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
21809
21846
|
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
21810
|
-
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED"
|
|
21847
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
21848
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
21849
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
21850
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED"
|
|
21811
21851
|
}
|
|
21812
21852
|
declare enum AttributionSource$2 {
|
|
21813
21853
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -22481,6 +22521,27 @@ interface AuthorizedPaymentVoidedNonNullableFields$2 {
|
|
|
22481
22521
|
paymentId: string;
|
|
22482
22522
|
amount?: PriceNonNullableFields$6;
|
|
22483
22523
|
}
|
|
22524
|
+
interface RegularPaymentRefundNonNullableFields$2 {
|
|
22525
|
+
amount?: PriceNonNullableFields$6;
|
|
22526
|
+
}
|
|
22527
|
+
interface RefundedPaymentNonNullableFields$2 {
|
|
22528
|
+
regular?: RegularPaymentRefundNonNullableFields$2;
|
|
22529
|
+
paymentId: string;
|
|
22530
|
+
externalRefund: boolean;
|
|
22531
|
+
}
|
|
22532
|
+
interface RefundInitiatedNonNullableFields$2 {
|
|
22533
|
+
refundId: string;
|
|
22534
|
+
amount?: PriceNonNullableFields$6;
|
|
22535
|
+
payments: RefundedPaymentNonNullableFields$2[];
|
|
22536
|
+
}
|
|
22537
|
+
interface PaymentRefundedNonNullableFields$2 {
|
|
22538
|
+
refundId: string;
|
|
22539
|
+
payment?: RefundedPaymentNonNullableFields$2;
|
|
22540
|
+
}
|
|
22541
|
+
interface PaymentRefundFailedNonNullableFields$2 {
|
|
22542
|
+
refundId: string;
|
|
22543
|
+
payment?: RefundedPaymentNonNullableFields$2;
|
|
22544
|
+
}
|
|
22484
22545
|
interface ActivityNonNullableFields$2 {
|
|
22485
22546
|
customActivity?: CustomActivityNonNullableFields$2;
|
|
22486
22547
|
merchantComment?: MerchantCommentNonNullableFields$2;
|
|
@@ -22492,6 +22553,9 @@ interface ActivityNonNullableFields$2 {
|
|
|
22492
22553
|
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields$2;
|
|
22493
22554
|
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields$2;
|
|
22494
22555
|
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields$2;
|
|
22556
|
+
refundInitiated?: RefundInitiatedNonNullableFields$2;
|
|
22557
|
+
paymentRefunded?: PaymentRefundedNonNullableFields$2;
|
|
22558
|
+
paymentRefundFailed?: PaymentRefundFailedNonNullableFields$2;
|
|
22495
22559
|
type: ActivityType$2;
|
|
22496
22560
|
}
|
|
22497
22561
|
interface V1CreatedByNonNullableFields {
|
|
@@ -24721,7 +24785,10 @@ declare enum ActivityType$1 {
|
|
|
24721
24785
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
24722
24786
|
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
24723
24787
|
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
24724
|
-
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED"
|
|
24788
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
24789
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
24790
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
24791
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED"
|
|
24725
24792
|
}
|
|
24726
24793
|
declare enum AttributionSource$1 {
|
|
24727
24794
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -24867,6 +24934,259 @@ interface ExtendedFields$7 {
|
|
|
24867
24934
|
*/
|
|
24868
24935
|
namespaces?: Record<string, Record<string, any>>;
|
|
24869
24936
|
}
|
|
24937
|
+
interface OrderTransactions$3 {
|
|
24938
|
+
/** Order ID. */
|
|
24939
|
+
orderId?: string;
|
|
24940
|
+
/** Record of payments made to the merchant. */
|
|
24941
|
+
payments?: Payment$3[];
|
|
24942
|
+
/** Record of refunds made to the buyer. */
|
|
24943
|
+
refunds?: Refund$3[];
|
|
24944
|
+
}
|
|
24945
|
+
interface Payment$3 extends PaymentPaymentDetailsOneOf$3 {
|
|
24946
|
+
/** Regular payment details. */
|
|
24947
|
+
regularPaymentDetails?: RegularPaymentDetails$3;
|
|
24948
|
+
/** Gift card payment details. */
|
|
24949
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$3;
|
|
24950
|
+
/**
|
|
24951
|
+
* Payment ID.
|
|
24952
|
+
* @readonly
|
|
24953
|
+
*/
|
|
24954
|
+
id?: string | null;
|
|
24955
|
+
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
24956
|
+
createdDate?: Date;
|
|
24957
|
+
/**
|
|
24958
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
24959
|
+
* @readonly
|
|
24960
|
+
*/
|
|
24961
|
+
updatedDate?: Date;
|
|
24962
|
+
/** Payment amount. */
|
|
24963
|
+
amount?: Price$5;
|
|
24964
|
+
/**
|
|
24965
|
+
* Whether refunds for this payment are disabled.
|
|
24966
|
+
* + `true`: This payment is not refundable.
|
|
24967
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
24968
|
+
*/
|
|
24969
|
+
refundDisabled?: boolean;
|
|
24970
|
+
}
|
|
24971
|
+
/** @oneof */
|
|
24972
|
+
interface PaymentPaymentDetailsOneOf$3 {
|
|
24973
|
+
/** Regular payment details. */
|
|
24974
|
+
regularPaymentDetails?: RegularPaymentDetails$3;
|
|
24975
|
+
/** Gift card payment details. */
|
|
24976
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$3;
|
|
24977
|
+
}
|
|
24978
|
+
interface RegularPaymentDetails$3 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$3 {
|
|
24979
|
+
/** Whether regular card used */
|
|
24980
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$3;
|
|
24981
|
+
/** Wix Payments order ID. */
|
|
24982
|
+
paymentOrderId?: string | null;
|
|
24983
|
+
/**
|
|
24984
|
+
* Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).
|
|
24985
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
24986
|
+
*/
|
|
24987
|
+
gatewayTransactionId?: string | null;
|
|
24988
|
+
/**
|
|
24989
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
24990
|
+
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
24991
|
+
*/
|
|
24992
|
+
paymentMethod?: string | null;
|
|
24993
|
+
/** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */
|
|
24994
|
+
providerTransactionId?: string | null;
|
|
24995
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
24996
|
+
offlinePayment?: boolean;
|
|
24997
|
+
/** Payment status. */
|
|
24998
|
+
status?: TransactionStatus$3;
|
|
24999
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
25000
|
+
savedPaymentMethod?: boolean;
|
|
25001
|
+
/** Authorization details. */
|
|
25002
|
+
authorizationDetails?: AuthorizationDetails$3;
|
|
25003
|
+
}
|
|
25004
|
+
/** @oneof */
|
|
25005
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$3 {
|
|
25006
|
+
/** Whether regular card used */
|
|
25007
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$3;
|
|
25008
|
+
}
|
|
25009
|
+
declare enum TransactionStatus$3 {
|
|
25010
|
+
UNDEFINED = "UNDEFINED",
|
|
25011
|
+
APPROVED = "APPROVED",
|
|
25012
|
+
PENDING = "PENDING",
|
|
25013
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
25014
|
+
CANCELED = "CANCELED",
|
|
25015
|
+
DECLINED = "DECLINED",
|
|
25016
|
+
REFUNDED = "REFUNDED",
|
|
25017
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
25018
|
+
AUTHORIZED = "AUTHORIZED",
|
|
25019
|
+
VOIDED = "VOIDED"
|
|
25020
|
+
}
|
|
25021
|
+
interface CreditCardPaymentMethodDetails$3 {
|
|
25022
|
+
/** The last 4 digits of the card number. */
|
|
25023
|
+
lastFourDigits?: string | null;
|
|
25024
|
+
/** Card issuer's brand. */
|
|
25025
|
+
brand?: string | null;
|
|
25026
|
+
}
|
|
25027
|
+
interface AuthorizationDetails$3 {
|
|
25028
|
+
/**
|
|
25029
|
+
* Whether the authorized payment is of a delayed capture.
|
|
25030
|
+
* @readonly
|
|
25031
|
+
*/
|
|
25032
|
+
delayedCapture?: boolean;
|
|
25033
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
25034
|
+
authorizedDate?: Date;
|
|
25035
|
+
/**
|
|
25036
|
+
* List of captures associated with payment
|
|
25037
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
25038
|
+
*/
|
|
25039
|
+
captures?: AuthorizationCapture$3[];
|
|
25040
|
+
/** Void associated with payment */
|
|
25041
|
+
void?: AuthorizationVoid$3;
|
|
25042
|
+
/** Scheduled action for this transaction */
|
|
25043
|
+
scheduledAction?: ScheduledAction$3;
|
|
25044
|
+
}
|
|
25045
|
+
interface AuthorizationCapture$3 {
|
|
25046
|
+
/**
|
|
25047
|
+
* Capture ID.
|
|
25048
|
+
* @readonly
|
|
25049
|
+
*/
|
|
25050
|
+
id?: string | null;
|
|
25051
|
+
/** Status of this capture action */
|
|
25052
|
+
status?: AuthorizationCaptureStatus$3;
|
|
25053
|
+
/** Amount of this capture */
|
|
25054
|
+
amount?: Price$5;
|
|
25055
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
25056
|
+
createdDate?: Date;
|
|
25057
|
+
/** In case of status is FAILED may contain failure details */
|
|
25058
|
+
failureDetails?: AuthorizationActionFailureDetails$3;
|
|
25059
|
+
}
|
|
25060
|
+
declare enum AuthorizationCaptureStatus$3 {
|
|
25061
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
25062
|
+
/** Whether capture operation still in progress */
|
|
25063
|
+
PENDING = "PENDING",
|
|
25064
|
+
/** The capture operation was succeeded */
|
|
25065
|
+
SUCCEEDED = "SUCCEEDED",
|
|
25066
|
+
/** The capture operation was failed */
|
|
25067
|
+
FAILED = "FAILED"
|
|
25068
|
+
}
|
|
25069
|
+
interface AuthorizationActionFailureDetails$3 {
|
|
25070
|
+
failureCode?: string;
|
|
25071
|
+
}
|
|
25072
|
+
interface AuthorizationVoid$3 {
|
|
25073
|
+
/** Status of this void action */
|
|
25074
|
+
status?: AuthorizationVoidStatus$3;
|
|
25075
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
25076
|
+
voidedDate?: Date;
|
|
25077
|
+
/** In case of status is FAILED may contain failure details */
|
|
25078
|
+
failureDetails?: AuthorizationActionFailureDetails$3;
|
|
25079
|
+
/** Reason of void action */
|
|
25080
|
+
reason?: Reason$3;
|
|
25081
|
+
}
|
|
25082
|
+
declare enum AuthorizationVoidStatus$3 {
|
|
25083
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
25084
|
+
/** Whether void operation still in progress */
|
|
25085
|
+
PENDING = "PENDING",
|
|
25086
|
+
/** The void operation was succeeded */
|
|
25087
|
+
SUCCEEDED = "SUCCEEDED",
|
|
25088
|
+
/** The void operation was failed */
|
|
25089
|
+
FAILED = "FAILED"
|
|
25090
|
+
}
|
|
25091
|
+
/**
|
|
25092
|
+
* Reason the authorization was voided.
|
|
25093
|
+
*
|
|
25094
|
+
* + `MANUAL`: Authorization was voided by user.
|
|
25095
|
+
* + `SCHEDULED`: Authorization passed execution date.
|
|
25096
|
+
*/
|
|
25097
|
+
declare enum Reason$3 {
|
|
25098
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
25099
|
+
MANUAL = "MANUAL",
|
|
25100
|
+
SCHEDULED = "SCHEDULED"
|
|
25101
|
+
}
|
|
25102
|
+
interface ScheduledAction$3 {
|
|
25103
|
+
/** type of the action */
|
|
25104
|
+
actionType?: ActionType$3;
|
|
25105
|
+
/** the date and time of the action */
|
|
25106
|
+
executionDate?: Date;
|
|
25107
|
+
}
|
|
25108
|
+
declare enum ActionType$3 {
|
|
25109
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
25110
|
+
VOID = "VOID",
|
|
25111
|
+
CAPTURE = "CAPTURE"
|
|
25112
|
+
}
|
|
25113
|
+
interface GiftCardPaymentDetails$3 {
|
|
25114
|
+
/** Gift card payment ID. */
|
|
25115
|
+
giftCardPaymentId?: string;
|
|
25116
|
+
/** ID of the app that created the gift card. */
|
|
25117
|
+
appId?: string;
|
|
25118
|
+
/**
|
|
25119
|
+
* Whether the gift card is voided.
|
|
25120
|
+
* @readonly
|
|
25121
|
+
*/
|
|
25122
|
+
voided?: boolean;
|
|
25123
|
+
}
|
|
25124
|
+
declare enum MembershipPaymentStatus$3 {
|
|
25125
|
+
/** CHARGED - Payment was charged */
|
|
25126
|
+
CHARGED = "CHARGED",
|
|
25127
|
+
/** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
|
|
25128
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
25129
|
+
}
|
|
25130
|
+
interface Refund$3 {
|
|
25131
|
+
/**
|
|
25132
|
+
* Refund ID.
|
|
25133
|
+
* @readonly
|
|
25134
|
+
*/
|
|
25135
|
+
id?: string;
|
|
25136
|
+
/** List of transactions. */
|
|
25137
|
+
transactions?: RefundTransaction$3[];
|
|
25138
|
+
/** Refund business details. */
|
|
25139
|
+
details?: RefundDetails$3;
|
|
25140
|
+
/** Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
25141
|
+
createdDate?: Date;
|
|
25142
|
+
}
|
|
25143
|
+
interface RefundTransaction$3 {
|
|
25144
|
+
/** ID of the payment associated with this refund. */
|
|
25145
|
+
paymentId?: string;
|
|
25146
|
+
/** Refund amount. */
|
|
25147
|
+
amount?: Price$5;
|
|
25148
|
+
/** Refund status. */
|
|
25149
|
+
refundStatus?: RefundStatus$3;
|
|
25150
|
+
/**
|
|
25151
|
+
* Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).
|
|
25152
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
25153
|
+
*/
|
|
25154
|
+
gatewayRefundId?: string | null;
|
|
25155
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
25156
|
+
providerRefundId?: string | null;
|
|
25157
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
25158
|
+
externalRefund?: boolean;
|
|
25159
|
+
}
|
|
25160
|
+
/**
|
|
25161
|
+
* Refund transaction status.
|
|
25162
|
+
* + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
|
|
25163
|
+
* + `SUCCEEDED`: Refund transaction succeeded.
|
|
25164
|
+
* + `FAILED`: Refund transaction failed.
|
|
25165
|
+
* + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
|
|
25166
|
+
* + `STARTED`: Refund was initiated on payment provider side.
|
|
25167
|
+
*/
|
|
25168
|
+
declare enum RefundStatus$3 {
|
|
25169
|
+
PENDING = "PENDING",
|
|
25170
|
+
SUCCEEDED = "SUCCEEDED",
|
|
25171
|
+
FAILED = "FAILED",
|
|
25172
|
+
SCHEDULED = "SCHEDULED",
|
|
25173
|
+
STARTED = "STARTED"
|
|
25174
|
+
}
|
|
25175
|
+
/** Business model of a refund request */
|
|
25176
|
+
interface RefundDetails$3 {
|
|
25177
|
+
/** Order line item IDs and quantities that were refunded. */
|
|
25178
|
+
items?: RefundItem$3[];
|
|
25179
|
+
/** Whether the shipping fee was also refunded. */
|
|
25180
|
+
shippingIncluded?: boolean;
|
|
25181
|
+
/** Reason for the refund, provided by customer (optional). */
|
|
25182
|
+
reason?: string | null;
|
|
25183
|
+
}
|
|
25184
|
+
interface RefundItem$3 {
|
|
25185
|
+
/** Line item ID the refunded line item. */
|
|
25186
|
+
lineItemId?: string;
|
|
25187
|
+
/** Line item quantity refunded. */
|
|
25188
|
+
quantity?: number;
|
|
25189
|
+
}
|
|
24870
25190
|
interface Sorting$9 {
|
|
24871
25191
|
/** Name of the field to sort by. */
|
|
24872
25192
|
fieldName?: string;
|
|
@@ -24947,6 +25267,35 @@ interface BulkActionMetadata$3 {
|
|
|
24947
25267
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
24948
25268
|
undetailedFailures?: number;
|
|
24949
25269
|
}
|
|
25270
|
+
interface VoidAuthorizedPaymentsRequest$1 {
|
|
25271
|
+
/** Wix eCommerce order ID */
|
|
25272
|
+
ecomOrderId: string;
|
|
25273
|
+
/** Payment IDs */
|
|
25274
|
+
paymentIds: string[];
|
|
25275
|
+
}
|
|
25276
|
+
interface VoidAuthorizedPaymentsResponse$1 {
|
|
25277
|
+
/** All order's transactions after the void was triggered */
|
|
25278
|
+
orderTransactions?: OrderTransactions$3;
|
|
25279
|
+
}
|
|
25280
|
+
interface CaptureAuthorizedPaymentsRequest$1 {
|
|
25281
|
+
/** Wix eCommerce order ID */
|
|
25282
|
+
ecomOrderId: string;
|
|
25283
|
+
/** Capture payments information */
|
|
25284
|
+
payments: PaymentCapture$1[];
|
|
25285
|
+
}
|
|
25286
|
+
interface PaymentCapture$1 {
|
|
25287
|
+
/** Payment ID */
|
|
25288
|
+
paymentId?: string | null;
|
|
25289
|
+
/**
|
|
25290
|
+
* Capture amount.
|
|
25291
|
+
* If not provided - full authorized amount will be captured.
|
|
25292
|
+
*/
|
|
25293
|
+
amount?: Price$5;
|
|
25294
|
+
}
|
|
25295
|
+
interface CaptureAuthorizedPaymentsResponse$1 {
|
|
25296
|
+
/** All order's transactions after the capture was triggered */
|
|
25297
|
+
orderTransactions?: OrderTransactions$3;
|
|
25298
|
+
}
|
|
24950
25299
|
interface GetOrderRequest$1 {
|
|
24951
25300
|
/** ID of the order to retrieve. */
|
|
24952
25301
|
id: string;
|
|
@@ -25072,29 +25421,133 @@ interface GetPaymentCollectabilityStatusResponseNonNullableFields$1 {
|
|
|
25072
25421
|
amount?: PriceNonNullableFields$5;
|
|
25073
25422
|
authorizationSupported: boolean;
|
|
25074
25423
|
}
|
|
25075
|
-
interface
|
|
25076
|
-
|
|
25077
|
-
}
|
|
25078
|
-
interface CatalogReferenceNonNullableFields$1 {
|
|
25079
|
-
catalogItemId: string;
|
|
25080
|
-
appId: string;
|
|
25424
|
+
interface AuthorizationActionFailureDetailsNonNullableFields$3 {
|
|
25425
|
+
failureCode: string;
|
|
25081
25426
|
}
|
|
25082
|
-
interface
|
|
25083
|
-
|
|
25427
|
+
interface AuthorizationCaptureNonNullableFields$3 {
|
|
25428
|
+
status: AuthorizationCaptureStatus$3;
|
|
25429
|
+
amount?: PriceNonNullableFields$5;
|
|
25430
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$3;
|
|
25084
25431
|
}
|
|
25085
|
-
interface
|
|
25086
|
-
|
|
25432
|
+
interface AuthorizationVoidNonNullableFields$3 {
|
|
25433
|
+
status: AuthorizationVoidStatus$3;
|
|
25434
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$3;
|
|
25435
|
+
reason: Reason$3;
|
|
25087
25436
|
}
|
|
25088
|
-
interface
|
|
25089
|
-
|
|
25437
|
+
interface ScheduledActionNonNullableFields$3 {
|
|
25438
|
+
actionType: ActionType$3;
|
|
25090
25439
|
}
|
|
25091
|
-
interface
|
|
25092
|
-
|
|
25093
|
-
|
|
25094
|
-
|
|
25095
|
-
|
|
25096
|
-
|
|
25097
|
-
|
|
25440
|
+
interface AuthorizationDetailsNonNullableFields$3 {
|
|
25441
|
+
delayedCapture: boolean;
|
|
25442
|
+
captures: AuthorizationCaptureNonNullableFields$3[];
|
|
25443
|
+
void?: AuthorizationVoidNonNullableFields$3;
|
|
25444
|
+
scheduledAction?: ScheduledActionNonNullableFields$3;
|
|
25445
|
+
}
|
|
25446
|
+
interface RegularPaymentDetailsNonNullableFields$3 {
|
|
25447
|
+
offlinePayment: boolean;
|
|
25448
|
+
status: TransactionStatus$3;
|
|
25449
|
+
savedPaymentMethod: boolean;
|
|
25450
|
+
authorizationDetails?: AuthorizationDetailsNonNullableFields$3;
|
|
25451
|
+
}
|
|
25452
|
+
interface GiftCardPaymentDetailsNonNullableFields$3 {
|
|
25453
|
+
giftCardPaymentId: string;
|
|
25454
|
+
giftCardId: string;
|
|
25455
|
+
appId: string;
|
|
25456
|
+
voided: boolean;
|
|
25457
|
+
}
|
|
25458
|
+
interface MembershipNameNonNullableFields$5 {
|
|
25459
|
+
original: string;
|
|
25460
|
+
}
|
|
25461
|
+
interface MembershipPaymentDetailsNonNullableFields$3 {
|
|
25462
|
+
membershipId: string;
|
|
25463
|
+
lineItemId: string;
|
|
25464
|
+
status: MembershipPaymentStatus$3;
|
|
25465
|
+
name?: MembershipNameNonNullableFields$5;
|
|
25466
|
+
voided: boolean;
|
|
25467
|
+
providerAppId: string;
|
|
25468
|
+
}
|
|
25469
|
+
interface PaymentNonNullableFields$3 {
|
|
25470
|
+
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields$3;
|
|
25471
|
+
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields$3;
|
|
25472
|
+
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields$3;
|
|
25473
|
+
amount?: PriceNonNullableFields$5;
|
|
25474
|
+
refundDisabled: boolean;
|
|
25475
|
+
}
|
|
25476
|
+
interface RefundTransactionNonNullableFields$3 {
|
|
25477
|
+
paymentId: string;
|
|
25478
|
+
amount?: PriceNonNullableFields$5;
|
|
25479
|
+
refundStatus: RefundStatus$3;
|
|
25480
|
+
externalRefund: boolean;
|
|
25481
|
+
}
|
|
25482
|
+
interface RefundItemNonNullableFields$3 {
|
|
25483
|
+
lineItemId: string;
|
|
25484
|
+
quantity: number;
|
|
25485
|
+
}
|
|
25486
|
+
interface LineItemRefundNonNullableFields$3 {
|
|
25487
|
+
lineItemId: string;
|
|
25488
|
+
quantity: number;
|
|
25489
|
+
}
|
|
25490
|
+
interface AdditionalFeeRefundNonNullableFields$3 {
|
|
25491
|
+
additionalFeeId: string;
|
|
25492
|
+
amount?: PriceNonNullableFields$5;
|
|
25493
|
+
}
|
|
25494
|
+
interface ShippingRefundNonNullableFields$3 {
|
|
25495
|
+
amount?: PriceNonNullableFields$5;
|
|
25496
|
+
}
|
|
25497
|
+
interface RefundDetailsNonNullableFields$3 {
|
|
25498
|
+
items: RefundItemNonNullableFields$3[];
|
|
25499
|
+
shippingIncluded: boolean;
|
|
25500
|
+
lineItems: LineItemRefundNonNullableFields$3[];
|
|
25501
|
+
additionalFees: AdditionalFeeRefundNonNullableFields$3[];
|
|
25502
|
+
shipping?: ShippingRefundNonNullableFields$3;
|
|
25503
|
+
}
|
|
25504
|
+
interface AggregatedRefundSummaryNonNullableFields$3 {
|
|
25505
|
+
requestedRefund?: PriceNonNullableFields$5;
|
|
25506
|
+
pendingRefund?: PriceNonNullableFields$5;
|
|
25507
|
+
refunded?: PriceNonNullableFields$5;
|
|
25508
|
+
failedRefundAmount?: PriceNonNullableFields$5;
|
|
25509
|
+
pending: boolean;
|
|
25510
|
+
}
|
|
25511
|
+
interface RefundNonNullableFields$3 {
|
|
25512
|
+
id: string;
|
|
25513
|
+
transactions: RefundTransactionNonNullableFields$3[];
|
|
25514
|
+
details?: RefundDetailsNonNullableFields$3;
|
|
25515
|
+
summary?: AggregatedRefundSummaryNonNullableFields$3;
|
|
25516
|
+
}
|
|
25517
|
+
interface OrderTransactionsNonNullableFields$3 {
|
|
25518
|
+
orderId: string;
|
|
25519
|
+
payments: PaymentNonNullableFields$3[];
|
|
25520
|
+
refunds: RefundNonNullableFields$3[];
|
|
25521
|
+
}
|
|
25522
|
+
interface VoidAuthorizedPaymentsResponseNonNullableFields$1 {
|
|
25523
|
+
orderTransactions?: OrderTransactionsNonNullableFields$3;
|
|
25524
|
+
}
|
|
25525
|
+
interface CaptureAuthorizedPaymentsResponseNonNullableFields$1 {
|
|
25526
|
+
orderTransactions?: OrderTransactionsNonNullableFields$3;
|
|
25527
|
+
}
|
|
25528
|
+
interface ProductNameNonNullableFields$1 {
|
|
25529
|
+
original: string;
|
|
25530
|
+
}
|
|
25531
|
+
interface CatalogReferenceNonNullableFields$1 {
|
|
25532
|
+
catalogItemId: string;
|
|
25533
|
+
appId: string;
|
|
25534
|
+
}
|
|
25535
|
+
interface PlainTextValueNonNullableFields$1 {
|
|
25536
|
+
original: string;
|
|
25537
|
+
}
|
|
25538
|
+
interface ColorNonNullableFields$1 {
|
|
25539
|
+
original: string;
|
|
25540
|
+
}
|
|
25541
|
+
interface DescriptionLineNameNonNullableFields$1 {
|
|
25542
|
+
original: string;
|
|
25543
|
+
}
|
|
25544
|
+
interface DescriptionLineNonNullableFields$1 {
|
|
25545
|
+
plainText?: PlainTextValueNonNullableFields$1;
|
|
25546
|
+
colorInfo?: ColorNonNullableFields$1;
|
|
25547
|
+
plainTextValue?: PlainTextValueNonNullableFields$1;
|
|
25548
|
+
color: string;
|
|
25549
|
+
name?: DescriptionLineNameNonNullableFields$1;
|
|
25550
|
+
lineType: DescriptionLineType$1;
|
|
25098
25551
|
}
|
|
25099
25552
|
interface ImageNonNullableFields$1 {
|
|
25100
25553
|
id: string;
|
|
@@ -25378,6 +25831,27 @@ interface AuthorizedPaymentVoidedNonNullableFields$1 {
|
|
|
25378
25831
|
paymentId: string;
|
|
25379
25832
|
amount?: PriceNonNullableFields$5;
|
|
25380
25833
|
}
|
|
25834
|
+
interface RegularPaymentRefundNonNullableFields$1 {
|
|
25835
|
+
amount?: PriceNonNullableFields$5;
|
|
25836
|
+
}
|
|
25837
|
+
interface RefundedPaymentNonNullableFields$1 {
|
|
25838
|
+
regular?: RegularPaymentRefundNonNullableFields$1;
|
|
25839
|
+
paymentId: string;
|
|
25840
|
+
externalRefund: boolean;
|
|
25841
|
+
}
|
|
25842
|
+
interface RefundInitiatedNonNullableFields$1 {
|
|
25843
|
+
refundId: string;
|
|
25844
|
+
amount?: PriceNonNullableFields$5;
|
|
25845
|
+
payments: RefundedPaymentNonNullableFields$1[];
|
|
25846
|
+
}
|
|
25847
|
+
interface PaymentRefundedNonNullableFields$1 {
|
|
25848
|
+
refundId: string;
|
|
25849
|
+
payment?: RefundedPaymentNonNullableFields$1;
|
|
25850
|
+
}
|
|
25851
|
+
interface PaymentRefundFailedNonNullableFields$1 {
|
|
25852
|
+
refundId: string;
|
|
25853
|
+
payment?: RefundedPaymentNonNullableFields$1;
|
|
25854
|
+
}
|
|
25381
25855
|
interface ActivityNonNullableFields$1 {
|
|
25382
25856
|
customActivity?: CustomActivityNonNullableFields$1;
|
|
25383
25857
|
merchantComment?: MerchantCommentNonNullableFields$1;
|
|
@@ -25389,6 +25863,9 @@ interface ActivityNonNullableFields$1 {
|
|
|
25389
25863
|
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields$1;
|
|
25390
25864
|
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields$1;
|
|
25391
25865
|
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields$1;
|
|
25866
|
+
refundInitiated?: RefundInitiatedNonNullableFields$1;
|
|
25867
|
+
paymentRefunded?: PaymentRefundedNonNullableFields$1;
|
|
25868
|
+
paymentRefundFailed?: PaymentRefundFailedNonNullableFields$1;
|
|
25392
25869
|
type: ActivityType$1;
|
|
25393
25870
|
}
|
|
25394
25871
|
interface CreatedByNonNullableFields$1 {
|
|
@@ -26424,7 +26901,10 @@ declare enum ActivityType {
|
|
|
26424
26901
|
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
26425
26902
|
AUTHORIZED_PAYMENT_CREATED = "AUTHORIZED_PAYMENT_CREATED",
|
|
26426
26903
|
AUTHORIZED_PAYMENT_CAPTURED = "AUTHORIZED_PAYMENT_CAPTURED",
|
|
26427
|
-
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED"
|
|
26904
|
+
AUTHORIZED_PAYMENT_VOIDED = "AUTHORIZED_PAYMENT_VOIDED",
|
|
26905
|
+
REFUND_INITIATED = "REFUND_INITIATED",
|
|
26906
|
+
PAYMENT_REFUNDED = "PAYMENT_REFUNDED",
|
|
26907
|
+
PAYMENT_REFUND_FAILED = "PAYMENT_REFUND_FAILED"
|
|
26428
26908
|
}
|
|
26429
26909
|
declare enum AttributionSource {
|
|
26430
26910
|
UNSPECIFIED = "UNSPECIFIED",
|
|
@@ -26570,6 +27050,259 @@ interface ExtendedFields$6 {
|
|
|
26570
27050
|
*/
|
|
26571
27051
|
namespaces?: Record<string, Record<string, any>>;
|
|
26572
27052
|
}
|
|
27053
|
+
interface OrderTransactions$2 {
|
|
27054
|
+
/** Order ID. */
|
|
27055
|
+
orderId?: string;
|
|
27056
|
+
/** Record of payments made to the merchant. */
|
|
27057
|
+
payments?: Payment$2[];
|
|
27058
|
+
/** Record of refunds made to the buyer. */
|
|
27059
|
+
refunds?: Refund$2[];
|
|
27060
|
+
}
|
|
27061
|
+
interface Payment$2 extends PaymentPaymentDetailsOneOf$2 {
|
|
27062
|
+
/** Regular payment details. */
|
|
27063
|
+
regularPaymentDetails?: RegularPaymentDetails$2;
|
|
27064
|
+
/** Gift card payment details. */
|
|
27065
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$2;
|
|
27066
|
+
/**
|
|
27067
|
+
* Payment ID.
|
|
27068
|
+
* @readonly
|
|
27069
|
+
*/
|
|
27070
|
+
_id?: string | null;
|
|
27071
|
+
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
27072
|
+
_createdDate?: Date;
|
|
27073
|
+
/**
|
|
27074
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
27075
|
+
* @readonly
|
|
27076
|
+
*/
|
|
27077
|
+
_updatedDate?: Date;
|
|
27078
|
+
/** Payment amount. */
|
|
27079
|
+
amount?: Price$4;
|
|
27080
|
+
/**
|
|
27081
|
+
* Whether refunds for this payment are disabled.
|
|
27082
|
+
* + `true`: This payment is not refundable.
|
|
27083
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
27084
|
+
*/
|
|
27085
|
+
refundDisabled?: boolean;
|
|
27086
|
+
}
|
|
27087
|
+
/** @oneof */
|
|
27088
|
+
interface PaymentPaymentDetailsOneOf$2 {
|
|
27089
|
+
/** Regular payment details. */
|
|
27090
|
+
regularPaymentDetails?: RegularPaymentDetails$2;
|
|
27091
|
+
/** Gift card payment details. */
|
|
27092
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$2;
|
|
27093
|
+
}
|
|
27094
|
+
interface RegularPaymentDetails$2 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$2 {
|
|
27095
|
+
/** Whether regular card used */
|
|
27096
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$2;
|
|
27097
|
+
/** Wix Payments order ID. */
|
|
27098
|
+
paymentOrderId?: string | null;
|
|
27099
|
+
/**
|
|
27100
|
+
* Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).
|
|
27101
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
27102
|
+
*/
|
|
27103
|
+
gatewayTransactionId?: string | null;
|
|
27104
|
+
/**
|
|
27105
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
27106
|
+
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
27107
|
+
*/
|
|
27108
|
+
paymentMethod?: string | null;
|
|
27109
|
+
/** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */
|
|
27110
|
+
providerTransactionId?: string | null;
|
|
27111
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
27112
|
+
offlinePayment?: boolean;
|
|
27113
|
+
/** Payment status. */
|
|
27114
|
+
status?: TransactionStatus$2;
|
|
27115
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
27116
|
+
savedPaymentMethod?: boolean;
|
|
27117
|
+
/** Authorization details. */
|
|
27118
|
+
authorizationDetails?: AuthorizationDetails$2;
|
|
27119
|
+
}
|
|
27120
|
+
/** @oneof */
|
|
27121
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$2 {
|
|
27122
|
+
/** Whether regular card used */
|
|
27123
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$2;
|
|
27124
|
+
}
|
|
27125
|
+
declare enum TransactionStatus$2 {
|
|
27126
|
+
UNDEFINED = "UNDEFINED",
|
|
27127
|
+
APPROVED = "APPROVED",
|
|
27128
|
+
PENDING = "PENDING",
|
|
27129
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
27130
|
+
CANCELED = "CANCELED",
|
|
27131
|
+
DECLINED = "DECLINED",
|
|
27132
|
+
REFUNDED = "REFUNDED",
|
|
27133
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
27134
|
+
AUTHORIZED = "AUTHORIZED",
|
|
27135
|
+
VOIDED = "VOIDED"
|
|
27136
|
+
}
|
|
27137
|
+
interface CreditCardPaymentMethodDetails$2 {
|
|
27138
|
+
/** The last 4 digits of the card number. */
|
|
27139
|
+
lastFourDigits?: string | null;
|
|
27140
|
+
/** Card issuer's brand. */
|
|
27141
|
+
brand?: string | null;
|
|
27142
|
+
}
|
|
27143
|
+
interface AuthorizationDetails$2 {
|
|
27144
|
+
/**
|
|
27145
|
+
* Whether the authorized payment is of a delayed capture.
|
|
27146
|
+
* @readonly
|
|
27147
|
+
*/
|
|
27148
|
+
delayedCapture?: boolean;
|
|
27149
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27150
|
+
authorizedDate?: Date;
|
|
27151
|
+
/**
|
|
27152
|
+
* List of captures associated with payment
|
|
27153
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
27154
|
+
*/
|
|
27155
|
+
captures?: AuthorizationCapture$2[];
|
|
27156
|
+
/** Void associated with payment */
|
|
27157
|
+
void?: AuthorizationVoid$2;
|
|
27158
|
+
/** Scheduled action for this transaction */
|
|
27159
|
+
scheduledAction?: ScheduledAction$2;
|
|
27160
|
+
}
|
|
27161
|
+
interface AuthorizationCapture$2 {
|
|
27162
|
+
/**
|
|
27163
|
+
* Capture ID.
|
|
27164
|
+
* @readonly
|
|
27165
|
+
*/
|
|
27166
|
+
_id?: string | null;
|
|
27167
|
+
/** Status of this capture action */
|
|
27168
|
+
status?: AuthorizationCaptureStatus$2;
|
|
27169
|
+
/** Amount of this capture */
|
|
27170
|
+
amount?: Price$4;
|
|
27171
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27172
|
+
_createdDate?: Date;
|
|
27173
|
+
/** In case of status is FAILED may contain failure details */
|
|
27174
|
+
failureDetails?: AuthorizationActionFailureDetails$2;
|
|
27175
|
+
}
|
|
27176
|
+
declare enum AuthorizationCaptureStatus$2 {
|
|
27177
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27178
|
+
/** Whether capture operation still in progress */
|
|
27179
|
+
PENDING = "PENDING",
|
|
27180
|
+
/** The capture operation was succeeded */
|
|
27181
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27182
|
+
/** The capture operation was failed */
|
|
27183
|
+
FAILED = "FAILED"
|
|
27184
|
+
}
|
|
27185
|
+
interface AuthorizationActionFailureDetails$2 {
|
|
27186
|
+
failureCode?: string;
|
|
27187
|
+
}
|
|
27188
|
+
interface AuthorizationVoid$2 {
|
|
27189
|
+
/** Status of this void action */
|
|
27190
|
+
status?: AuthorizationVoidStatus$2;
|
|
27191
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27192
|
+
voidedDate?: Date;
|
|
27193
|
+
/** In case of status is FAILED may contain failure details */
|
|
27194
|
+
failureDetails?: AuthorizationActionFailureDetails$2;
|
|
27195
|
+
/** Reason of void action */
|
|
27196
|
+
reason?: Reason$2;
|
|
27197
|
+
}
|
|
27198
|
+
declare enum AuthorizationVoidStatus$2 {
|
|
27199
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27200
|
+
/** Whether void operation still in progress */
|
|
27201
|
+
PENDING = "PENDING",
|
|
27202
|
+
/** The void operation was succeeded */
|
|
27203
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27204
|
+
/** The void operation was failed */
|
|
27205
|
+
FAILED = "FAILED"
|
|
27206
|
+
}
|
|
27207
|
+
/**
|
|
27208
|
+
* Reason the authorization was voided.
|
|
27209
|
+
*
|
|
27210
|
+
* + `MANUAL`: Authorization was voided by user.
|
|
27211
|
+
* + `SCHEDULED`: Authorization passed execution date.
|
|
27212
|
+
*/
|
|
27213
|
+
declare enum Reason$2 {
|
|
27214
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
27215
|
+
MANUAL = "MANUAL",
|
|
27216
|
+
SCHEDULED = "SCHEDULED"
|
|
27217
|
+
}
|
|
27218
|
+
interface ScheduledAction$2 {
|
|
27219
|
+
/** type of the action */
|
|
27220
|
+
actionType?: ActionType$2;
|
|
27221
|
+
/** the date and time of the action */
|
|
27222
|
+
executionDate?: Date;
|
|
27223
|
+
}
|
|
27224
|
+
declare enum ActionType$2 {
|
|
27225
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
27226
|
+
VOID = "VOID",
|
|
27227
|
+
CAPTURE = "CAPTURE"
|
|
27228
|
+
}
|
|
27229
|
+
interface GiftCardPaymentDetails$2 {
|
|
27230
|
+
/** Gift card payment ID. */
|
|
27231
|
+
giftCardPaymentId?: string;
|
|
27232
|
+
/** ID of the app that created the gift card. */
|
|
27233
|
+
appId?: string;
|
|
27234
|
+
/**
|
|
27235
|
+
* Whether the gift card is voided.
|
|
27236
|
+
* @readonly
|
|
27237
|
+
*/
|
|
27238
|
+
voided?: boolean;
|
|
27239
|
+
}
|
|
27240
|
+
declare enum MembershipPaymentStatus$2 {
|
|
27241
|
+
/** CHARGED - Payment was charged */
|
|
27242
|
+
CHARGED = "CHARGED",
|
|
27243
|
+
/** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
|
|
27244
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
27245
|
+
}
|
|
27246
|
+
interface Refund$2 {
|
|
27247
|
+
/**
|
|
27248
|
+
* Refund ID.
|
|
27249
|
+
* @readonly
|
|
27250
|
+
*/
|
|
27251
|
+
_id?: string;
|
|
27252
|
+
/** List of transactions. */
|
|
27253
|
+
transactions?: RefundTransaction$2[];
|
|
27254
|
+
/** Refund business details. */
|
|
27255
|
+
details?: RefundDetails$2;
|
|
27256
|
+
/** Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
27257
|
+
_createdDate?: Date;
|
|
27258
|
+
}
|
|
27259
|
+
interface RefundTransaction$2 {
|
|
27260
|
+
/** ID of the payment associated with this refund. */
|
|
27261
|
+
paymentId?: string;
|
|
27262
|
+
/** Refund amount. */
|
|
27263
|
+
amount?: Price$4;
|
|
27264
|
+
/** Refund status. */
|
|
27265
|
+
refundStatus?: RefundStatus$2;
|
|
27266
|
+
/**
|
|
27267
|
+
* Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).
|
|
27268
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
27269
|
+
*/
|
|
27270
|
+
gatewayRefundId?: string | null;
|
|
27271
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
27272
|
+
providerRefundId?: string | null;
|
|
27273
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
27274
|
+
externalRefund?: boolean;
|
|
27275
|
+
}
|
|
27276
|
+
/**
|
|
27277
|
+
* Refund transaction status.
|
|
27278
|
+
* + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
|
|
27279
|
+
* + `SUCCEEDED`: Refund transaction succeeded.
|
|
27280
|
+
* + `FAILED`: Refund transaction failed.
|
|
27281
|
+
* + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
|
|
27282
|
+
* + `STARTED`: Refund was initiated on payment provider side.
|
|
27283
|
+
*/
|
|
27284
|
+
declare enum RefundStatus$2 {
|
|
27285
|
+
PENDING = "PENDING",
|
|
27286
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27287
|
+
FAILED = "FAILED",
|
|
27288
|
+
SCHEDULED = "SCHEDULED",
|
|
27289
|
+
STARTED = "STARTED"
|
|
27290
|
+
}
|
|
27291
|
+
/** Business model of a refund request */
|
|
27292
|
+
interface RefundDetails$2 {
|
|
27293
|
+
/** Order line item IDs and quantities that were refunded. */
|
|
27294
|
+
items?: RefundItem$2[];
|
|
27295
|
+
/** Whether the shipping fee was also refunded. */
|
|
27296
|
+
shippingIncluded?: boolean;
|
|
27297
|
+
/** Reason for the refund, provided by customer (optional). */
|
|
27298
|
+
reason?: string | null;
|
|
27299
|
+
}
|
|
27300
|
+
interface RefundItem$2 {
|
|
27301
|
+
/** Line item ID the refunded line item. */
|
|
27302
|
+
lineItemId?: string;
|
|
27303
|
+
/** Line item quantity refunded. */
|
|
27304
|
+
quantity?: number;
|
|
27305
|
+
}
|
|
26573
27306
|
interface Sorting$8 {
|
|
26574
27307
|
/** Name of the field to sort by. */
|
|
26575
27308
|
fieldName?: string;
|
|
@@ -26650,6 +27383,35 @@ interface BulkActionMetadata$2 {
|
|
|
26650
27383
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
26651
27384
|
undetailedFailures?: number;
|
|
26652
27385
|
}
|
|
27386
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
27387
|
+
/** Wix eCommerce order ID */
|
|
27388
|
+
ecomOrderId: string;
|
|
27389
|
+
/** Payment IDs */
|
|
27390
|
+
paymentIds: string[];
|
|
27391
|
+
}
|
|
27392
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
27393
|
+
/** All order's transactions after the void was triggered */
|
|
27394
|
+
orderTransactions?: OrderTransactions$2;
|
|
27395
|
+
}
|
|
27396
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
27397
|
+
/** Wix eCommerce order ID */
|
|
27398
|
+
ecomOrderId: string;
|
|
27399
|
+
/** Capture payments information */
|
|
27400
|
+
payments: PaymentCapture[];
|
|
27401
|
+
}
|
|
27402
|
+
interface PaymentCapture {
|
|
27403
|
+
/** Payment ID */
|
|
27404
|
+
paymentId?: string | null;
|
|
27405
|
+
/**
|
|
27406
|
+
* Capture amount.
|
|
27407
|
+
* If not provided - full authorized amount will be captured.
|
|
27408
|
+
*/
|
|
27409
|
+
amount?: Price$4;
|
|
27410
|
+
}
|
|
27411
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
27412
|
+
/** All order's transactions after the capture was triggered */
|
|
27413
|
+
orderTransactions?: OrderTransactions$2;
|
|
27414
|
+
}
|
|
26653
27415
|
interface GetOrderRequest {
|
|
26654
27416
|
/** ID of the order to retrieve. */
|
|
26655
27417
|
_id: string;
|
|
@@ -26775,6 +27537,110 @@ interface GetPaymentCollectabilityStatusResponseNonNullableFields {
|
|
|
26775
27537
|
amount?: PriceNonNullableFields$4;
|
|
26776
27538
|
authorizationSupported: boolean;
|
|
26777
27539
|
}
|
|
27540
|
+
interface AuthorizationActionFailureDetailsNonNullableFields$2 {
|
|
27541
|
+
failureCode: string;
|
|
27542
|
+
}
|
|
27543
|
+
interface AuthorizationCaptureNonNullableFields$2 {
|
|
27544
|
+
status: AuthorizationCaptureStatus$2;
|
|
27545
|
+
amount?: PriceNonNullableFields$4;
|
|
27546
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$2;
|
|
27547
|
+
}
|
|
27548
|
+
interface AuthorizationVoidNonNullableFields$2 {
|
|
27549
|
+
status: AuthorizationVoidStatus$2;
|
|
27550
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$2;
|
|
27551
|
+
reason: Reason$2;
|
|
27552
|
+
}
|
|
27553
|
+
interface ScheduledActionNonNullableFields$2 {
|
|
27554
|
+
actionType: ActionType$2;
|
|
27555
|
+
}
|
|
27556
|
+
interface AuthorizationDetailsNonNullableFields$2 {
|
|
27557
|
+
delayedCapture: boolean;
|
|
27558
|
+
captures: AuthorizationCaptureNonNullableFields$2[];
|
|
27559
|
+
void?: AuthorizationVoidNonNullableFields$2;
|
|
27560
|
+
scheduledAction?: ScheduledActionNonNullableFields$2;
|
|
27561
|
+
}
|
|
27562
|
+
interface RegularPaymentDetailsNonNullableFields$2 {
|
|
27563
|
+
offlinePayment: boolean;
|
|
27564
|
+
status: TransactionStatus$2;
|
|
27565
|
+
savedPaymentMethod: boolean;
|
|
27566
|
+
authorizationDetails?: AuthorizationDetailsNonNullableFields$2;
|
|
27567
|
+
}
|
|
27568
|
+
interface GiftCardPaymentDetailsNonNullableFields$2 {
|
|
27569
|
+
giftCardPaymentId: string;
|
|
27570
|
+
giftCardId: string;
|
|
27571
|
+
appId: string;
|
|
27572
|
+
voided: boolean;
|
|
27573
|
+
}
|
|
27574
|
+
interface MembershipNameNonNullableFields$4 {
|
|
27575
|
+
original: string;
|
|
27576
|
+
}
|
|
27577
|
+
interface MembershipPaymentDetailsNonNullableFields$2 {
|
|
27578
|
+
membershipId: string;
|
|
27579
|
+
lineItemId: string;
|
|
27580
|
+
status: MembershipPaymentStatus$2;
|
|
27581
|
+
name?: MembershipNameNonNullableFields$4;
|
|
27582
|
+
voided: boolean;
|
|
27583
|
+
providerAppId: string;
|
|
27584
|
+
}
|
|
27585
|
+
interface PaymentNonNullableFields$2 {
|
|
27586
|
+
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields$2;
|
|
27587
|
+
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields$2;
|
|
27588
|
+
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields$2;
|
|
27589
|
+
amount?: PriceNonNullableFields$4;
|
|
27590
|
+
refundDisabled: boolean;
|
|
27591
|
+
}
|
|
27592
|
+
interface RefundTransactionNonNullableFields$2 {
|
|
27593
|
+
paymentId: string;
|
|
27594
|
+
amount?: PriceNonNullableFields$4;
|
|
27595
|
+
refundStatus: RefundStatus$2;
|
|
27596
|
+
externalRefund: boolean;
|
|
27597
|
+
}
|
|
27598
|
+
interface RefundItemNonNullableFields$2 {
|
|
27599
|
+
lineItemId: string;
|
|
27600
|
+
quantity: number;
|
|
27601
|
+
}
|
|
27602
|
+
interface LineItemRefundNonNullableFields$2 {
|
|
27603
|
+
lineItemId: string;
|
|
27604
|
+
quantity: number;
|
|
27605
|
+
}
|
|
27606
|
+
interface AdditionalFeeRefundNonNullableFields$2 {
|
|
27607
|
+
additionalFeeId: string;
|
|
27608
|
+
amount?: PriceNonNullableFields$4;
|
|
27609
|
+
}
|
|
27610
|
+
interface ShippingRefundNonNullableFields$2 {
|
|
27611
|
+
amount?: PriceNonNullableFields$4;
|
|
27612
|
+
}
|
|
27613
|
+
interface RefundDetailsNonNullableFields$2 {
|
|
27614
|
+
items: RefundItemNonNullableFields$2[];
|
|
27615
|
+
shippingIncluded: boolean;
|
|
27616
|
+
lineItems: LineItemRefundNonNullableFields$2[];
|
|
27617
|
+
additionalFees: AdditionalFeeRefundNonNullableFields$2[];
|
|
27618
|
+
shipping?: ShippingRefundNonNullableFields$2;
|
|
27619
|
+
}
|
|
27620
|
+
interface AggregatedRefundSummaryNonNullableFields$2 {
|
|
27621
|
+
requestedRefund?: PriceNonNullableFields$4;
|
|
27622
|
+
pendingRefund?: PriceNonNullableFields$4;
|
|
27623
|
+
refunded?: PriceNonNullableFields$4;
|
|
27624
|
+
failedRefundAmount?: PriceNonNullableFields$4;
|
|
27625
|
+
pending: boolean;
|
|
27626
|
+
}
|
|
27627
|
+
interface RefundNonNullableFields$2 {
|
|
27628
|
+
_id: string;
|
|
27629
|
+
transactions: RefundTransactionNonNullableFields$2[];
|
|
27630
|
+
details?: RefundDetailsNonNullableFields$2;
|
|
27631
|
+
summary?: AggregatedRefundSummaryNonNullableFields$2;
|
|
27632
|
+
}
|
|
27633
|
+
interface OrderTransactionsNonNullableFields$2 {
|
|
27634
|
+
orderId: string;
|
|
27635
|
+
payments: PaymentNonNullableFields$2[];
|
|
27636
|
+
refunds: RefundNonNullableFields$2[];
|
|
27637
|
+
}
|
|
27638
|
+
interface VoidAuthorizedPaymentsResponseNonNullableFields {
|
|
27639
|
+
orderTransactions?: OrderTransactionsNonNullableFields$2;
|
|
27640
|
+
}
|
|
27641
|
+
interface CaptureAuthorizedPaymentsResponseNonNullableFields {
|
|
27642
|
+
orderTransactions?: OrderTransactionsNonNullableFields$2;
|
|
27643
|
+
}
|
|
26778
27644
|
interface ProductNameNonNullableFields {
|
|
26779
27645
|
original: string;
|
|
26780
27646
|
}
|
|
@@ -27075,6 +27941,27 @@ interface AuthorizedPaymentVoidedNonNullableFields {
|
|
|
27075
27941
|
paymentId: string;
|
|
27076
27942
|
amount?: PriceNonNullableFields$4;
|
|
27077
27943
|
}
|
|
27944
|
+
interface RegularPaymentRefundNonNullableFields {
|
|
27945
|
+
amount?: PriceNonNullableFields$4;
|
|
27946
|
+
}
|
|
27947
|
+
interface RefundedPaymentNonNullableFields {
|
|
27948
|
+
regular?: RegularPaymentRefundNonNullableFields;
|
|
27949
|
+
paymentId: string;
|
|
27950
|
+
externalRefund: boolean;
|
|
27951
|
+
}
|
|
27952
|
+
interface RefundInitiatedNonNullableFields {
|
|
27953
|
+
refundId: string;
|
|
27954
|
+
amount?: PriceNonNullableFields$4;
|
|
27955
|
+
payments: RefundedPaymentNonNullableFields[];
|
|
27956
|
+
}
|
|
27957
|
+
interface PaymentRefundedNonNullableFields {
|
|
27958
|
+
refundId: string;
|
|
27959
|
+
payment?: RefundedPaymentNonNullableFields;
|
|
27960
|
+
}
|
|
27961
|
+
interface PaymentRefundFailedNonNullableFields {
|
|
27962
|
+
refundId: string;
|
|
27963
|
+
payment?: RefundedPaymentNonNullableFields;
|
|
27964
|
+
}
|
|
27078
27965
|
interface ActivityNonNullableFields {
|
|
27079
27966
|
customActivity?: CustomActivityNonNullableFields;
|
|
27080
27967
|
merchantComment?: MerchantCommentNonNullableFields;
|
|
@@ -27086,6 +27973,9 @@ interface ActivityNonNullableFields {
|
|
|
27086
27973
|
authorizedPaymentCreated?: AuthorizedPaymentCreatedNonNullableFields;
|
|
27087
27974
|
authorizedPaymentCaptured?: AuthorizedPaymentCapturedNonNullableFields;
|
|
27088
27975
|
authorizedPaymentVoided?: AuthorizedPaymentVoidedNonNullableFields;
|
|
27976
|
+
refundInitiated?: RefundInitiatedNonNullableFields;
|
|
27977
|
+
paymentRefunded?: PaymentRefundedNonNullableFields;
|
|
27978
|
+
paymentRefundFailed?: PaymentRefundFailedNonNullableFields;
|
|
27089
27979
|
type: ActivityType;
|
|
27090
27980
|
}
|
|
27091
27981
|
interface CreatedByNonNullableFields {
|
|
@@ -27204,6 +28094,12 @@ type __PublicMethodMetaInfo$8<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
27204
28094
|
declare function getPaymentCollectabilityStatus(): __PublicMethodMetaInfo$8<'GET', {
|
|
27205
28095
|
ecomOrderId: string;
|
|
27206
28096
|
}, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusRequest$1, GetPaymentCollectabilityStatusResponse & GetPaymentCollectabilityStatusResponseNonNullableFields, GetPaymentCollectabilityStatusResponse$1 & GetPaymentCollectabilityStatusResponseNonNullableFields$1>;
|
|
28097
|
+
declare function voidAuthorizedPayments(): __PublicMethodMetaInfo$8<'POST', {
|
|
28098
|
+
ecomOrderId: string;
|
|
28099
|
+
}, VoidAuthorizedPaymentsRequest, VoidAuthorizedPaymentsRequest$1, VoidAuthorizedPaymentsResponse & VoidAuthorizedPaymentsResponseNonNullableFields, VoidAuthorizedPaymentsResponse$1 & VoidAuthorizedPaymentsResponseNonNullableFields$1>;
|
|
28100
|
+
declare function captureAuthorizedPayments(): __PublicMethodMetaInfo$8<'POST', {
|
|
28101
|
+
ecomOrderId: string;
|
|
28102
|
+
}, CaptureAuthorizedPaymentsRequest, CaptureAuthorizedPaymentsRequest$1, CaptureAuthorizedPaymentsResponse & CaptureAuthorizedPaymentsResponseNonNullableFields, CaptureAuthorizedPaymentsResponse$1 & CaptureAuthorizedPaymentsResponseNonNullableFields$1>;
|
|
27207
28103
|
declare function getOrder(): __PublicMethodMetaInfo$8<'GET', {
|
|
27208
28104
|
id: string;
|
|
27209
28105
|
}, GetOrderRequest, GetOrderRequest$1, GetOrderResponse & GetOrderResponseNonNullableFields, GetOrderResponse$1 & GetOrderResponseNonNullableFields$1>;
|
|
@@ -27219,13 +28115,15 @@ declare function cancelOrder(): __PublicMethodMetaInfo$8<'POST', {
|
|
|
27219
28115
|
|
|
27220
28116
|
declare const meta$8_bulkUpdateOrders: typeof bulkUpdateOrders;
|
|
27221
28117
|
declare const meta$8_cancelOrder: typeof cancelOrder;
|
|
28118
|
+
declare const meta$8_captureAuthorizedPayments: typeof captureAuthorizedPayments;
|
|
27222
28119
|
declare const meta$8_createOrder: typeof createOrder;
|
|
27223
28120
|
declare const meta$8_getOrder: typeof getOrder;
|
|
27224
28121
|
declare const meta$8_getPaymentCollectabilityStatus: typeof getPaymentCollectabilityStatus;
|
|
27225
28122
|
declare const meta$8_searchOrders: typeof searchOrders;
|
|
27226
28123
|
declare const meta$8_updateOrder: typeof updateOrder;
|
|
28124
|
+
declare const meta$8_voidAuthorizedPayments: typeof voidAuthorizedPayments;
|
|
27227
28125
|
declare namespace meta$8 {
|
|
27228
|
-
export { type __PublicMethodMetaInfo$8 as __PublicMethodMetaInfo, meta$8_bulkUpdateOrders as bulkUpdateOrders, meta$8_cancelOrder as cancelOrder, meta$8_createOrder as createOrder, meta$8_getOrder as getOrder, meta$8_getPaymentCollectabilityStatus as getPaymentCollectabilityStatus, meta$8_searchOrders as searchOrders, meta$8_updateOrder as updateOrder };
|
|
28126
|
+
export { type __PublicMethodMetaInfo$8 as __PublicMethodMetaInfo, meta$8_bulkUpdateOrders as bulkUpdateOrders, meta$8_cancelOrder as cancelOrder, meta$8_captureAuthorizedPayments as captureAuthorizedPayments, meta$8_createOrder as createOrder, meta$8_getOrder as getOrder, meta$8_getPaymentCollectabilityStatus as getPaymentCollectabilityStatus, meta$8_searchOrders as searchOrders, meta$8_updateOrder as updateOrder, meta$8_voidAuthorizedPayments as voidAuthorizedPayments };
|
|
27229
28127
|
}
|
|
27230
28128
|
|
|
27231
28129
|
interface OrderPaymentRequest$1 {
|
|
@@ -27830,6 +28728,8 @@ interface PaymentPaymentDetailsOneOf$1 {
|
|
|
27830
28728
|
giftcardPaymentDetails?: GiftCardPaymentDetails$1;
|
|
27831
28729
|
}
|
|
27832
28730
|
interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {
|
|
28731
|
+
/** Whether regular card used */
|
|
28732
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$1;
|
|
27833
28733
|
/** Wix Payments order ID. */
|
|
27834
28734
|
paymentOrderId?: string | null;
|
|
27835
28735
|
/**
|
|
@@ -27850,9 +28750,13 @@ interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDeta
|
|
|
27850
28750
|
status?: TransactionStatus$1;
|
|
27851
28751
|
/** Whether there is a payment agreement that allows for future charges. */
|
|
27852
28752
|
savedPaymentMethod?: boolean;
|
|
28753
|
+
/** Authorization details. */
|
|
28754
|
+
authorizationDetails?: AuthorizationDetails$1;
|
|
27853
28755
|
}
|
|
27854
28756
|
/** @oneof */
|
|
27855
28757
|
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {
|
|
28758
|
+
/** Whether regular card used */
|
|
28759
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$1;
|
|
27856
28760
|
}
|
|
27857
28761
|
declare enum TransactionStatus$1 {
|
|
27858
28762
|
UNDEFINED = "UNDEFINED",
|
|
@@ -27866,6 +28770,45 @@ declare enum TransactionStatus$1 {
|
|
|
27866
28770
|
AUTHORIZED = "AUTHORIZED",
|
|
27867
28771
|
VOIDED = "VOIDED"
|
|
27868
28772
|
}
|
|
28773
|
+
interface CreditCardPaymentMethodDetails$1 {
|
|
28774
|
+
/** The last 4 digits of the card number. */
|
|
28775
|
+
lastFourDigits?: string | null;
|
|
28776
|
+
/** Card issuer's brand. */
|
|
28777
|
+
brand?: string | null;
|
|
28778
|
+
}
|
|
28779
|
+
interface AuthorizationDetails$1 {
|
|
28780
|
+
/**
|
|
28781
|
+
* Whether the authorized payment is of a delayed capture.
|
|
28782
|
+
* @readonly
|
|
28783
|
+
*/
|
|
28784
|
+
delayedCapture?: boolean;
|
|
28785
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28786
|
+
authorizedDate?: Date;
|
|
28787
|
+
/**
|
|
28788
|
+
* List of captures associated with payment
|
|
28789
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
28790
|
+
*/
|
|
28791
|
+
captures?: AuthorizationCapture$1[];
|
|
28792
|
+
/** Void associated with payment */
|
|
28793
|
+
void?: AuthorizationVoid$1;
|
|
28794
|
+
/** Scheduled action for this transaction */
|
|
28795
|
+
scheduledAction?: ScheduledAction$1;
|
|
28796
|
+
}
|
|
28797
|
+
interface AuthorizationCapture$1 {
|
|
28798
|
+
/**
|
|
28799
|
+
* Capture ID.
|
|
28800
|
+
* @readonly
|
|
28801
|
+
*/
|
|
28802
|
+
id?: string | null;
|
|
28803
|
+
/** Status of this capture action */
|
|
28804
|
+
status?: AuthorizationCaptureStatus$1;
|
|
28805
|
+
/** Amount of this capture */
|
|
28806
|
+
amount?: Price$1;
|
|
28807
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28808
|
+
createdDate?: Date;
|
|
28809
|
+
/** In case of status is FAILED may contain failure details */
|
|
28810
|
+
failureDetails?: AuthorizationActionFailureDetails$1;
|
|
28811
|
+
}
|
|
27869
28812
|
declare enum AuthorizationCaptureStatus$1 {
|
|
27870
28813
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27871
28814
|
/** Whether capture operation still in progress */
|
|
@@ -27884,6 +28827,19 @@ interface Price$1 {
|
|
|
27884
28827
|
*/
|
|
27885
28828
|
formattedAmount?: string;
|
|
27886
28829
|
}
|
|
28830
|
+
interface AuthorizationActionFailureDetails$1 {
|
|
28831
|
+
failureCode?: string;
|
|
28832
|
+
}
|
|
28833
|
+
interface AuthorizationVoid$1 {
|
|
28834
|
+
/** Status of this void action */
|
|
28835
|
+
status?: AuthorizationVoidStatus$1;
|
|
28836
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28837
|
+
voidedDate?: Date;
|
|
28838
|
+
/** In case of status is FAILED may contain failure details */
|
|
28839
|
+
failureDetails?: AuthorizationActionFailureDetails$1;
|
|
28840
|
+
/** Reason of void action */
|
|
28841
|
+
reason?: Reason$1;
|
|
28842
|
+
}
|
|
27887
28843
|
declare enum AuthorizationVoidStatus$1 {
|
|
27888
28844
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27889
28845
|
/** Whether void operation still in progress */
|
|
@@ -27904,6 +28860,12 @@ declare enum Reason$1 {
|
|
|
27904
28860
|
MANUAL = "MANUAL",
|
|
27905
28861
|
SCHEDULED = "SCHEDULED"
|
|
27906
28862
|
}
|
|
28863
|
+
interface ScheduledAction$1 {
|
|
28864
|
+
/** type of the action */
|
|
28865
|
+
actionType?: ActionType$1;
|
|
28866
|
+
/** the date and time of the action */
|
|
28867
|
+
executionDate?: Date;
|
|
28868
|
+
}
|
|
27907
28869
|
declare enum ActionType$1 {
|
|
27908
28870
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
27909
28871
|
VOID = "VOID",
|
|
@@ -28261,6 +29223,8 @@ interface PaymentPaymentDetailsOneOf {
|
|
|
28261
29223
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
28262
29224
|
}
|
|
28263
29225
|
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
29226
|
+
/** Whether regular card used */
|
|
29227
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
28264
29228
|
/** Wix Payments order ID. */
|
|
28265
29229
|
paymentOrderId?: string | null;
|
|
28266
29230
|
/**
|
|
@@ -28281,9 +29245,13 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
|
|
|
28281
29245
|
status?: TransactionStatus;
|
|
28282
29246
|
/** Whether there is a payment agreement that allows for future charges. */
|
|
28283
29247
|
savedPaymentMethod?: boolean;
|
|
29248
|
+
/** Authorization details. */
|
|
29249
|
+
authorizationDetails?: AuthorizationDetails;
|
|
28284
29250
|
}
|
|
28285
29251
|
/** @oneof */
|
|
28286
29252
|
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
29253
|
+
/** Whether regular card used */
|
|
29254
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
28287
29255
|
}
|
|
28288
29256
|
declare enum TransactionStatus {
|
|
28289
29257
|
UNDEFINED = "UNDEFINED",
|
|
@@ -28297,6 +29265,45 @@ declare enum TransactionStatus {
|
|
|
28297
29265
|
AUTHORIZED = "AUTHORIZED",
|
|
28298
29266
|
VOIDED = "VOIDED"
|
|
28299
29267
|
}
|
|
29268
|
+
interface CreditCardPaymentMethodDetails {
|
|
29269
|
+
/** The last 4 digits of the card number. */
|
|
29270
|
+
lastFourDigits?: string | null;
|
|
29271
|
+
/** Card issuer's brand. */
|
|
29272
|
+
brand?: string | null;
|
|
29273
|
+
}
|
|
29274
|
+
interface AuthorizationDetails {
|
|
29275
|
+
/**
|
|
29276
|
+
* Whether the authorized payment is of a delayed capture.
|
|
29277
|
+
* @readonly
|
|
29278
|
+
*/
|
|
29279
|
+
delayedCapture?: boolean;
|
|
29280
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29281
|
+
authorizedDate?: Date;
|
|
29282
|
+
/**
|
|
29283
|
+
* List of captures associated with payment
|
|
29284
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
29285
|
+
*/
|
|
29286
|
+
captures?: AuthorizationCapture[];
|
|
29287
|
+
/** Void associated with payment */
|
|
29288
|
+
void?: AuthorizationVoid;
|
|
29289
|
+
/** Scheduled action for this transaction */
|
|
29290
|
+
scheduledAction?: ScheduledAction;
|
|
29291
|
+
}
|
|
29292
|
+
interface AuthorizationCapture {
|
|
29293
|
+
/**
|
|
29294
|
+
* Capture ID.
|
|
29295
|
+
* @readonly
|
|
29296
|
+
*/
|
|
29297
|
+
_id?: string | null;
|
|
29298
|
+
/** Status of this capture action */
|
|
29299
|
+
status?: AuthorizationCaptureStatus;
|
|
29300
|
+
/** Amount of this capture */
|
|
29301
|
+
amount?: Price;
|
|
29302
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29303
|
+
_createdDate?: Date;
|
|
29304
|
+
/** In case of status is FAILED may contain failure details */
|
|
29305
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
29306
|
+
}
|
|
28300
29307
|
declare enum AuthorizationCaptureStatus {
|
|
28301
29308
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
28302
29309
|
/** Whether capture operation still in progress */
|
|
@@ -28315,6 +29322,19 @@ interface Price {
|
|
|
28315
29322
|
*/
|
|
28316
29323
|
formattedAmount?: string;
|
|
28317
29324
|
}
|
|
29325
|
+
interface AuthorizationActionFailureDetails {
|
|
29326
|
+
failureCode?: string;
|
|
29327
|
+
}
|
|
29328
|
+
interface AuthorizationVoid {
|
|
29329
|
+
/** Status of this void action */
|
|
29330
|
+
status?: AuthorizationVoidStatus;
|
|
29331
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29332
|
+
voidedDate?: Date;
|
|
29333
|
+
/** In case of status is FAILED may contain failure details */
|
|
29334
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
29335
|
+
/** Reason of void action */
|
|
29336
|
+
reason?: Reason;
|
|
29337
|
+
}
|
|
28318
29338
|
declare enum AuthorizationVoidStatus {
|
|
28319
29339
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
28320
29340
|
/** Whether void operation still in progress */
|
|
@@ -28335,6 +29355,12 @@ declare enum Reason {
|
|
|
28335
29355
|
MANUAL = "MANUAL",
|
|
28336
29356
|
SCHEDULED = "SCHEDULED"
|
|
28337
29357
|
}
|
|
29358
|
+
interface ScheduledAction {
|
|
29359
|
+
/** type of the action */
|
|
29360
|
+
actionType?: ActionType;
|
|
29361
|
+
/** the date and time of the action */
|
|
29362
|
+
executionDate?: Date;
|
|
29363
|
+
}
|
|
28338
29364
|
declare enum ActionType {
|
|
28339
29365
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
28340
29366
|
VOID = "VOID",
|