@wix/bex-utils 1.28.0

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

@@ -0,0 +1,158 @@
+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/order-item.proto";
+import "wix/api/entity.proto";
+import "wix/api/annotations.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PayPalPaymentMethodService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.Charge";
+
+    // Start PayPal checkout for express integration
+    rpc CreateCheckout(CreateCheckoutRequest) returns (CheckoutResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/accounts/{account_id}/paypal-checkout"
+        };
+    }
+
+    // Update PayPal checkout for express integration
+    rpc UpdateCheckout(UpdateCheckoutRequest) returns (CheckoutResponse) {
+        option (google.api.http) = {
+            put: "/api/payments/v2/accounts/{account_id}/paypal-checkout/{order_id}"
+        };
+    }
+
+    // Get shipping details from PayPal
+    rpc GetPaymentDetails(GetPaymentDetailsRequest) returns (PaymentDetailsResponse) {
+        option (google.api.http) = {
+            get: "/api/payments/v2/accounts/{account_id}/paypal-checkout/{order_id}/payment-details"
+        };
+    }
+}
+
+message AmountBreakdown {
+
+    google.protobuf.DoubleValue items_total = 1;
+
+    google.protobuf.DoubleValue shipping = 2;
+
+    google.protobuf.DoubleValue tax = 3;
+
+    google.protobuf.DoubleValue discount = 4;
+}
+
+message ShippingOption {
+
+    string name = 1;
+
+    double amount = 2;
+}
+
+message CreateCheckoutRequest {
+    // Account id for which checkout should be started
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id = 1;
+
+    // amount currency, 3-letter
+    string currency = 2;
+
+    // total amount
+    double total_amount = 3;
+
+    // amount breakdown
+    AmountBreakdown amount_breakdown = 4;
+
+    // request shipping, default false
+    bool request_shipping = 5;
+
+    // purchase items
+    repeated OrderItem order_items = 6;
+}
+
+message UpdateCheckoutRequest {
+    // Account id for which checkout should be started
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id = 1;
+
+    // PayPal token
+    string order_id = 2;
+
+    // amount currency, 3-letter
+    string currency = 3;
+
+    // total amount
+    double total_amount = 4;
+
+    // amount breakdown
+    AmountBreakdown amount_breakdown = 5;
+
+    // request shipping, default false
+    bool request_shipping = 6;
+
+    // shipping options
+    repeated ShippingOption shipping_options = 7;
+}
+
+message CheckoutResponse {
+    // PayPal token
+    string order_id = 1;
+}
+
+message GetPaymentDetailsRequest {
+    // Account id for which checkout should be started
+    //
+    // For Wix TPAs account_id is pair of `appId:instanceId`.
+    string account_id = 1;
+
+    // PayPal token
+    string order_id = 2;
+}
+
+message PaymentDetailsResponse {
+
+    PayPalBillingAddress billing_address = 1;
+
+    PayPalShippingAddress shipping_address = 2;
+}
+
+message PayPalBillingAddress {
+
+    string country_code = 1;
+
+    string first_name = 2[(.wix.api.pii) = true];
+
+    string last_name = 3[(.wix.api.pii) = true];
+
+    string email = 4[(.wix.api.pii) = true];
+
+    string phone = 5[(.wix.api.pii) = true];
+
+    string state = 6;
+}
+
+message PayPalShippingAddress {
+    // 2 letter country code
+    string country_code = 1;
+
+    string state = 2;
+
+    string city = 3;
+
+    string address_line1 = 4[(.wix.api.pii) = true];
+
+    string address_line2 = 5[(.wix.api.pii) = true];
+
+    string postal_code = 6[(.wix.api.pii) = true];
+
+    string full_name = 7[(.wix.api.pii) = true];
+
+    string phone = 8[(.wix.api.pii) = true];
+}

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

