@wix/ecom 1.0.721 → 1.0.723
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
|
}
|
|
@@ -19435,6 +19435,11 @@ interface V1BalanceSummary$1 {
|
|
|
19435
19435
|
* @readonly
|
|
19436
19436
|
*/
|
|
19437
19437
|
refunded?: Price$7;
|
|
19438
|
+
/**
|
|
19439
|
+
* Sum of all authorized payments
|
|
19440
|
+
* @readonly
|
|
19441
|
+
*/
|
|
19442
|
+
authorized?: Price$7;
|
|
19438
19443
|
}
|
|
19439
19444
|
interface DeleteDraftOrderRequest$1 {
|
|
19440
19445
|
/** The draft order id */
|
|
@@ -19503,7 +19508,7 @@ interface QueryDraftOrdersResponse$1 {
|
|
|
19503
19508
|
pagingMetadata?: CursorPagingMetadata$b;
|
|
19504
19509
|
}
|
|
19505
19510
|
interface CursorPagingMetadata$b {
|
|
19506
|
-
/** Number of items returned in
|
|
19511
|
+
/** Number of items returned in current page. */
|
|
19507
19512
|
count?: number | null;
|
|
19508
19513
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
19509
19514
|
cursors?: Cursors$b;
|
|
@@ -21887,6 +21892,11 @@ interface V1BalanceSummary {
|
|
|
21887
21892
|
* @readonly
|
|
21888
21893
|
*/
|
|
21889
21894
|
refunded?: Price$6;
|
|
21895
|
+
/**
|
|
21896
|
+
* Sum of all authorized payments
|
|
21897
|
+
* @readonly
|
|
21898
|
+
*/
|
|
21899
|
+
authorized?: Price$6;
|
|
21890
21900
|
}
|
|
21891
21901
|
interface DeleteDraftOrderRequest {
|
|
21892
21902
|
/** The draft order id */
|
|
@@ -21955,7 +21965,7 @@ interface QueryDraftOrdersResponse {
|
|
|
21955
21965
|
pagingMetadata?: CursorPagingMetadata$a;
|
|
21956
21966
|
}
|
|
21957
21967
|
interface CursorPagingMetadata$a {
|
|
21958
|
-
/** Number of items returned in
|
|
21968
|
+
/** Number of items returned in current page. */
|
|
21959
21969
|
count?: number | null;
|
|
21960
21970
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
21961
21971
|
cursors?: Cursors$a;
|
|
@@ -24796,6 +24806,11 @@ interface BalanceSummary$1 {
|
|
|
24796
24806
|
* @readonly
|
|
24797
24807
|
*/
|
|
24798
24808
|
refunded?: Price$5;
|
|
24809
|
+
/**
|
|
24810
|
+
* Sum of all authorized payments
|
|
24811
|
+
* @readonly
|
|
24812
|
+
*/
|
|
24813
|
+
authorized?: Price$5;
|
|
24799
24814
|
}
|
|
24800
24815
|
/**
|
|
24801
24816
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -24852,6 +24867,259 @@ interface ExtendedFields$7 {
|
|
|
24852
24867
|
*/
|
|
24853
24868
|
namespaces?: Record<string, Record<string, any>>;
|
|
24854
24869
|
}
|
|
24870
|
+
interface OrderTransactions$3 {
|
|
24871
|
+
/** Order ID. */
|
|
24872
|
+
orderId?: string;
|
|
24873
|
+
/** Record of payments made to the merchant. */
|
|
24874
|
+
payments?: Payment$3[];
|
|
24875
|
+
/** Record of refunds made to the buyer. */
|
|
24876
|
+
refunds?: Refund$3[];
|
|
24877
|
+
}
|
|
24878
|
+
interface Payment$3 extends PaymentPaymentDetailsOneOf$3 {
|
|
24879
|
+
/** Regular payment details. */
|
|
24880
|
+
regularPaymentDetails?: RegularPaymentDetails$3;
|
|
24881
|
+
/** Gift card payment details. */
|
|
24882
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$3;
|
|
24883
|
+
/**
|
|
24884
|
+
* Payment ID.
|
|
24885
|
+
* @readonly
|
|
24886
|
+
*/
|
|
24887
|
+
id?: string | null;
|
|
24888
|
+
/** 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. */
|
|
24889
|
+
createdDate?: Date;
|
|
24890
|
+
/**
|
|
24891
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
24892
|
+
* @readonly
|
|
24893
|
+
*/
|
|
24894
|
+
updatedDate?: Date;
|
|
24895
|
+
/** Payment amount. */
|
|
24896
|
+
amount?: Price$5;
|
|
24897
|
+
/**
|
|
24898
|
+
* Whether refunds for this payment are disabled.
|
|
24899
|
+
* + `true`: This payment is not refundable.
|
|
24900
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
24901
|
+
*/
|
|
24902
|
+
refundDisabled?: boolean;
|
|
24903
|
+
}
|
|
24904
|
+
/** @oneof */
|
|
24905
|
+
interface PaymentPaymentDetailsOneOf$3 {
|
|
24906
|
+
/** Regular payment details. */
|
|
24907
|
+
regularPaymentDetails?: RegularPaymentDetails$3;
|
|
24908
|
+
/** Gift card payment details. */
|
|
24909
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$3;
|
|
24910
|
+
}
|
|
24911
|
+
interface RegularPaymentDetails$3 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$3 {
|
|
24912
|
+
/** Whether regular card used */
|
|
24913
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$3;
|
|
24914
|
+
/** Wix Payments order ID. */
|
|
24915
|
+
paymentOrderId?: string | null;
|
|
24916
|
+
/**
|
|
24917
|
+
* 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).
|
|
24918
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
24919
|
+
*/
|
|
24920
|
+
gatewayTransactionId?: string | null;
|
|
24921
|
+
/**
|
|
24922
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
24923
|
+
* + `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`
|
|
24924
|
+
*/
|
|
24925
|
+
paymentMethod?: string | null;
|
|
24926
|
+
/** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */
|
|
24927
|
+
providerTransactionId?: string | null;
|
|
24928
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
24929
|
+
offlinePayment?: boolean;
|
|
24930
|
+
/** Payment status. */
|
|
24931
|
+
status?: TransactionStatus$3;
|
|
24932
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
24933
|
+
savedPaymentMethod?: boolean;
|
|
24934
|
+
/** Authorization details. */
|
|
24935
|
+
authorizationDetails?: AuthorizationDetails$3;
|
|
24936
|
+
}
|
|
24937
|
+
/** @oneof */
|
|
24938
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$3 {
|
|
24939
|
+
/** Whether regular card used */
|
|
24940
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$3;
|
|
24941
|
+
}
|
|
24942
|
+
declare enum TransactionStatus$3 {
|
|
24943
|
+
UNDEFINED = "UNDEFINED",
|
|
24944
|
+
APPROVED = "APPROVED",
|
|
24945
|
+
PENDING = "PENDING",
|
|
24946
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
24947
|
+
CANCELED = "CANCELED",
|
|
24948
|
+
DECLINED = "DECLINED",
|
|
24949
|
+
REFUNDED = "REFUNDED",
|
|
24950
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
24951
|
+
AUTHORIZED = "AUTHORIZED",
|
|
24952
|
+
VOIDED = "VOIDED"
|
|
24953
|
+
}
|
|
24954
|
+
interface CreditCardPaymentMethodDetails$3 {
|
|
24955
|
+
/** The last 4 digits of the card number. */
|
|
24956
|
+
lastFourDigits?: string | null;
|
|
24957
|
+
/** Card issuer's brand. */
|
|
24958
|
+
brand?: string | null;
|
|
24959
|
+
}
|
|
24960
|
+
interface AuthorizationDetails$3 {
|
|
24961
|
+
/**
|
|
24962
|
+
* Whether the authorized payment is of a delayed capture.
|
|
24963
|
+
* @readonly
|
|
24964
|
+
*/
|
|
24965
|
+
delayedCapture?: boolean;
|
|
24966
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
24967
|
+
authorizedDate?: Date;
|
|
24968
|
+
/**
|
|
24969
|
+
* List of captures associated with payment
|
|
24970
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
24971
|
+
*/
|
|
24972
|
+
captures?: AuthorizationCapture$3[];
|
|
24973
|
+
/** Void associated with payment */
|
|
24974
|
+
void?: AuthorizationVoid$3;
|
|
24975
|
+
/** Scheduled action for this transaction */
|
|
24976
|
+
scheduledAction?: ScheduledAction$3;
|
|
24977
|
+
}
|
|
24978
|
+
interface AuthorizationCapture$3 {
|
|
24979
|
+
/**
|
|
24980
|
+
* Capture ID.
|
|
24981
|
+
* @readonly
|
|
24982
|
+
*/
|
|
24983
|
+
id?: string | null;
|
|
24984
|
+
/** Status of this capture action */
|
|
24985
|
+
status?: AuthorizationCaptureStatus$3;
|
|
24986
|
+
/** Amount of this capture */
|
|
24987
|
+
amount?: Price$5;
|
|
24988
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
24989
|
+
createdDate?: Date;
|
|
24990
|
+
/** In case of status is FAILED may contain failure details */
|
|
24991
|
+
failureDetails?: AuthorizationActionFailureDetails$3;
|
|
24992
|
+
}
|
|
24993
|
+
declare enum AuthorizationCaptureStatus$3 {
|
|
24994
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
24995
|
+
/** Whether capture operation still in progress */
|
|
24996
|
+
PENDING = "PENDING",
|
|
24997
|
+
/** The capture operation was succeeded */
|
|
24998
|
+
SUCCEEDED = "SUCCEEDED",
|
|
24999
|
+
/** The capture operation was failed */
|
|
25000
|
+
FAILED = "FAILED"
|
|
25001
|
+
}
|
|
25002
|
+
interface AuthorizationActionFailureDetails$3 {
|
|
25003
|
+
failureCode?: string;
|
|
25004
|
+
}
|
|
25005
|
+
interface AuthorizationVoid$3 {
|
|
25006
|
+
/** Status of this void action */
|
|
25007
|
+
status?: AuthorizationVoidStatus$3;
|
|
25008
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
25009
|
+
voidedDate?: Date;
|
|
25010
|
+
/** In case of status is FAILED may contain failure details */
|
|
25011
|
+
failureDetails?: AuthorizationActionFailureDetails$3;
|
|
25012
|
+
/** Reason of void action */
|
|
25013
|
+
reason?: Reason$3;
|
|
25014
|
+
}
|
|
25015
|
+
declare enum AuthorizationVoidStatus$3 {
|
|
25016
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
25017
|
+
/** Whether void operation still in progress */
|
|
25018
|
+
PENDING = "PENDING",
|
|
25019
|
+
/** The void operation was succeeded */
|
|
25020
|
+
SUCCEEDED = "SUCCEEDED",
|
|
25021
|
+
/** The void operation was failed */
|
|
25022
|
+
FAILED = "FAILED"
|
|
25023
|
+
}
|
|
25024
|
+
/**
|
|
25025
|
+
* Reason the authorization was voided.
|
|
25026
|
+
*
|
|
25027
|
+
* + `MANUAL`: Authorization was voided by user.
|
|
25028
|
+
* + `SCHEDULED`: Authorization passed execution date.
|
|
25029
|
+
*/
|
|
25030
|
+
declare enum Reason$3 {
|
|
25031
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
25032
|
+
MANUAL = "MANUAL",
|
|
25033
|
+
SCHEDULED = "SCHEDULED"
|
|
25034
|
+
}
|
|
25035
|
+
interface ScheduledAction$3 {
|
|
25036
|
+
/** type of the action */
|
|
25037
|
+
actionType?: ActionType$3;
|
|
25038
|
+
/** the date and time of the action */
|
|
25039
|
+
executionDate?: Date;
|
|
25040
|
+
}
|
|
25041
|
+
declare enum ActionType$3 {
|
|
25042
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
25043
|
+
VOID = "VOID",
|
|
25044
|
+
CAPTURE = "CAPTURE"
|
|
25045
|
+
}
|
|
25046
|
+
interface GiftCardPaymentDetails$3 {
|
|
25047
|
+
/** Gift card payment ID. */
|
|
25048
|
+
giftCardPaymentId?: string;
|
|
25049
|
+
/** ID of the app that created the gift card. */
|
|
25050
|
+
appId?: string;
|
|
25051
|
+
/**
|
|
25052
|
+
* Whether the gift card is voided.
|
|
25053
|
+
* @readonly
|
|
25054
|
+
*/
|
|
25055
|
+
voided?: boolean;
|
|
25056
|
+
}
|
|
25057
|
+
declare enum MembershipPaymentStatus$3 {
|
|
25058
|
+
/** CHARGED - Payment was charged */
|
|
25059
|
+
CHARGED = "CHARGED",
|
|
25060
|
+
/** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
|
|
25061
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
25062
|
+
}
|
|
25063
|
+
interface Refund$3 {
|
|
25064
|
+
/**
|
|
25065
|
+
* Refund ID.
|
|
25066
|
+
* @readonly
|
|
25067
|
+
*/
|
|
25068
|
+
id?: string;
|
|
25069
|
+
/** List of transactions. */
|
|
25070
|
+
transactions?: RefundTransaction$3[];
|
|
25071
|
+
/** Refund business details. */
|
|
25072
|
+
details?: RefundDetails$3;
|
|
25073
|
+
/** 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. */
|
|
25074
|
+
createdDate?: Date;
|
|
25075
|
+
}
|
|
25076
|
+
interface RefundTransaction$3 {
|
|
25077
|
+
/** ID of the payment associated with this refund. */
|
|
25078
|
+
paymentId?: string;
|
|
25079
|
+
/** Refund amount. */
|
|
25080
|
+
amount?: Price$5;
|
|
25081
|
+
/** Refund status. */
|
|
25082
|
+
refundStatus?: RefundStatus$3;
|
|
25083
|
+
/**
|
|
25084
|
+
* 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).
|
|
25085
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
25086
|
+
*/
|
|
25087
|
+
gatewayRefundId?: string | null;
|
|
25088
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
25089
|
+
providerRefundId?: string | null;
|
|
25090
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
25091
|
+
externalRefund?: boolean;
|
|
25092
|
+
}
|
|
25093
|
+
/**
|
|
25094
|
+
* Refund transaction status.
|
|
25095
|
+
* + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
|
|
25096
|
+
* + `SUCCEEDED`: Refund transaction succeeded.
|
|
25097
|
+
* + `FAILED`: Refund transaction failed.
|
|
25098
|
+
* + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
|
|
25099
|
+
* + `STARTED`: Refund was initiated on payment provider side.
|
|
25100
|
+
*/
|
|
25101
|
+
declare enum RefundStatus$3 {
|
|
25102
|
+
PENDING = "PENDING",
|
|
25103
|
+
SUCCEEDED = "SUCCEEDED",
|
|
25104
|
+
FAILED = "FAILED",
|
|
25105
|
+
SCHEDULED = "SCHEDULED",
|
|
25106
|
+
STARTED = "STARTED"
|
|
25107
|
+
}
|
|
25108
|
+
/** Business model of a refund request */
|
|
25109
|
+
interface RefundDetails$3 {
|
|
25110
|
+
/** Order line item IDs and quantities that were refunded. */
|
|
25111
|
+
items?: RefundItem$3[];
|
|
25112
|
+
/** Whether the shipping fee was also refunded. */
|
|
25113
|
+
shippingIncluded?: boolean;
|
|
25114
|
+
/** Reason for the refund, provided by customer (optional). */
|
|
25115
|
+
reason?: string | null;
|
|
25116
|
+
}
|
|
25117
|
+
interface RefundItem$3 {
|
|
25118
|
+
/** Line item ID the refunded line item. */
|
|
25119
|
+
lineItemId?: string;
|
|
25120
|
+
/** Line item quantity refunded. */
|
|
25121
|
+
quantity?: number;
|
|
25122
|
+
}
|
|
24855
25123
|
interface Sorting$9 {
|
|
24856
25124
|
/** Name of the field to sort by. */
|
|
24857
25125
|
fieldName?: string;
|
|
@@ -24932,6 +25200,35 @@ interface BulkActionMetadata$3 {
|
|
|
24932
25200
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
24933
25201
|
undetailedFailures?: number;
|
|
24934
25202
|
}
|
|
25203
|
+
interface VoidAuthorizedPaymentsRequest$1 {
|
|
25204
|
+
/** Wix eCommerce order ID */
|
|
25205
|
+
ecomOrderId: string;
|
|
25206
|
+
/** Payment IDs */
|
|
25207
|
+
paymentIds: string[];
|
|
25208
|
+
}
|
|
25209
|
+
interface VoidAuthorizedPaymentsResponse$1 {
|
|
25210
|
+
/** All order's transactions after the void was triggered */
|
|
25211
|
+
orderTransactions?: OrderTransactions$3;
|
|
25212
|
+
}
|
|
25213
|
+
interface CaptureAuthorizedPaymentsRequest$1 {
|
|
25214
|
+
/** Wix eCommerce order ID */
|
|
25215
|
+
ecomOrderId: string;
|
|
25216
|
+
/** Capture payments information */
|
|
25217
|
+
payments: PaymentCapture$1[];
|
|
25218
|
+
}
|
|
25219
|
+
interface PaymentCapture$1 {
|
|
25220
|
+
/** Payment ID */
|
|
25221
|
+
paymentId?: string | null;
|
|
25222
|
+
/**
|
|
25223
|
+
* Capture amount.
|
|
25224
|
+
* If not provided - full authorized amount will be captured.
|
|
25225
|
+
*/
|
|
25226
|
+
amount?: Price$5;
|
|
25227
|
+
}
|
|
25228
|
+
interface CaptureAuthorizedPaymentsResponse$1 {
|
|
25229
|
+
/** All order's transactions after the capture was triggered */
|
|
25230
|
+
orderTransactions?: OrderTransactions$3;
|
|
25231
|
+
}
|
|
24935
25232
|
interface GetOrderRequest$1 {
|
|
24936
25233
|
/** ID of the order to retrieve. */
|
|
24937
25234
|
id: string;
|
|
@@ -24986,7 +25283,7 @@ interface SearchOrdersResponse$1 {
|
|
|
24986
25283
|
metadata?: CursorPagingMetadata$9;
|
|
24987
25284
|
}
|
|
24988
25285
|
interface CursorPagingMetadata$9 {
|
|
24989
|
-
/** Number of items returned in
|
|
25286
|
+
/** Number of items returned in current page. */
|
|
24990
25287
|
count?: number | null;
|
|
24991
25288
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
24992
25289
|
cursors?: Cursors$9;
|
|
@@ -25057,38 +25354,142 @@ interface GetPaymentCollectabilityStatusResponseNonNullableFields$1 {
|
|
|
25057
25354
|
amount?: PriceNonNullableFields$5;
|
|
25058
25355
|
authorizationSupported: boolean;
|
|
25059
25356
|
}
|
|
25060
|
-
interface
|
|
25061
|
-
|
|
25357
|
+
interface AuthorizationActionFailureDetailsNonNullableFields$3 {
|
|
25358
|
+
failureCode: string;
|
|
25062
25359
|
}
|
|
25063
|
-
interface
|
|
25064
|
-
|
|
25065
|
-
|
|
25360
|
+
interface AuthorizationCaptureNonNullableFields$3 {
|
|
25361
|
+
status: AuthorizationCaptureStatus$3;
|
|
25362
|
+
amount?: PriceNonNullableFields$5;
|
|
25363
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$3;
|
|
25066
25364
|
}
|
|
25067
|
-
interface
|
|
25068
|
-
|
|
25365
|
+
interface AuthorizationVoidNonNullableFields$3 {
|
|
25366
|
+
status: AuthorizationVoidStatus$3;
|
|
25367
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$3;
|
|
25368
|
+
reason: Reason$3;
|
|
25069
25369
|
}
|
|
25070
|
-
interface
|
|
25071
|
-
|
|
25370
|
+
interface ScheduledActionNonNullableFields$3 {
|
|
25371
|
+
actionType: ActionType$3;
|
|
25072
25372
|
}
|
|
25073
|
-
interface
|
|
25074
|
-
|
|
25373
|
+
interface AuthorizationDetailsNonNullableFields$3 {
|
|
25374
|
+
delayedCapture: boolean;
|
|
25375
|
+
captures: AuthorizationCaptureNonNullableFields$3[];
|
|
25376
|
+
void?: AuthorizationVoidNonNullableFields$3;
|
|
25377
|
+
scheduledAction?: ScheduledActionNonNullableFields$3;
|
|
25075
25378
|
}
|
|
25076
|
-
interface
|
|
25077
|
-
|
|
25078
|
-
|
|
25079
|
-
|
|
25080
|
-
|
|
25081
|
-
name?: DescriptionLineNameNonNullableFields$1;
|
|
25082
|
-
lineType: DescriptionLineType$1;
|
|
25379
|
+
interface RegularPaymentDetailsNonNullableFields$3 {
|
|
25380
|
+
offlinePayment: boolean;
|
|
25381
|
+
status: TransactionStatus$3;
|
|
25382
|
+
savedPaymentMethod: boolean;
|
|
25383
|
+
authorizationDetails?: AuthorizationDetailsNonNullableFields$3;
|
|
25083
25384
|
}
|
|
25084
|
-
interface
|
|
25085
|
-
|
|
25086
|
-
|
|
25087
|
-
|
|
25088
|
-
|
|
25385
|
+
interface GiftCardPaymentDetailsNonNullableFields$3 {
|
|
25386
|
+
giftCardPaymentId: string;
|
|
25387
|
+
giftCardId: string;
|
|
25388
|
+
appId: string;
|
|
25389
|
+
voided: boolean;
|
|
25089
25390
|
}
|
|
25090
|
-
interface
|
|
25091
|
-
|
|
25391
|
+
interface MembershipNameNonNullableFields$5 {
|
|
25392
|
+
original: string;
|
|
25393
|
+
}
|
|
25394
|
+
interface MembershipPaymentDetailsNonNullableFields$3 {
|
|
25395
|
+
membershipId: string;
|
|
25396
|
+
lineItemId: string;
|
|
25397
|
+
status: MembershipPaymentStatus$3;
|
|
25398
|
+
name?: MembershipNameNonNullableFields$5;
|
|
25399
|
+
voided: boolean;
|
|
25400
|
+
providerAppId: string;
|
|
25401
|
+
}
|
|
25402
|
+
interface PaymentNonNullableFields$3 {
|
|
25403
|
+
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields$3;
|
|
25404
|
+
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields$3;
|
|
25405
|
+
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields$3;
|
|
25406
|
+
amount?: PriceNonNullableFields$5;
|
|
25407
|
+
refundDisabled: boolean;
|
|
25408
|
+
}
|
|
25409
|
+
interface RefundTransactionNonNullableFields$3 {
|
|
25410
|
+
paymentId: string;
|
|
25411
|
+
amount?: PriceNonNullableFields$5;
|
|
25412
|
+
refundStatus: RefundStatus$3;
|
|
25413
|
+
externalRefund: boolean;
|
|
25414
|
+
}
|
|
25415
|
+
interface RefundItemNonNullableFields$3 {
|
|
25416
|
+
lineItemId: string;
|
|
25417
|
+
quantity: number;
|
|
25418
|
+
}
|
|
25419
|
+
interface LineItemRefundNonNullableFields$3 {
|
|
25420
|
+
lineItemId: string;
|
|
25421
|
+
quantity: number;
|
|
25422
|
+
}
|
|
25423
|
+
interface AdditionalFeeRefundNonNullableFields$3 {
|
|
25424
|
+
additionalFeeId: string;
|
|
25425
|
+
amount?: PriceNonNullableFields$5;
|
|
25426
|
+
}
|
|
25427
|
+
interface ShippingRefundNonNullableFields$3 {
|
|
25428
|
+
amount?: PriceNonNullableFields$5;
|
|
25429
|
+
}
|
|
25430
|
+
interface RefundDetailsNonNullableFields$3 {
|
|
25431
|
+
items: RefundItemNonNullableFields$3[];
|
|
25432
|
+
shippingIncluded: boolean;
|
|
25433
|
+
lineItems: LineItemRefundNonNullableFields$3[];
|
|
25434
|
+
additionalFees: AdditionalFeeRefundNonNullableFields$3[];
|
|
25435
|
+
shipping?: ShippingRefundNonNullableFields$3;
|
|
25436
|
+
}
|
|
25437
|
+
interface AggregatedRefundSummaryNonNullableFields$3 {
|
|
25438
|
+
requestedRefund?: PriceNonNullableFields$5;
|
|
25439
|
+
pendingRefund?: PriceNonNullableFields$5;
|
|
25440
|
+
refunded?: PriceNonNullableFields$5;
|
|
25441
|
+
failedRefundAmount?: PriceNonNullableFields$5;
|
|
25442
|
+
pending: boolean;
|
|
25443
|
+
}
|
|
25444
|
+
interface RefundNonNullableFields$3 {
|
|
25445
|
+
id: string;
|
|
25446
|
+
transactions: RefundTransactionNonNullableFields$3[];
|
|
25447
|
+
details?: RefundDetailsNonNullableFields$3;
|
|
25448
|
+
summary?: AggregatedRefundSummaryNonNullableFields$3;
|
|
25449
|
+
}
|
|
25450
|
+
interface OrderTransactionsNonNullableFields$3 {
|
|
25451
|
+
orderId: string;
|
|
25452
|
+
payments: PaymentNonNullableFields$3[];
|
|
25453
|
+
refunds: RefundNonNullableFields$3[];
|
|
25454
|
+
}
|
|
25455
|
+
interface VoidAuthorizedPaymentsResponseNonNullableFields$1 {
|
|
25456
|
+
orderTransactions?: OrderTransactionsNonNullableFields$3;
|
|
25457
|
+
}
|
|
25458
|
+
interface CaptureAuthorizedPaymentsResponseNonNullableFields$1 {
|
|
25459
|
+
orderTransactions?: OrderTransactionsNonNullableFields$3;
|
|
25460
|
+
}
|
|
25461
|
+
interface ProductNameNonNullableFields$1 {
|
|
25462
|
+
original: string;
|
|
25463
|
+
}
|
|
25464
|
+
interface CatalogReferenceNonNullableFields$1 {
|
|
25465
|
+
catalogItemId: string;
|
|
25466
|
+
appId: string;
|
|
25467
|
+
}
|
|
25468
|
+
interface PlainTextValueNonNullableFields$1 {
|
|
25469
|
+
original: string;
|
|
25470
|
+
}
|
|
25471
|
+
interface ColorNonNullableFields$1 {
|
|
25472
|
+
original: string;
|
|
25473
|
+
}
|
|
25474
|
+
interface DescriptionLineNameNonNullableFields$1 {
|
|
25475
|
+
original: string;
|
|
25476
|
+
}
|
|
25477
|
+
interface DescriptionLineNonNullableFields$1 {
|
|
25478
|
+
plainText?: PlainTextValueNonNullableFields$1;
|
|
25479
|
+
colorInfo?: ColorNonNullableFields$1;
|
|
25480
|
+
plainTextValue?: PlainTextValueNonNullableFields$1;
|
|
25481
|
+
color: string;
|
|
25482
|
+
name?: DescriptionLineNameNonNullableFields$1;
|
|
25483
|
+
lineType: DescriptionLineType$1;
|
|
25484
|
+
}
|
|
25485
|
+
interface ImageNonNullableFields$1 {
|
|
25486
|
+
id: string;
|
|
25487
|
+
url: string;
|
|
25488
|
+
height: number;
|
|
25489
|
+
width: number;
|
|
25490
|
+
}
|
|
25491
|
+
interface PhysicalPropertiesNonNullableFields$1 {
|
|
25492
|
+
shippable: boolean;
|
|
25092
25493
|
}
|
|
25093
25494
|
interface ItemTypeNonNullableFields$1 {
|
|
25094
25495
|
preset: ItemTypeItemType$3;
|
|
@@ -26494,6 +26895,11 @@ interface BalanceSummary {
|
|
|
26494
26895
|
* @readonly
|
|
26495
26896
|
*/
|
|
26496
26897
|
refunded?: Price$4;
|
|
26898
|
+
/**
|
|
26899
|
+
* Sum of all authorized payments
|
|
26900
|
+
* @readonly
|
|
26901
|
+
*/
|
|
26902
|
+
authorized?: Price$4;
|
|
26497
26903
|
}
|
|
26498
26904
|
/**
|
|
26499
26905
|
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
@@ -26550,6 +26956,259 @@ interface ExtendedFields$6 {
|
|
|
26550
26956
|
*/
|
|
26551
26957
|
namespaces?: Record<string, Record<string, any>>;
|
|
26552
26958
|
}
|
|
26959
|
+
interface OrderTransactions$2 {
|
|
26960
|
+
/** Order ID. */
|
|
26961
|
+
orderId?: string;
|
|
26962
|
+
/** Record of payments made to the merchant. */
|
|
26963
|
+
payments?: Payment$2[];
|
|
26964
|
+
/** Record of refunds made to the buyer. */
|
|
26965
|
+
refunds?: Refund$2[];
|
|
26966
|
+
}
|
|
26967
|
+
interface Payment$2 extends PaymentPaymentDetailsOneOf$2 {
|
|
26968
|
+
/** Regular payment details. */
|
|
26969
|
+
regularPaymentDetails?: RegularPaymentDetails$2;
|
|
26970
|
+
/** Gift card payment details. */
|
|
26971
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$2;
|
|
26972
|
+
/**
|
|
26973
|
+
* Payment ID.
|
|
26974
|
+
* @readonly
|
|
26975
|
+
*/
|
|
26976
|
+
_id?: string | null;
|
|
26977
|
+
/** 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. */
|
|
26978
|
+
_createdDate?: Date;
|
|
26979
|
+
/**
|
|
26980
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
26981
|
+
* @readonly
|
|
26982
|
+
*/
|
|
26983
|
+
_updatedDate?: Date;
|
|
26984
|
+
/** Payment amount. */
|
|
26985
|
+
amount?: Price$4;
|
|
26986
|
+
/**
|
|
26987
|
+
* Whether refunds for this payment are disabled.
|
|
26988
|
+
* + `true`: This payment is not refundable.
|
|
26989
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
26990
|
+
*/
|
|
26991
|
+
refundDisabled?: boolean;
|
|
26992
|
+
}
|
|
26993
|
+
/** @oneof */
|
|
26994
|
+
interface PaymentPaymentDetailsOneOf$2 {
|
|
26995
|
+
/** Regular payment details. */
|
|
26996
|
+
regularPaymentDetails?: RegularPaymentDetails$2;
|
|
26997
|
+
/** Gift card payment details. */
|
|
26998
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails$2;
|
|
26999
|
+
}
|
|
27000
|
+
interface RegularPaymentDetails$2 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$2 {
|
|
27001
|
+
/** Whether regular card used */
|
|
27002
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$2;
|
|
27003
|
+
/** Wix Payments order ID. */
|
|
27004
|
+
paymentOrderId?: string | null;
|
|
27005
|
+
/**
|
|
27006
|
+
* 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).
|
|
27007
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
27008
|
+
*/
|
|
27009
|
+
gatewayTransactionId?: string | null;
|
|
27010
|
+
/**
|
|
27011
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
27012
|
+
* + `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`
|
|
27013
|
+
*/
|
|
27014
|
+
paymentMethod?: string | null;
|
|
27015
|
+
/** Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments. */
|
|
27016
|
+
providerTransactionId?: string | null;
|
|
27017
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
27018
|
+
offlinePayment?: boolean;
|
|
27019
|
+
/** Payment status. */
|
|
27020
|
+
status?: TransactionStatus$2;
|
|
27021
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
27022
|
+
savedPaymentMethod?: boolean;
|
|
27023
|
+
/** Authorization details. */
|
|
27024
|
+
authorizationDetails?: AuthorizationDetails$2;
|
|
27025
|
+
}
|
|
27026
|
+
/** @oneof */
|
|
27027
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$2 {
|
|
27028
|
+
/** Whether regular card used */
|
|
27029
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$2;
|
|
27030
|
+
}
|
|
27031
|
+
declare enum TransactionStatus$2 {
|
|
27032
|
+
UNDEFINED = "UNDEFINED",
|
|
27033
|
+
APPROVED = "APPROVED",
|
|
27034
|
+
PENDING = "PENDING",
|
|
27035
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
27036
|
+
CANCELED = "CANCELED",
|
|
27037
|
+
DECLINED = "DECLINED",
|
|
27038
|
+
REFUNDED = "REFUNDED",
|
|
27039
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
27040
|
+
AUTHORIZED = "AUTHORIZED",
|
|
27041
|
+
VOIDED = "VOIDED"
|
|
27042
|
+
}
|
|
27043
|
+
interface CreditCardPaymentMethodDetails$2 {
|
|
27044
|
+
/** The last 4 digits of the card number. */
|
|
27045
|
+
lastFourDigits?: string | null;
|
|
27046
|
+
/** Card issuer's brand. */
|
|
27047
|
+
brand?: string | null;
|
|
27048
|
+
}
|
|
27049
|
+
interface AuthorizationDetails$2 {
|
|
27050
|
+
/**
|
|
27051
|
+
* Whether the authorized payment is of a delayed capture.
|
|
27052
|
+
* @readonly
|
|
27053
|
+
*/
|
|
27054
|
+
delayedCapture?: boolean;
|
|
27055
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27056
|
+
authorizedDate?: Date;
|
|
27057
|
+
/**
|
|
27058
|
+
* List of captures associated with payment
|
|
27059
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
27060
|
+
*/
|
|
27061
|
+
captures?: AuthorizationCapture$2[];
|
|
27062
|
+
/** Void associated with payment */
|
|
27063
|
+
void?: AuthorizationVoid$2;
|
|
27064
|
+
/** Scheduled action for this transaction */
|
|
27065
|
+
scheduledAction?: ScheduledAction$2;
|
|
27066
|
+
}
|
|
27067
|
+
interface AuthorizationCapture$2 {
|
|
27068
|
+
/**
|
|
27069
|
+
* Capture ID.
|
|
27070
|
+
* @readonly
|
|
27071
|
+
*/
|
|
27072
|
+
_id?: string | null;
|
|
27073
|
+
/** Status of this capture action */
|
|
27074
|
+
status?: AuthorizationCaptureStatus$2;
|
|
27075
|
+
/** Amount of this capture */
|
|
27076
|
+
amount?: Price$4;
|
|
27077
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27078
|
+
_createdDate?: Date;
|
|
27079
|
+
/** In case of status is FAILED may contain failure details */
|
|
27080
|
+
failureDetails?: AuthorizationActionFailureDetails$2;
|
|
27081
|
+
}
|
|
27082
|
+
declare enum AuthorizationCaptureStatus$2 {
|
|
27083
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27084
|
+
/** Whether capture operation still in progress */
|
|
27085
|
+
PENDING = "PENDING",
|
|
27086
|
+
/** The capture operation was succeeded */
|
|
27087
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27088
|
+
/** The capture operation was failed */
|
|
27089
|
+
FAILED = "FAILED"
|
|
27090
|
+
}
|
|
27091
|
+
interface AuthorizationActionFailureDetails$2 {
|
|
27092
|
+
failureCode?: string;
|
|
27093
|
+
}
|
|
27094
|
+
interface AuthorizationVoid$2 {
|
|
27095
|
+
/** Status of this void action */
|
|
27096
|
+
status?: AuthorizationVoidStatus$2;
|
|
27097
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
27098
|
+
voidedDate?: Date;
|
|
27099
|
+
/** In case of status is FAILED may contain failure details */
|
|
27100
|
+
failureDetails?: AuthorizationActionFailureDetails$2;
|
|
27101
|
+
/** Reason of void action */
|
|
27102
|
+
reason?: Reason$2;
|
|
27103
|
+
}
|
|
27104
|
+
declare enum AuthorizationVoidStatus$2 {
|
|
27105
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27106
|
+
/** Whether void operation still in progress */
|
|
27107
|
+
PENDING = "PENDING",
|
|
27108
|
+
/** The void operation was succeeded */
|
|
27109
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27110
|
+
/** The void operation was failed */
|
|
27111
|
+
FAILED = "FAILED"
|
|
27112
|
+
}
|
|
27113
|
+
/**
|
|
27114
|
+
* Reason the authorization was voided.
|
|
27115
|
+
*
|
|
27116
|
+
* + `MANUAL`: Authorization was voided by user.
|
|
27117
|
+
* + `SCHEDULED`: Authorization passed execution date.
|
|
27118
|
+
*/
|
|
27119
|
+
declare enum Reason$2 {
|
|
27120
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
27121
|
+
MANUAL = "MANUAL",
|
|
27122
|
+
SCHEDULED = "SCHEDULED"
|
|
27123
|
+
}
|
|
27124
|
+
interface ScheduledAction$2 {
|
|
27125
|
+
/** type of the action */
|
|
27126
|
+
actionType?: ActionType$2;
|
|
27127
|
+
/** the date and time of the action */
|
|
27128
|
+
executionDate?: Date;
|
|
27129
|
+
}
|
|
27130
|
+
declare enum ActionType$2 {
|
|
27131
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
27132
|
+
VOID = "VOID",
|
|
27133
|
+
CAPTURE = "CAPTURE"
|
|
27134
|
+
}
|
|
27135
|
+
interface GiftCardPaymentDetails$2 {
|
|
27136
|
+
/** Gift card payment ID. */
|
|
27137
|
+
giftCardPaymentId?: string;
|
|
27138
|
+
/** ID of the app that created the gift card. */
|
|
27139
|
+
appId?: string;
|
|
27140
|
+
/**
|
|
27141
|
+
* Whether the gift card is voided.
|
|
27142
|
+
* @readonly
|
|
27143
|
+
*/
|
|
27144
|
+
voided?: boolean;
|
|
27145
|
+
}
|
|
27146
|
+
declare enum MembershipPaymentStatus$2 {
|
|
27147
|
+
/** CHARGED - Payment was charged */
|
|
27148
|
+
CHARGED = "CHARGED",
|
|
27149
|
+
/** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
|
|
27150
|
+
CHARGE_FAILED = "CHARGE_FAILED"
|
|
27151
|
+
}
|
|
27152
|
+
interface Refund$2 {
|
|
27153
|
+
/**
|
|
27154
|
+
* Refund ID.
|
|
27155
|
+
* @readonly
|
|
27156
|
+
*/
|
|
27157
|
+
_id?: string;
|
|
27158
|
+
/** List of transactions. */
|
|
27159
|
+
transactions?: RefundTransaction$2[];
|
|
27160
|
+
/** Refund business details. */
|
|
27161
|
+
details?: RefundDetails$2;
|
|
27162
|
+
/** 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. */
|
|
27163
|
+
_createdDate?: Date;
|
|
27164
|
+
}
|
|
27165
|
+
interface RefundTransaction$2 {
|
|
27166
|
+
/** ID of the payment associated with this refund. */
|
|
27167
|
+
paymentId?: string;
|
|
27168
|
+
/** Refund amount. */
|
|
27169
|
+
amount?: Price$4;
|
|
27170
|
+
/** Refund status. */
|
|
27171
|
+
refundStatus?: RefundStatus$2;
|
|
27172
|
+
/**
|
|
27173
|
+
* 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).
|
|
27174
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
27175
|
+
*/
|
|
27176
|
+
gatewayRefundId?: string | null;
|
|
27177
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
27178
|
+
providerRefundId?: string | null;
|
|
27179
|
+
/** Whether refund was made externally and manually on the payment provider's side. */
|
|
27180
|
+
externalRefund?: boolean;
|
|
27181
|
+
}
|
|
27182
|
+
/**
|
|
27183
|
+
* Refund transaction status.
|
|
27184
|
+
* + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
|
|
27185
|
+
* + `SUCCEEDED`: Refund transaction succeeded.
|
|
27186
|
+
* + `FAILED`: Refund transaction failed.
|
|
27187
|
+
* + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
|
|
27188
|
+
* + `STARTED`: Refund was initiated on payment provider side.
|
|
27189
|
+
*/
|
|
27190
|
+
declare enum RefundStatus$2 {
|
|
27191
|
+
PENDING = "PENDING",
|
|
27192
|
+
SUCCEEDED = "SUCCEEDED",
|
|
27193
|
+
FAILED = "FAILED",
|
|
27194
|
+
SCHEDULED = "SCHEDULED",
|
|
27195
|
+
STARTED = "STARTED"
|
|
27196
|
+
}
|
|
27197
|
+
/** Business model of a refund request */
|
|
27198
|
+
interface RefundDetails$2 {
|
|
27199
|
+
/** Order line item IDs and quantities that were refunded. */
|
|
27200
|
+
items?: RefundItem$2[];
|
|
27201
|
+
/** Whether the shipping fee was also refunded. */
|
|
27202
|
+
shippingIncluded?: boolean;
|
|
27203
|
+
/** Reason for the refund, provided by customer (optional). */
|
|
27204
|
+
reason?: string | null;
|
|
27205
|
+
}
|
|
27206
|
+
interface RefundItem$2 {
|
|
27207
|
+
/** Line item ID the refunded line item. */
|
|
27208
|
+
lineItemId?: string;
|
|
27209
|
+
/** Line item quantity refunded. */
|
|
27210
|
+
quantity?: number;
|
|
27211
|
+
}
|
|
26553
27212
|
interface Sorting$8 {
|
|
26554
27213
|
/** Name of the field to sort by. */
|
|
26555
27214
|
fieldName?: string;
|
|
@@ -26630,6 +27289,35 @@ interface BulkActionMetadata$2 {
|
|
|
26630
27289
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
26631
27290
|
undetailedFailures?: number;
|
|
26632
27291
|
}
|
|
27292
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
27293
|
+
/** Wix eCommerce order ID */
|
|
27294
|
+
ecomOrderId: string;
|
|
27295
|
+
/** Payment IDs */
|
|
27296
|
+
paymentIds: string[];
|
|
27297
|
+
}
|
|
27298
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
27299
|
+
/** All order's transactions after the void was triggered */
|
|
27300
|
+
orderTransactions?: OrderTransactions$2;
|
|
27301
|
+
}
|
|
27302
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
27303
|
+
/** Wix eCommerce order ID */
|
|
27304
|
+
ecomOrderId: string;
|
|
27305
|
+
/** Capture payments information */
|
|
27306
|
+
payments: PaymentCapture[];
|
|
27307
|
+
}
|
|
27308
|
+
interface PaymentCapture {
|
|
27309
|
+
/** Payment ID */
|
|
27310
|
+
paymentId?: string | null;
|
|
27311
|
+
/**
|
|
27312
|
+
* Capture amount.
|
|
27313
|
+
* If not provided - full authorized amount will be captured.
|
|
27314
|
+
*/
|
|
27315
|
+
amount?: Price$4;
|
|
27316
|
+
}
|
|
27317
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
27318
|
+
/** All order's transactions after the capture was triggered */
|
|
27319
|
+
orderTransactions?: OrderTransactions$2;
|
|
27320
|
+
}
|
|
26633
27321
|
interface GetOrderRequest {
|
|
26634
27322
|
/** ID of the order to retrieve. */
|
|
26635
27323
|
_id: string;
|
|
@@ -26684,7 +27372,7 @@ interface SearchOrdersResponse {
|
|
|
26684
27372
|
metadata?: CursorPagingMetadata$8;
|
|
26685
27373
|
}
|
|
26686
27374
|
interface CursorPagingMetadata$8 {
|
|
26687
|
-
/** Number of items returned in
|
|
27375
|
+
/** Number of items returned in current page. */
|
|
26688
27376
|
count?: number | null;
|
|
26689
27377
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
26690
27378
|
cursors?: Cursors$8;
|
|
@@ -26755,6 +27443,110 @@ interface GetPaymentCollectabilityStatusResponseNonNullableFields {
|
|
|
26755
27443
|
amount?: PriceNonNullableFields$4;
|
|
26756
27444
|
authorizationSupported: boolean;
|
|
26757
27445
|
}
|
|
27446
|
+
interface AuthorizationActionFailureDetailsNonNullableFields$2 {
|
|
27447
|
+
failureCode: string;
|
|
27448
|
+
}
|
|
27449
|
+
interface AuthorizationCaptureNonNullableFields$2 {
|
|
27450
|
+
status: AuthorizationCaptureStatus$2;
|
|
27451
|
+
amount?: PriceNonNullableFields$4;
|
|
27452
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$2;
|
|
27453
|
+
}
|
|
27454
|
+
interface AuthorizationVoidNonNullableFields$2 {
|
|
27455
|
+
status: AuthorizationVoidStatus$2;
|
|
27456
|
+
failureDetails?: AuthorizationActionFailureDetailsNonNullableFields$2;
|
|
27457
|
+
reason: Reason$2;
|
|
27458
|
+
}
|
|
27459
|
+
interface ScheduledActionNonNullableFields$2 {
|
|
27460
|
+
actionType: ActionType$2;
|
|
27461
|
+
}
|
|
27462
|
+
interface AuthorizationDetailsNonNullableFields$2 {
|
|
27463
|
+
delayedCapture: boolean;
|
|
27464
|
+
captures: AuthorizationCaptureNonNullableFields$2[];
|
|
27465
|
+
void?: AuthorizationVoidNonNullableFields$2;
|
|
27466
|
+
scheduledAction?: ScheduledActionNonNullableFields$2;
|
|
27467
|
+
}
|
|
27468
|
+
interface RegularPaymentDetailsNonNullableFields$2 {
|
|
27469
|
+
offlinePayment: boolean;
|
|
27470
|
+
status: TransactionStatus$2;
|
|
27471
|
+
savedPaymentMethod: boolean;
|
|
27472
|
+
authorizationDetails?: AuthorizationDetailsNonNullableFields$2;
|
|
27473
|
+
}
|
|
27474
|
+
interface GiftCardPaymentDetailsNonNullableFields$2 {
|
|
27475
|
+
giftCardPaymentId: string;
|
|
27476
|
+
giftCardId: string;
|
|
27477
|
+
appId: string;
|
|
27478
|
+
voided: boolean;
|
|
27479
|
+
}
|
|
27480
|
+
interface MembershipNameNonNullableFields$4 {
|
|
27481
|
+
original: string;
|
|
27482
|
+
}
|
|
27483
|
+
interface MembershipPaymentDetailsNonNullableFields$2 {
|
|
27484
|
+
membershipId: string;
|
|
27485
|
+
lineItemId: string;
|
|
27486
|
+
status: MembershipPaymentStatus$2;
|
|
27487
|
+
name?: MembershipNameNonNullableFields$4;
|
|
27488
|
+
voided: boolean;
|
|
27489
|
+
providerAppId: string;
|
|
27490
|
+
}
|
|
27491
|
+
interface PaymentNonNullableFields$2 {
|
|
27492
|
+
regularPaymentDetails?: RegularPaymentDetailsNonNullableFields$2;
|
|
27493
|
+
giftcardPaymentDetails?: GiftCardPaymentDetailsNonNullableFields$2;
|
|
27494
|
+
membershipPaymentDetails?: MembershipPaymentDetailsNonNullableFields$2;
|
|
27495
|
+
amount?: PriceNonNullableFields$4;
|
|
27496
|
+
refundDisabled: boolean;
|
|
27497
|
+
}
|
|
27498
|
+
interface RefundTransactionNonNullableFields$2 {
|
|
27499
|
+
paymentId: string;
|
|
27500
|
+
amount?: PriceNonNullableFields$4;
|
|
27501
|
+
refundStatus: RefundStatus$2;
|
|
27502
|
+
externalRefund: boolean;
|
|
27503
|
+
}
|
|
27504
|
+
interface RefundItemNonNullableFields$2 {
|
|
27505
|
+
lineItemId: string;
|
|
27506
|
+
quantity: number;
|
|
27507
|
+
}
|
|
27508
|
+
interface LineItemRefundNonNullableFields$2 {
|
|
27509
|
+
lineItemId: string;
|
|
27510
|
+
quantity: number;
|
|
27511
|
+
}
|
|
27512
|
+
interface AdditionalFeeRefundNonNullableFields$2 {
|
|
27513
|
+
additionalFeeId: string;
|
|
27514
|
+
amount?: PriceNonNullableFields$4;
|
|
27515
|
+
}
|
|
27516
|
+
interface ShippingRefundNonNullableFields$2 {
|
|
27517
|
+
amount?: PriceNonNullableFields$4;
|
|
27518
|
+
}
|
|
27519
|
+
interface RefundDetailsNonNullableFields$2 {
|
|
27520
|
+
items: RefundItemNonNullableFields$2[];
|
|
27521
|
+
shippingIncluded: boolean;
|
|
27522
|
+
lineItems: LineItemRefundNonNullableFields$2[];
|
|
27523
|
+
additionalFees: AdditionalFeeRefundNonNullableFields$2[];
|
|
27524
|
+
shipping?: ShippingRefundNonNullableFields$2;
|
|
27525
|
+
}
|
|
27526
|
+
interface AggregatedRefundSummaryNonNullableFields$2 {
|
|
27527
|
+
requestedRefund?: PriceNonNullableFields$4;
|
|
27528
|
+
pendingRefund?: PriceNonNullableFields$4;
|
|
27529
|
+
refunded?: PriceNonNullableFields$4;
|
|
27530
|
+
failedRefundAmount?: PriceNonNullableFields$4;
|
|
27531
|
+
pending: boolean;
|
|
27532
|
+
}
|
|
27533
|
+
interface RefundNonNullableFields$2 {
|
|
27534
|
+
_id: string;
|
|
27535
|
+
transactions: RefundTransactionNonNullableFields$2[];
|
|
27536
|
+
details?: RefundDetailsNonNullableFields$2;
|
|
27537
|
+
summary?: AggregatedRefundSummaryNonNullableFields$2;
|
|
27538
|
+
}
|
|
27539
|
+
interface OrderTransactionsNonNullableFields$2 {
|
|
27540
|
+
orderId: string;
|
|
27541
|
+
payments: PaymentNonNullableFields$2[];
|
|
27542
|
+
refunds: RefundNonNullableFields$2[];
|
|
27543
|
+
}
|
|
27544
|
+
interface VoidAuthorizedPaymentsResponseNonNullableFields {
|
|
27545
|
+
orderTransactions?: OrderTransactionsNonNullableFields$2;
|
|
27546
|
+
}
|
|
27547
|
+
interface CaptureAuthorizedPaymentsResponseNonNullableFields {
|
|
27548
|
+
orderTransactions?: OrderTransactionsNonNullableFields$2;
|
|
27549
|
+
}
|
|
26758
27550
|
interface ProductNameNonNullableFields {
|
|
26759
27551
|
original: string;
|
|
26760
27552
|
}
|
|
@@ -27184,6 +27976,12 @@ type __PublicMethodMetaInfo$8<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
27184
27976
|
declare function getPaymentCollectabilityStatus(): __PublicMethodMetaInfo$8<'GET', {
|
|
27185
27977
|
ecomOrderId: string;
|
|
27186
27978
|
}, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusRequest$1, GetPaymentCollectabilityStatusResponse & GetPaymentCollectabilityStatusResponseNonNullableFields, GetPaymentCollectabilityStatusResponse$1 & GetPaymentCollectabilityStatusResponseNonNullableFields$1>;
|
|
27979
|
+
declare function voidAuthorizedPayments(): __PublicMethodMetaInfo$8<'POST', {
|
|
27980
|
+
ecomOrderId: string;
|
|
27981
|
+
}, VoidAuthorizedPaymentsRequest, VoidAuthorizedPaymentsRequest$1, VoidAuthorizedPaymentsResponse & VoidAuthorizedPaymentsResponseNonNullableFields, VoidAuthorizedPaymentsResponse$1 & VoidAuthorizedPaymentsResponseNonNullableFields$1>;
|
|
27982
|
+
declare function captureAuthorizedPayments(): __PublicMethodMetaInfo$8<'POST', {
|
|
27983
|
+
ecomOrderId: string;
|
|
27984
|
+
}, CaptureAuthorizedPaymentsRequest, CaptureAuthorizedPaymentsRequest$1, CaptureAuthorizedPaymentsResponse & CaptureAuthorizedPaymentsResponseNonNullableFields, CaptureAuthorizedPaymentsResponse$1 & CaptureAuthorizedPaymentsResponseNonNullableFields$1>;
|
|
27187
27985
|
declare function getOrder(): __PublicMethodMetaInfo$8<'GET', {
|
|
27188
27986
|
id: string;
|
|
27189
27987
|
}, GetOrderRequest, GetOrderRequest$1, GetOrderResponse & GetOrderResponseNonNullableFields, GetOrderResponse$1 & GetOrderResponseNonNullableFields$1>;
|
|
@@ -27199,13 +27997,15 @@ declare function cancelOrder(): __PublicMethodMetaInfo$8<'POST', {
|
|
|
27199
27997
|
|
|
27200
27998
|
declare const meta$8_bulkUpdateOrders: typeof bulkUpdateOrders;
|
|
27201
27999
|
declare const meta$8_cancelOrder: typeof cancelOrder;
|
|
28000
|
+
declare const meta$8_captureAuthorizedPayments: typeof captureAuthorizedPayments;
|
|
27202
28001
|
declare const meta$8_createOrder: typeof createOrder;
|
|
27203
28002
|
declare const meta$8_getOrder: typeof getOrder;
|
|
27204
28003
|
declare const meta$8_getPaymentCollectabilityStatus: typeof getPaymentCollectabilityStatus;
|
|
27205
28004
|
declare const meta$8_searchOrders: typeof searchOrders;
|
|
27206
28005
|
declare const meta$8_updateOrder: typeof updateOrder;
|
|
28006
|
+
declare const meta$8_voidAuthorizedPayments: typeof voidAuthorizedPayments;
|
|
27207
28007
|
declare namespace meta$8 {
|
|
27208
|
-
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 };
|
|
28008
|
+
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 };
|
|
27209
28009
|
}
|
|
27210
28010
|
|
|
27211
28011
|
interface OrderPaymentRequest$1 {
|
|
@@ -27810,6 +28610,8 @@ interface PaymentPaymentDetailsOneOf$1 {
|
|
|
27810
28610
|
giftcardPaymentDetails?: GiftCardPaymentDetails$1;
|
|
27811
28611
|
}
|
|
27812
28612
|
interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {
|
|
28613
|
+
/** Whether regular card used */
|
|
28614
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$1;
|
|
27813
28615
|
/** Wix Payments order ID. */
|
|
27814
28616
|
paymentOrderId?: string | null;
|
|
27815
28617
|
/**
|
|
@@ -27830,9 +28632,13 @@ interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDeta
|
|
|
27830
28632
|
status?: TransactionStatus$1;
|
|
27831
28633
|
/** Whether there is a payment agreement that allows for future charges. */
|
|
27832
28634
|
savedPaymentMethod?: boolean;
|
|
28635
|
+
/** Authorization details. */
|
|
28636
|
+
authorizationDetails?: AuthorizationDetails$1;
|
|
27833
28637
|
}
|
|
27834
28638
|
/** @oneof */
|
|
27835
28639
|
interface RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {
|
|
28640
|
+
/** Whether regular card used */
|
|
28641
|
+
creditCardDetails?: CreditCardPaymentMethodDetails$1;
|
|
27836
28642
|
}
|
|
27837
28643
|
declare enum TransactionStatus$1 {
|
|
27838
28644
|
UNDEFINED = "UNDEFINED",
|
|
@@ -27846,6 +28652,45 @@ declare enum TransactionStatus$1 {
|
|
|
27846
28652
|
AUTHORIZED = "AUTHORIZED",
|
|
27847
28653
|
VOIDED = "VOIDED"
|
|
27848
28654
|
}
|
|
28655
|
+
interface CreditCardPaymentMethodDetails$1 {
|
|
28656
|
+
/** The last 4 digits of the card number. */
|
|
28657
|
+
lastFourDigits?: string | null;
|
|
28658
|
+
/** Card issuer's brand. */
|
|
28659
|
+
brand?: string | null;
|
|
28660
|
+
}
|
|
28661
|
+
interface AuthorizationDetails$1 {
|
|
28662
|
+
/**
|
|
28663
|
+
* Whether the authorized payment is of a delayed capture.
|
|
28664
|
+
* @readonly
|
|
28665
|
+
*/
|
|
28666
|
+
delayedCapture?: boolean;
|
|
28667
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28668
|
+
authorizedDate?: Date;
|
|
28669
|
+
/**
|
|
28670
|
+
* List of captures associated with payment
|
|
28671
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
28672
|
+
*/
|
|
28673
|
+
captures?: AuthorizationCapture$1[];
|
|
28674
|
+
/** Void associated with payment */
|
|
28675
|
+
void?: AuthorizationVoid$1;
|
|
28676
|
+
/** Scheduled action for this transaction */
|
|
28677
|
+
scheduledAction?: ScheduledAction$1;
|
|
28678
|
+
}
|
|
28679
|
+
interface AuthorizationCapture$1 {
|
|
28680
|
+
/**
|
|
28681
|
+
* Capture ID.
|
|
28682
|
+
* @readonly
|
|
28683
|
+
*/
|
|
28684
|
+
id?: string | null;
|
|
28685
|
+
/** Status of this capture action */
|
|
28686
|
+
status?: AuthorizationCaptureStatus$1;
|
|
28687
|
+
/** Amount of this capture */
|
|
28688
|
+
amount?: Price$1;
|
|
28689
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28690
|
+
createdDate?: Date;
|
|
28691
|
+
/** In case of status is FAILED may contain failure details */
|
|
28692
|
+
failureDetails?: AuthorizationActionFailureDetails$1;
|
|
28693
|
+
}
|
|
27849
28694
|
declare enum AuthorizationCaptureStatus$1 {
|
|
27850
28695
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27851
28696
|
/** Whether capture operation still in progress */
|
|
@@ -27864,6 +28709,19 @@ interface Price$1 {
|
|
|
27864
28709
|
*/
|
|
27865
28710
|
formattedAmount?: string;
|
|
27866
28711
|
}
|
|
28712
|
+
interface AuthorizationActionFailureDetails$1 {
|
|
28713
|
+
failureCode?: string;
|
|
28714
|
+
}
|
|
28715
|
+
interface AuthorizationVoid$1 {
|
|
28716
|
+
/** Status of this void action */
|
|
28717
|
+
status?: AuthorizationVoidStatus$1;
|
|
28718
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
28719
|
+
voidedDate?: Date;
|
|
28720
|
+
/** In case of status is FAILED may contain failure details */
|
|
28721
|
+
failureDetails?: AuthorizationActionFailureDetails$1;
|
|
28722
|
+
/** Reason of void action */
|
|
28723
|
+
reason?: Reason$1;
|
|
28724
|
+
}
|
|
27867
28725
|
declare enum AuthorizationVoidStatus$1 {
|
|
27868
28726
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
27869
28727
|
/** Whether void operation still in progress */
|
|
@@ -27884,6 +28742,12 @@ declare enum Reason$1 {
|
|
|
27884
28742
|
MANUAL = "MANUAL",
|
|
27885
28743
|
SCHEDULED = "SCHEDULED"
|
|
27886
28744
|
}
|
|
28745
|
+
interface ScheduledAction$1 {
|
|
28746
|
+
/** type of the action */
|
|
28747
|
+
actionType?: ActionType$1;
|
|
28748
|
+
/** the date and time of the action */
|
|
28749
|
+
executionDate?: Date;
|
|
28750
|
+
}
|
|
27887
28751
|
declare enum ActionType$1 {
|
|
27888
28752
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
27889
28753
|
VOID = "VOID",
|
|
@@ -28241,6 +29105,8 @@ interface PaymentPaymentDetailsOneOf {
|
|
|
28241
29105
|
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
28242
29106
|
}
|
|
28243
29107
|
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
29108
|
+
/** Whether regular card used */
|
|
29109
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
28244
29110
|
/** Wix Payments order ID. */
|
|
28245
29111
|
paymentOrderId?: string | null;
|
|
28246
29112
|
/**
|
|
@@ -28261,9 +29127,13 @@ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetail
|
|
|
28261
29127
|
status?: TransactionStatus;
|
|
28262
29128
|
/** Whether there is a payment agreement that allows for future charges. */
|
|
28263
29129
|
savedPaymentMethod?: boolean;
|
|
29130
|
+
/** Authorization details. */
|
|
29131
|
+
authorizationDetails?: AuthorizationDetails;
|
|
28264
29132
|
}
|
|
28265
29133
|
/** @oneof */
|
|
28266
29134
|
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
29135
|
+
/** Whether regular card used */
|
|
29136
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
28267
29137
|
}
|
|
28268
29138
|
declare enum TransactionStatus {
|
|
28269
29139
|
UNDEFINED = "UNDEFINED",
|
|
@@ -28277,6 +29147,45 @@ declare enum TransactionStatus {
|
|
|
28277
29147
|
AUTHORIZED = "AUTHORIZED",
|
|
28278
29148
|
VOIDED = "VOIDED"
|
|
28279
29149
|
}
|
|
29150
|
+
interface CreditCardPaymentMethodDetails {
|
|
29151
|
+
/** The last 4 digits of the card number. */
|
|
29152
|
+
lastFourDigits?: string | null;
|
|
29153
|
+
/** Card issuer's brand. */
|
|
29154
|
+
brand?: string | null;
|
|
29155
|
+
}
|
|
29156
|
+
interface AuthorizationDetails {
|
|
29157
|
+
/**
|
|
29158
|
+
* Whether the authorized payment is of a delayed capture.
|
|
29159
|
+
* @readonly
|
|
29160
|
+
*/
|
|
29161
|
+
delayedCapture?: boolean;
|
|
29162
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29163
|
+
authorizedDate?: Date;
|
|
29164
|
+
/**
|
|
29165
|
+
* List of captures associated with payment
|
|
29166
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
29167
|
+
*/
|
|
29168
|
+
captures?: AuthorizationCapture[];
|
|
29169
|
+
/** Void associated with payment */
|
|
29170
|
+
void?: AuthorizationVoid;
|
|
29171
|
+
/** Scheduled action for this transaction */
|
|
29172
|
+
scheduledAction?: ScheduledAction;
|
|
29173
|
+
}
|
|
29174
|
+
interface AuthorizationCapture {
|
|
29175
|
+
/**
|
|
29176
|
+
* Capture ID.
|
|
29177
|
+
* @readonly
|
|
29178
|
+
*/
|
|
29179
|
+
_id?: string | null;
|
|
29180
|
+
/** Status of this capture action */
|
|
29181
|
+
status?: AuthorizationCaptureStatus;
|
|
29182
|
+
/** Amount of this capture */
|
|
29183
|
+
amount?: Price;
|
|
29184
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29185
|
+
_createdDate?: Date;
|
|
29186
|
+
/** In case of status is FAILED may contain failure details */
|
|
29187
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
29188
|
+
}
|
|
28280
29189
|
declare enum AuthorizationCaptureStatus {
|
|
28281
29190
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
28282
29191
|
/** Whether capture operation still in progress */
|
|
@@ -28295,6 +29204,19 @@ interface Price {
|
|
|
28295
29204
|
*/
|
|
28296
29205
|
formattedAmount?: string;
|
|
28297
29206
|
}
|
|
29207
|
+
interface AuthorizationActionFailureDetails {
|
|
29208
|
+
failureCode?: string;
|
|
29209
|
+
}
|
|
29210
|
+
interface AuthorizationVoid {
|
|
29211
|
+
/** Status of this void action */
|
|
29212
|
+
status?: AuthorizationVoidStatus;
|
|
29213
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
29214
|
+
voidedDate?: Date;
|
|
29215
|
+
/** In case of status is FAILED may contain failure details */
|
|
29216
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
29217
|
+
/** Reason of void action */
|
|
29218
|
+
reason?: Reason;
|
|
29219
|
+
}
|
|
28298
29220
|
declare enum AuthorizationVoidStatus {
|
|
28299
29221
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
28300
29222
|
/** Whether void operation still in progress */
|
|
@@ -28315,6 +29237,12 @@ declare enum Reason {
|
|
|
28315
29237
|
MANUAL = "MANUAL",
|
|
28316
29238
|
SCHEDULED = "SCHEDULED"
|
|
28317
29239
|
}
|
|
29240
|
+
interface ScheduledAction {
|
|
29241
|
+
/** type of the action */
|
|
29242
|
+
actionType?: ActionType;
|
|
29243
|
+
/** the date and time of the action */
|
|
29244
|
+
executionDate?: Date;
|
|
29245
|
+
}
|
|
28318
29246
|
declare enum ActionType {
|
|
28319
29247
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
28320
29248
|
VOID = "VOID",
|