@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payment-methods.proto

@@ -0,0 +1,260 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/payment/api/pay/v2/resources/payment-method.proto";
+import "wix/payment/api/pay/v2/resources/charge.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PaymentMethodService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.PaymentMethod";
+
+    // Returns all available payment methods for a specified account or order.
+    //
+    // **Auth rules**
+    //
+    // Requires person or server identity to be present.
+    //
+    // Server identity has permissions to view payment methods without any
+    // additional rules.
+    //
+    // Person identity has permissions to view payment methods without any
+    // additional rules.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity and a server identity are both missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc List(ListPaymentMethodsRequest) returns (ListPaymentMethodsResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/payment-methods"
+            additional_bindings {
+                get: "/api/payments/v2/orders/{order_id}/payment-methods"
+            }
+            additional_bindings {
+                get: "/api/payments/v2/payment-methods"
+            }
+        };
+    };
+
+    // Returns a specific payment method for a specified account or order. The
+    // payment method includes details on what is supported by this payment
+    // method, as well as which payment provider is connected to it, and what
+    // mandatory fields it requires.
+    //
+    // **Auth rules**
+    //
+    // Requires person or server identity to be present.
+    //
+    // Server identity has permissions to view the order without any additional
+    // rules.
+    //
+    // Person identity has permissions to view payment methods without any
+    // additional rules.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity and a server identity are both missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc Get(GetPaymentMethodRequest) returns (GetPaymentMethodResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/payment-methods/{payment_method}"
+            additional_bindings {
+                get: "/api/payments/v2/orders/{order_id}/payment-methods/{payment_method}"
+            }
+        };
+    };
+
+    rpc ListExpressPaymentMethods (ListExpressPaymentMethodsRequest) returns (ListExpressPaymentMethodsResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/express-payment-methods"
+        };
+    };
+
+    // returns available payment methods with BNPL
+    rpc ListBuyNowPayLaterMethods(ListBuyNowPayLaterMethodsRequest) returns (ListBuyNowPayLaterMethodsResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/bnpl/payment-methods"
+        };
+    };
+
+    // returns single available payment method with BNPL by id
+    rpc GetBuyNowPayLaterMethod(GetBuyNowPayLaterMethodRequest) returns (GetBuyNowPayLaterMethodResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/bnpl/payment-methods/{payment_method}"
+        };
+    };
+
+    // Get SavedPaymentMethodDetails by agreementId
+    rpc GetSavedPaymentMethodDetailsByAgreementId(GetSavedPaymentMethodDetailsByAgreementIdRequest) returns (GetSavedPaymentMethodDetailsByAgreementIdResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/payment-agreements/{payment_agreement_id}/payment-method"
+        };
+    }
+}
+
+message ListPaymentMethodsRequest {
+    // Account id for which available payment methods are requested.
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id                               = 1;
+
+    // order id for which available payment methods are requested
+    string order_id                                 = 2;
+
+    // three-letters country code (ISO 3166-1 alpha-3) for which settings are returned (optional)
+    string country                                  = 3;
+
+    // amount of payment
+    google.protobuf.StringValue amount              = 4;
+
+    // three-letters locale code for which settings are returned (optional)
+    google.protobuf.StringValue locale              = 5  [(wix.api.format) = LANGUAGE];
+
+    Charge.ChargeIntent charge_intent               = 6;
+
+    // force Offline payment method is enabled / disabled
+    google.protobuf.BoolValue allow_manual_payment  = 7;
+
+    // filter methods which support merchant initiated transactions (optional)
+    bool merchant_initiated                         = 8;
+
+    // return saved methods
+    bool return_saved_methods                       = 9;
+
+    // return Payment Agreement (if exists) for Saved Method
+    bool return_payment_agreement                   = 10;
+
+    // filter methods that only supporting delayed capture (optional)
+    bool enforce_delayed_capture                    = 11;
+
+    // indicate that payment method is allowed to save for MIT
+    bool allow_save_for_mit                         = 12;
+
+    // buyer's contactId
+    // it's required to display saved payment methods that are allowed for MIT in case contact is a site member
+    google.protobuf.StringValue buyer_contact_id    = 13;
+}
+
+message ListPaymentMethodsResponse {
+    // available payment methods
+    repeated PaymentMethod payment_methods = 1;
+}
+
+message GetPaymentMethodRequest {
+    // Account id for which payment method is requested.
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id                   = 1;
+
+    // order id for which payment method is requested
+    string order_id                     = 2;
+
+    // requested payment method
+    string payment_method               = 3;
+
+    // three-letters country code (ISO 3166-1 alpha-3) for which settings are returned (optional)
+    string country                      = 4;
+
+    // amount of payment
+    google.protobuf.StringValue amount  = 5;
+
+    // three-letters locale code for which settings are returned (optional)
+    google.protobuf.StringValue locale  = 6[(wix.api.format) = LANGUAGE];
+
+    Charge.ChargeIntent charge_intent   = 7;
+}
+
+message GetPaymentMethodResponse {
+    // requested payment method
+    PaymentMethod payment_method = 1;
+}
+
+message ListExpressPaymentMethodsRequest {
+    // Account id for which available payment methods are requested.
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id                  = 1;
+}
+
+message ListExpressPaymentMethodsResponse {
+    repeated ExpressPaymentMethod payment_methods = 1;
+}
+
+message ListBuyNowPayLaterMethodsRequest {
+    // Account id for which payment method is requested.
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id   = 1;
+
+    // amount of payment
+    string amount       = 2;
+
+    // locale language
+    string language     = 3[(wix.api.format) = LANGUAGE];
+
+    // currency of payment
+    string currency     = 4[(wix.api.format) = CURRENCY];
+}
+
+message ListBuyNowPayLaterMethodsResponse {
+    repeated BuyNowPayLaterMethod payment_methods = 1;
+}
+
+message GetBuyNowPayLaterMethodRequest {
+    // Account id for which payment method is requested.
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id       = 1;
+
+    // amount of payment
+    string amount           = 2;
+
+    // locale language
+    string language         = 3[(wix.api.format) = LANGUAGE];
+
+    // requested payment method
+    string payment_method   = 4;
+
+    // currency of payment
+    string currency         = 5[(wix.api.format) = CURRENCY];
+}
+
+message GetBuyNowPayLaterMethodResponse {
+    BuyNowPayLaterMethod payment_method = 1;
+}
+
+message GetExternalRecurringAvailabilityRequest {}
+
+message GetExternalRecurringAvailabilityResponse {
+    // credit card available
+    bool available = 1 [deprecated = true];
+
+    // payPal available
+    google.protobuf.BoolValue payPal_available = 2;
+}
+
+message GetSavedPaymentMethodDetailsByAgreementIdRequest {
+    string payment_agreement_id = 1;
+}
+
+message GetSavedPaymentMethodDetailsByAgreementIdResponse {
+    SavedPaymentMethodDetails saved_payment_method_details = 1;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payments.proto

@@ -0,0 +1,334 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/api/entity.proto";
+import "wix/api/api_errors.proto";
+import "wix/payment/api/pay/v2/resources/address.proto";
+import "wix/payment/api/pay/v2/resources/order.proto";
+import "wix/payment/api/pay/v2/resources/charge.proto";
+import "wix/payment/api/pay/v2/resources/payment.proto";
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/permissions.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PaymentService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.Charge";
+
+    // Charge for a predefined [order][1].
+    //
+    // If charge requires interaction with buyer returns`{'type':
+    // 'IN_PROGRESS'}` and `redirectUrl`, or `{'type' : 'DONE'}` if charge is
+    // finished immediately.
+    //
+    // It is also possible to only initialize the charge, and [execute it later][2].
+    //
+    // **Important**. You can charge for the order second time if and only if
+    // the charge has failed (e. g. user has insufficient money on his account).
+    // Otherwise you'll get status code 500 on the attempt to charge the order
+    // again. Also note that when buyer cancels the payment flow it is not
+    // considered as failed and you can not charge again.
+    //
+    // You can read more about Order statuses in [Order Overview][3].
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to charge for order iff it was used to
+    // create the order.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][4].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../order
+    //   [2]: .wix.payment.api.pay.v2.-payment-service.-execute
+    //   [3]: ../../guides/Order%20overview
+    //   [4]: ../../guides/Authentication%20and%20authorization
+    rpc ChargeForOrder(ChargeForOrderRequest) returns (ChargeResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/orders/{order_id}/charges"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "PAYMENT_AGREEMENT_CARD_EXPIRED"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "PAYMENT_AGREEMENT_CARD_NOT_FOUND"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "CHARGE_ALREADY_APPROVED"
+            data: "wix.payment.api.pay.v2.ChargeAlreadyApprovedErrorData"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "CHARGE_ALREADY_IN_PROCESS"
+        };
+    };
+
+    // Get charges by `orderId`. Charges are sorted by creation date.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to get the list of charges for the order
+    // iff it was used to create the order.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc List(ListChargesRequest) returns (ListChargesResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/orders/{order_id}/charges"
+        };
+    };
+
+    // **Only Server to server calls are allowed.**
+    //
+    // Create a new [order][1] and charge for it.
+    //
+    // If charge requires interaction with buyer returns`{'type': 'IN_PROGRESS'}` and `redirectUrl`, or `{'type' :
+    // 'DONE'}` if charge is finished immediately.
+    //
+    // It is also possible to only initialize the charge, and [execute it later][2].
+    //
+    // **Important**. You can charge for the order second time if and only if the charge has failed (e. g. user has
+    // insufficient money on his account). Otherwise you'll get status code 500 on the attempt to charge the order
+    // again. Also note that when buyer cancels the payment flow it is not considered as failed and you can not charge
+    // again.
+    //
+    // You can read more about Order statuses in [Order Overview][3].
+    //
+    // **Idempotency key**. You can specify idempotency key to prevent double payments.
+    // Only one order will be created for specific idempotency key.
+    // You can retry charge request.
+    // If the previous transaction is already approved then error 'charge_already_approved' with actual
+    // 'vertical_order_id' and 'transaction_id' in details will be returned.
+    // If previous transaction was declined then order will be overwritten and new charge initiated.
+    // If two or more charge requests come with the same idempotency keys that only one will be performed,
+    // for others 'charge_already_in_process' error will be thrown.
+    // If buyer action required (such as wallet payment or 3ds) then order will be returned to 'INITIALIZED' status
+    // and other charges will be possible with the same idempotency key.
+    //
+    // **Auth rules**
+    //
+    // Requires person and server identities to be present.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][4].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity or server identity is missing.
+    //
+    //   [1]: ../order
+    //   [2]: .wix.payment.api.pay.v2.-payment-service.-execute
+    //   [3]: ../../guides/Order%20overview
+    //   [4]: ../../guides/Authentication%20and%20authorization
+    rpc Charge(ChargeRequest) returns (ChargeResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/accounts/{account_id}/charges"
+        };
+    };
+
+  // Captures a transaction that was authorized.
+  //
+  // **Auth rules**
+  //
+  // Requires person and server identities to be present.
+  //
+  // You can find more information about Auth & capture in a separate [guide][1].
+  //
+  // **Error responses**
+  //
+  // - 401 - person identity or server identity is missing.
+    rpc Capture(CaptureRequest) returns (CaptureResponse) {
+        option (google.api.http).post = "/api/payments/v2/charges/{charge_id}/capture";
+        option (.wix.api.permission).name = "PAYMENTS.CHARGE_CAPTURE";
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "UNAUTHORIZED_TRANSACTION"
+            data: "wix.payment.api.pay.v2.UnauthorizedTransactionErrorData"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "ZERO_AMOUNT_TRANSACTION"
+            data: "wix.payment.api.pay.v2.ZeroAmountTransactionErrorData"
+        };
+    }
+
+    // Void a transaction that was authorized.
+    //
+    // **Auth rules**
+    //
+    // Requires person and server identities to be present.
+    //
+    // You can find more information about Auth & capture in a separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity or server identity is missing.
+    rpc Void(VoidRequest) returns (VoidResponse) {
+        option (google.api.http).post = "/api/payments/v2/charges/{charge_id}/void";
+        option (.wix.api.permission).name = "PAYMENTS.CHARGE_VOID";
+    }
+
+    // Get charge by `chargeId`.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc Get(GetChargeRequest) returns (GetChargeResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/charges/{charge_id}"
+        };
+    };
+
+    // Updates info about given charge
+    // Given charge_id and new fulfillment_date set the fulfillment_date of order
+    rpc UpdateChargeInfo(UpdateChargeInfoRequest) returns (UpdateChargeInfoResponce) {
+        option (google.api.http) = { post: "/api/payments/v2/charges/{charge_id}"};
+    }
+}
+
+message ChargeAlreadyApprovedErrorData {
+    string transaction_id = 1;
+    string vertical_order_id = 2;
+}
+
+message UnauthorizedTransactionErrorData {
+    string transaction_id = 1;
+    string vertical_order_id = 2;
+}
+
+message ZeroAmountTransactionErrorData {
+    string transaction_id = 1;
+    string vertical_order_id = 2;
+}
+
+message UpdateChargeInfoRequest{
+    string charge_id = 1;
+    google.protobuf.Timestamp fulfillment_date = 2;
+}
+
+message UpdateChargeInfoResponce{}
+
+message ChargeRequest {
+    // Unique identifier of account for which charge is requested.
+    //
+    // Logical owner of an order. For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id              = 1;
+
+    // payment description (required)
+    Payment payment                = 2;
+
+    // order details for charge (required)
+    OrderDescription description   = 3;
+
+    // third party system urls which should be used and callback/event_hook (required)
+    OrderUrls urls                 = 4;
+
+    // for an idempotency key only one charge will be performed or error returned if approved/pending transactions already exist
+    string idempotency_key         = 7;
+}
+
+message ChargeForOrderRequest {
+    // unique identifier of order for which charge is requested
+    string order_id   = 1;
+    // payment description (required)
+    Payment payment   = 2;
+
+    // billing address providing fields missing from the order (optional)
+    Address billing_address        = 7;
+}
+
+message ChargeResponse {
+    // created charge resource
+    Charge charge           = 1;
+
+    // ChargeResponse token, required by Payments client widget
+    string response_token   = 2;
+}
+
+message CaptureRequest {
+    // Charge ID.
+    string charge_id = 1 [(wix.api.format) = GUID];
+}
+
+message CaptureResponse {
+    // Captured transaction.
+    Charge charge = 1;
+}
+
+message VoidRequest {
+    // Charge ID.
+    string charge_id = 1 [(wix.api.format) = GUID];
+}
+
+message VoidResponse {
+    // Void transaction.
+    Charge charge = 1;
+}
+
+message ListChargesRequest {
+    // order identifier
+    string order_id = 1;
+
+    // offset for query, 0 by default
+    int32 offset = 5;
+
+    // limit for query, 20 by default
+    int32 limit = 6;
+}
+
+message ListChargesResponse {
+    // charges list
+    repeated Charge charges = 1;
+
+    // total results
+    int32 total = 5;
+}
+
+message GetChargeRequest {
+    // identifier of charge
+    string charge_id = 1;
+}
+
+message GetChargeResponse {
+    // charge resource
+    Charge charge   = 1;
+}