@@ -0,0 +1,38 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.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/orders.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PayPalRecurringOrderService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.Order";
+
+    rpc Create(CreatePayPalRecurringOrderRequest) returns (CreateOrderResponse) {
+        option (wix.api.required) = "CreatePayPalRecurringOrderRequest.account_id";
+        option (wix.api.required) = "CreatePayPalRecurringOrderRequest.description";
+        option (wix.api.required) = "CreatePayPalRecurringOrderRequest.urls";
+        option (wix.api.required) = "CreatePayPalRecurringOrderRequest.paypal_recurring_profile_id";
+        option (google.api.http) = {
+            post: "/api/payments/v2/paypal-recurring-orders"
+        };
+    }
+}
+
+message CreatePayPalRecurringOrderRequest {
+    string account_id                    = 1;
+    OrderDescription description         = 2;
+    OrderUrls urls                       = 3;
+    string paypal_recurring_profile_id   = 4;
+    google.protobuf.Timestamp created_at = 5;
+    google.protobuf.StringValue order_id = 6;
+}

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

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/api/annotations.proto";
+import "wix/payment/api/pay/v2/resources/pos-transaction.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PosTransactionService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.PosTransaction";
+
+    // creates transaction from PoS terminal
+    rpc Create(CreatePosTransactionRequest) returns (CreatePosTransactionResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/charges/{charge_id}/pos"
+        };
+    };
+}
+
+message CreatePosTransactionRequest {
+    // charge id which was payed through PoS terminal
+    string charge_id             = 1;
+
+    // transaction details
+    PosTransaction transaction  = 2;
+}
+
+message CreatePosTransactionResponse {
+    // id of created transaction
+    string transaction_id   = 1;
+}

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

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+import "wix/api/entity.proto";
+
+// Cashier Account Information
+message Account {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v2.account"
+        segment: PUBLIC // no domain events produced
+    };
+
+    // buyer country (guessed by his/her IP address)
+    string buyerCountryByIp    = 2;
+
+    // merchant site URL
+    string siteUrl             = 3;
+}

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

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/api/annotations.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Describing physical or business location
+message Address {
+    // first name
+    string first_name             = 1[(.wix.api.pii) = true];
+    // last name
+    string last_name              = 2[(.wix.api.pii) = true];
+    // company name
+    string company                = 3[(.wix.api.pii) = true];
+
+    // address string (must not exceed 100 characters)
+    string address                = 4[(.wix.api.pii) = true];
+    // detailed address (optional)
+    AddressDetails addressDetails = 5;
+    string city                   = 6;
+    string state                  = 7;
+    // ZIP code
+    string zipCode                = 8[(.wix.api.pii) = true];
+    // three-letters country code (ISO 3166-1 alpha-3)
+    string countryCode            = 9;
+
+    // phone number (must not exceed 100 characters)
+    string phone                  = 10[(.wix.api.pii) = true];
+    // fax number (must not exceed 100 characters)
+    string fax                    = 11[(.wix.api.pii) = true];
+    // email (must not exceed 100 characters)
+    string email                  = 12[(.wix.api.pii) = true];
+    // user id number (optional)
+    TaxIdentifier taxIdentifier   = 13;
+
+    // address details (like street and house number)
+    message AddressDetails {
+        // street
+        string street      = 1[(.wix.api.pii) = true];
+        // house number
+        string houseNumber = 2[(.wix.api.pii) = true];
+    }
+
+    // tax identifier
+    message TaxIdentifier {
+        // identification number, for example: 111-2222-333 (must not exceed 100 characters)
+        string id   = 1;
+        // id number type, required if more than 1 type is available in country
+        //
+        // examples: `CPF`, `CNPJ`
+        //
+        // must not exceed 100 characters
+        string type = 2;
+    }
+}

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

@@ -0,0 +1,220 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/payment/api/pay/v2/resources/transaction.proto";
+import "wix/payment/api/pay/v2/resources/order.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// describing a charge (ids, state and intent)
+message Charge {
+
+    option (wix.api.entity) = {
+      fqdn: "wix.cashier.pay.v2.charge"
+      segment: PUBLIC // no domain events produced
+    };
+
+    // charge ID
+    string charge_id                    = 1;
+
+    // ID of transaction related to this charge
+    string transaction_id               = 2;
+
+    ChargeIntent intent                 = 3;
+
+    // order ID
+    string order_id                     = 4;
+
+    // state of the charge
+    ChargeState state                   = 6;
+
+    // deprecated, use payment_method_display_name
+    string payment_method               = 10 [deprecated = true];
+
+    // transaction payment method (internal original value)
+    string payment_method_id            = 11;
+
+    // transaction payment method display name (depends on payment provider)
+    string payment_method_display_name  = 12;
+
+    double amount                       = 13;
+
+    string currency                     = 14 [(wix.api.format) = CURRENCY];
+
+    // What kind of payment the buyer wants to perform: A one-time payment, a recurring payment, or an authorize
+    // payment - authorize is when the provider reserves the funds from the user’s credit card, but doesn’t actually
+    // charge them. This is usually done for ‘booking’ style flows, where the hotel reserves the booking amount but only
+    // charges it when the guest arrives. Authorize flow is not fully supported by Cashier yet, work in progress.
+    enum ChargeIntent {
+        UNDEFINED       = 0;
+        SALE            = 1;
+        RECURRING       = 3;
+    }
+}
+
+// Describing any additional changes to the charge entity before executing it
+message ChargeExecution {
+    // override order additional charges during charge execution (optional)
+    OrderAdditionalCharges  additional_charges = 1;
+
+    // override order amount during charge execution (optional)
+    double amount = 2;
+}
+
+// state of the charge
+message ChargeState {
+
+    // current status of a transaction associated with charge
+    TransactionStatus transaction_status  = 1;
+
+    // in case transaction status is Declined/Failure may contain failure details (alpha)
+    TransactionFailureDetails failure_details = 2;
+
+    // contains specific provider data
+    map<string, string> provider_data     = 3;
+
+    // URL of page where user should be redirected as next step of payment flow.
+    //
+    // It might be URL to external payment system (PayPal etc) in case transaction status is `IN_PROCESS` or
+    // `INITIALIZATION` or order return URL in case status is `APPROVED`/`PENDING`/`DECLINED`/`FAILED`/`CANCELED`
+    string user_redirect_url               = 10;
+
+    // external payment system url where user should be redirected to continue payment, can be in status `IN_PROCESS` or
+    // `INITIALIZATION`
+    string provider_redirect_url           = 11;
+
+    // the action to perform if any
+    oneof next_action {
+
+        // A browser should issue an HTTP GET request and render the result.
+        GetMethodRedirect get_method_redirect         = 121;
+
+        // A browser should issue an HTTP POST request and render the result.
+        PostMethodRedirect post_method_redirect       = 122;
+
+        // A browser should display a barcode / barcode url to continue payment
+        BarcodeDisplay barcode_display                = 123;
+
+        // A client should interact with card reader
+        CardReaderInteraction card_reader_interaction = 124;
+
+        // A browser should show a QR code to continue payment.
+        QrCodeDisplay qr_code_display                 = 125;
+
+        // A browser should display an iframe with web page.
+        // Redirect shouldn't be performed as it's designed to be embedded into checkout page.
+        WebPageDisplay web_page_display               = 126;
+    }
+}
+
+// used by Payments Widget (decoding from Base64 token in ChargeResponse)
+message ChargeResponseToken {
+    string charge_id                            = 1;
+
+    TransactionStatus.Status transaction_status = 2;
+
+    google.protobuf.StringValue failure_code    = 3;
+
+    google.protobuf.StringValue redirect_url    = 4;
+
+    double amount                               = 5;
+
+    string currency                             = 6 [(wix.api.format) = CURRENCY];
+
+    string payment_method                       = 7;
+
+    // the action to perform if any
+    oneof next_action {
+
+        // A browser should issue an HTTP GET request and render the result.
+        GetMethodRedirect get_method_redirect         = 101;
+
+        // A browser should issue an HTTP POST request and render the result.
+        PostMethodRedirect post_method_redirect       = 102;
+
+        // A browser should display a barcode / barcode url to continue payment
+        BarcodeDisplay barcode_display                = 103;
+
+        // A client should interact with card reader
+        CardReaderInteraction card_reader_interaction = 104;
+
+        // A browser should show a QR code to continue payment.
+        QrCodeDisplay qr_code_display                 = 105;
+
+        // A browser should display an iframe with web page.
+        // Redirect shouldn't be performed as it's designed to be embedded into checkout page.
+        WebPageDisplay web_page_display               = 106;
+    }
+}
+
+message GetMethodRedirect {
+
+    // a properly encoded URL to perform an HTTP GET request
+    string url = 1 [(wix.api.format) = URI];
+}
+
+message PostMethodRedirect {
+
+    message FormField {
+
+        // the field name (not encoded)
+        string name = 1 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+
+        // the field value (not encoded)
+        string value = 2 /* [(wix.api.maxLength) = ?]*/;
+    }
+
+    // a properly encoded URL to perform an HTTP POST request
+    string url = 1 [(wix.api.format) = URI];
+
+    // not yet encoded form fields to send with the POST request using the application/x-www-form-urlencoded content type
+    repeated FormField fields = 2;
+}
+
+message BarcodeDisplay {
+
+    // barcode value in decimal digits
+    google.protobuf.StringValue barcode         = 1;
+
+    // url to view / download barcode document
+    google.protobuf.StringValue barcode_url     = 2;
+
+    // date until barcode / barcode url are valid
+    google.protobuf.Timestamp expiration_date   = 3;
+
+    // address to send email with barcode payment details
+    google.protobuf.StringValue billing_email   = 4 [(wix.api.format) = EMAIL, (.wix.api.pii) = true];
+}
+
+message QrCodeDisplay {
+
+    /*
+    QR code raw text payload.
+    You can use any QR code generator library to convert it to an image.
+    To see more details read [this article](https://www.thonky.com/qr-code-tutorial/introduction).
+    */
+    google.protobuf.StringValue payload = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 1000];
+
+    // Expiration timestamp.
+    google.protobuf.Timestamp expiration_date = 2;
+}
+
+message WebPageDisplay {
+
+    // a properly encoded URL to perform an HTTP GET request
+    string url = 1 [(wix.api.format) = URI];
+
+    // date until charge should be completed
+    google.protobuf.Timestamp expiration_date = 2;
+}
+
+message CardReaderInteraction {
+    // token for interaction with card reader
+    google.protobuf.StringValue reader_token = 1;
+}

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

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+import "wix/api/entity.proto";
+
+message MandatoryField {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v2.mandatory_field"
+        segment: PUBLIC // no domain events produced
+    };
+
+    // enumeration with all possible domains
+    enum Domain {
+        UNDEFINED               = 0;
+        ORDER                   = 1;
+        CREDIT_CARD             = 2;
+        SAVED_CREDIT_CARD       = 3;
+        PAYMENT_METHOD          = 4;
+    }
+
+    // domain to which the field belongs
+    Domain domain                       = 1;
+
+    // field name
+    string field_name                   = 2;
+
+    // MF available values
+    repeated MandatoryFieldValue values = 6;
+}
+
+message MandatoryFieldValue {
+    // MF value
+    string id   = 1;
+
+    // MF value display name
+    string name = 2;
+
+    // Mandatory field icon url
+    string icon_url = 3;
+}

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

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+import "google/protobuf/wrappers.proto";
+
+// Describing any additional charges in the order. They are not required, but can't be provided later.  
+message OrderAdditionalCharges {
+  // Absolute taxes amount which are included in the order. Only positive values.
+  double tax                                  = 1;
+  // Shipping amount which is included in the order. Only positive values.
+  double shipping                             = 2;
+  // Discount amount which is included in the order. Only positive values.
+  double discount                             = 4;
+  // Application specific fee, positive value, optional (if application_fee == 0, don't include it to request). Only positive values.
+  google.protobuf.DoubleValue application_fee = 6;
+}

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

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Describing additional info about the buyer like id and language. These data are optional and can be provided later on
+// using [UpdateBuyerInfo][1] method.
+//
+//  [1]: .wix.payment.api.pay.v2.-order-service.-update-buyer-info
+message OrderBuyerInfo {
+  // Buyer id in the third party system to identify order owner.
+  string buyer_id                         = 1;
+  // Language which cashier should try to use for the user - ISO 639-1 two-letter or ISO 639-2 three-letter code.
+  string buyer_language                   = 2;
+  // id of Contact associated with Buyer
+  google.protobuf.StringValue contact_id  = 3;
+}
+
+message BuyerLocale {
+  // Language which cashier should try to use for the user - ISO 639-1 two-letter or ISO 639-2 three-letter code.
+  string buyer_language                   = 2;
+}