@wix/bex-utils 1.28.0

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

@@ -0,0 +1,296 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/payment/api/pay/v2/resources/charge.proto";
+import "wix/payment/api/pay/v2/resources/mandatory-field.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Describing payment method: it's id, provider name, mandatory fields, charget intents and any other additional info.
+message PaymentMethod {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v2.payment_method"
+        segment: PUBLIC // no domain events produced
+    };
+
+    // unique identifier of payment method
+    string payment_method             = 1;
+    // Provider which is connected to process the payment method. Note that a payment method can only be connected to
+    // one provider.
+    //
+    // Provider ID (like `net.authorize` or `payPal`) can be used for UI purposes.
+    //
+    // Checkout [PaymentProviders.scala][1] for the list of defined providers.
+    //
+    //   [1]: https://github.com/wix-private/cashier/blob/master/payment-services/blackbeard-modules/payment-domain/src/main/scala/com/wixpress/payment/settings/PaymentProviders.scala
+    string connected_provider_id      = 2;
+    // the method type
+    MethodType method_type            = 3;
+    // Availability and limitations of using installements, as imposed by the connected provider.
+    Installments installments         = 4;
+
+    // Additional info for providers which is needed to integrate payments:
+    // * `2checkout` - `sellerId` and `publishableKey`
+    // * `square` - `squareAppId` and `location`
+    // * `offline` - `merchantInstructions`
+    map<string, string> additional_info = 6;
+
+    // Fields that need to be provided for payment to pass for the connected provider or the order to which this payment
+    // method belongs.
+    repeated MandatoryField mandatory_fields = 7;
+
+    // Meaning that the method is currently not available for charage due to problems with 3rd-party provider. You
+    // should use this field to reflect the issue on the client side.
+    //
+    // If you use this method in [charge request][1], server will response with 403.
+    //
+    //   [1]: .wix.payment.api.pay.v2.-payment-service.-charge
+    bool disabled = 8;
+
+    // Charge intents which are supported by this payment method.
+    //
+    // 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.
+    repeated Charge.ChargeIntent supported_charge_intents = 10;
+
+    // method type
+    enum MethodType {
+        UNDEFINED = 0;
+        ONLINE = 1;
+        FACE_TO_FACE = 2;
+    }
+
+    //link to the method icon
+    google.protobuf.StringValue method_icon = 11;
+
+    //link to the method resizable png icon
+    google.protobuf.StringValue method_icon_png = 16;
+
+    //title for payment method
+    google.protobuf.StringValue method_title = 12;
+
+    bool frameable  = 13;
+
+    bool responsive = 14;
+
+    bool redirectable = 15;
+
+    bool bnpl_support = 18;
+
+    int32 rank = 17;
+
+    bool provider_tokenization = 19;
+
+    google.protobuf.StringValue saved_payment_method_id = 20 [(wix.api.format) = GUID];
+
+    google.protobuf.StringValue payment_agreement_id = 21 [(wix.api.format) = GUID];
+
+    // is saved method primary for this UoU
+    google.protobuf.BoolValue primary = 22;
+
+    oneof saved_payment_method_details {
+        SavedCreditCardDetails saved_credit_card_details = 25;
+    }
+
+    enum SavePaymentMethodDisplayOption {
+        SHOW_NOTHING = 0;
+        SHOW_SAVE_PAYMENT_METHOD_CHECKBOX = 1;
+        SHOW_DISCLAIMER = 2;
+        SHOW_MERCHANT_SAVE_PAYMENT_METHOD_CHECKBOX = 3;
+        SHOW_MERCHANT_DISCLAIMER = 4;
+    }
+
+    //Save Payment Method legal conditions
+    SavePaymentMethodDisplayOption save_payment_method_display_option = 26;
+
+    // Allow manual MIT legal conditions
+    AllowMitDisplayOptionEnum.AllowMitDisplayOption allow_mit_display_option = 27;
+}
+
+message AllowMitDisplayOptionEnum {
+    enum AllowMitDisplayOption {
+        SHOW_NOTHING = 0;
+        SHOW_ALLOW_MIT_CHECKBOX = 1;
+    }
+}
+
+message SavedCreditCardDetails {
+    // credit card network (visa, mastercard, amex, jcb)
+    google.protobuf.StringValue network      = 1;
+
+    // last 4 digits of credit card number
+    string last_four_digits                  = 2;
+
+    // the month of the card expiration date
+    google.protobuf.UInt32Value expiry_month = 3 [(wix.api.min) = 1, (wix.api.max) = 12];
+
+    // the full year of the card expiration date
+    google.protobuf.UInt32Value expiry_year  = 4 [(wix.api.min) = 2000, (wix.api.max) = 2099];
+
+    // credit card holder's name
+    google.protobuf.StringValue holder_name  = 5;
+}
+
+message PayPalDetails {
+
+}
+
+message SavedPaymentMethodDetails {
+    oneof details {
+        SavedCreditCardDetails saved_credit_card_details = 1;
+        PayPalDetails pay_pal_details = 2;
+    }
+}
+
+// Availability and limitations of using installements, as imposed by the connected provider.
+message Installments {
+    // minimum number of installments to use
+    int32 min_installments             = 1;
+    // maximum number of installments to use
+    int32 max_installments             = 2;
+    // minimum amount to use installments
+    double min_transaction_amount      = 3;
+}
+
+message BuyNowPayLaterMethod {
+    // unique identifier of payment method
+    string payment_method                               = 1;
+
+    // available options for BNPL for UoU
+    repeated BuyNowPayLaterOption payment_options       = 2;
+    // url of page with BNPL details
+    google.protobuf.StringValue infoUrl                 = 3;
+    // payment method logos
+    BuyNowPayLaterMethodLogo logo                       = 4;
+    // payment method promo message
+    google.protobuf.StringValue promo_message           = 5;
+    // UoU method display rank
+    int32 rank                                          = 6;
+
+    // display name of payment provider connected to payment method
+    string payment_provider_name                        = 10;
+
+    // payment method promo message
+    string bnpl_message                                 = 15;
+
+    // payment method modal page with more BNPL info:
+    // terms & conditions, detailed plans, etc
+    ModalPage bnpl_modal_page                           = 16;
+
+    // payment provider impression URL to notify when provider BNPL is shown to UoU
+    google.protobuf.StringValue provider_impression_url = 17;
+}
+
+message BuyNowPayLaterMethodLogo {
+    string logo_light   = 1;
+    string logo_dark    = 2;
+}
+
+message BuyNowPayLaterOption {
+    // number of installments
+    uint32 installment_count   = 1;
+    // amount of each installment
+    double installment_amount  = 2;
+    // total amount with interest
+    double total_amount         = 3;
+    // provider commission amount
+    double interest_amount      = 4;
+}
+
+message ModalPage {
+    // page url
+    string url                                          = 1;
+
+    // page link text
+    string cta_text                                     = 2;
+
+    // display resolution of modal page
+    // empty if page is responsive
+    PageResolution resolution                           = 3;
+}
+
+message PageResolution {
+    uint32 height   = 1;
+    uint32 width    = 2;
+}
+
+message ExpressPaymentMethod {
+
+    oneof payment_method_details {
+        ApplePayExpressPaymentMethodDetails apple_pay   = 10;
+
+        PayPalExpressPaymentMethodDetails pay_pal       = 11;
+
+        GooglePayExpressPaymentMethodDetails google_pay = 12;
+    }
+
+    message ApplePayExpressPaymentMethodDetails {
+
+        string merchant_country                             = 1;
+
+        repeated CreditCardNetwork supported_networks       = 5;
+
+        repeated MerchantCapability merchant_capabilities   = 6;
+    }
+
+    message GooglePayExpressPaymentMethodDetails {
+
+        string merchant_country                       = 1;
+
+        repeated CreditCardNetwork supported_networks = 5;
+
+        repeated PanType panTypes                     = 6;
+    }
+
+    enum CreditCardNetwork {
+        UNDEFINED_NETWORK   = 0;
+        AMEX                = 1;
+        CARTES_BANCAIRES    = 2;
+        CHINA_UNION_PAY     = 3;
+        DISCOVER            = 5;
+        EFTPOS              = 6;
+        ELECTRON            = 7;
+        ELO                 = 8;
+        INTERAC             = 9;
+        JCB                 = 10;
+        MADA                = 11;
+        MAESTRO             = 12;
+        MASTER_CARD         = 13;
+        PRIVATE_LABEL       = 14;
+        VISA                = 15;
+        VPAY                = 16;
+    }
+
+    enum MerchantCapability {
+        UNDEFINED_CAPABILITY    = 0;
+        SUPPORTS_3DS            = 1;
+        SUPPORTS_EMV            = 2;
+        SUPPORTS_CREDIT         = 3;
+        SUPPORTS_DEBIT          = 4;
+    }
+
+    enum PanType {
+        UNDEFINED_TYPE = 0;
+        FPAN = 1; // PAN_ONLY
+        DPAN = 2; // CRYPTOGRAM_3DS
+    }
+
+    message PayPalExpressPaymentMethodDetails {
+
+        string client_id        = 1;
+
+        string merchant_id      = 2;
+
+        string bn_code          = 3;
+
+        bool credit_enabled     = 4;
+    }
+}

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

@@ -0,0 +1,208 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/payment/api/pay/v2/resources/address.proto";
+import "wix/payment/api/pay/v2/resources/order-buyer-info.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Details on how the order was paid.
+//
+// It's either embedded payment details or an id of the previously saved details.
+message Payment {
+    oneof payment {
+        // details embedded into request
+        PaymentDetails details    = 1;
+        // id of previously saved details
+        string details_id         = 2;
+    }
+}
+
+// Payment details
+message PaymentDetails {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v2.payment_details"
+        segment: PUBLIC // no domain events produced
+    };
+
+    // payment method as returned by [list payment methods][1] (required)
+    //
+    //  [1]: /cashier-pay/reference/payment-method/.wix.payment.api.pay.v2.-payment-method-service.-list
+    string payment_method                            = 1;
+
+    // Availability and limitations of using installements, as imposed by the connected provider (optional, default: 1).
+    int32 installments                               = 2;
+
+    // client attributes (optional)
+    ClientInfo client_info                           = 3;
+
+    // credit card token (required if `paymentMethod` = `creditCard`), instead use token
+    CreditCardToken credit_card_token                = 100 [deprecated=true];
+
+    // token for payment, can be credit card, applePay, payPal or other kind of token.
+    // Deprecated, instead use one of payment method details.
+    google.protobuf.StringValue token                = 103 [deprecated=true];
+
+    // Any additional data which might be required by providers in order to process payment. This field is not used
+    // right now, so leave it blank. Work in progress.
+    //
+    // Usages:
+    // * iDeal.issuerBank - for `com.stripe` provider, when `paymentMethod` is `iDeal`
+    // Deprecate, instead use one of payment method details.
+    map<string, string> additional_data              = 101 [deprecated=true];
+
+    // billing address providing fields missing from the order (optional)
+    Address billing_address                          = 102;
+
+    // checkout type, express or regular
+    CheckoutType checkout_type                       = 104;
+
+    // checkout session id, must be GUID
+    google.protobuf.StringValue checkout_session     = 105;
+
+    // disposition of redirect target: embedded, in the same window, in a new window
+    RedirectTarget redirect_target                   = 106;
+
+    BuyerLocale buyer_info                           = 107;
+
+    //Used for saved credit card
+    bool save_payment_method                         = 108;
+
+    google.protobuf.StringValue payment_agreement_id = 109;
+
+    // you may specify id of order these PaymentDetails are used with.
+    // if that order has 1 not failed transaction further use of these details won't be possible.
+    google.protobuf.StringValue order_id             = 110;
+
+    // allows to save payment method for MIT
+    bool allow_for_mit                               = 111;
+
+    oneof payment_method_details {
+      // payment with a card online
+      CardPayment card                        = 201;
+
+      // payment with a card at a POS
+      CardReaderPayment card_reader           = 202;
+
+      // the iDEAL payment system
+      IDealPayment ideal                      = 203;
+
+      // the Apple Pay digital wallet
+      ApplePayPayment apple_pay               = 204;
+
+      PayPalPayment pay_pal                   = 205;
+
+      // Google Pay
+      GooglePayPayment google_pay             = 206;
+
+      // payment with a card using saved card
+      SavedCardPayment saved_card_payment     = 207;
+    }
+}
+
+// Client attributes
+message ClientInfo {
+    // client device fingerprint (optional)
+    google.protobuf.StringValue device_fingerprint = 1;
+    // Provider-specific risk data
+    map<string, string> risk_provider_data = 2 [(wix.api.maxSize) = 16];
+}
+
+// Credit card token
+message CreditCardToken {
+    // token string representation (as returned by [cashier credit card tokenizer][1])
+    //
+    //   [1]: /cashier-credit-card/reference/token
+    string token = 1;
+}
+
+enum CheckoutType {
+    UNKNOWN = 0;
+    REGULAR = 1;
+    EXPRESS = 2;
+}
+
+enum RedirectTarget {
+    SAME_WINDOW = 0;
+    NEW_WINDOW  = 1;
+    EMBEDDED    = 2;
+}
+
+message CardPayment {
+
+    // the card number token
+    string number_token = 1 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+
+    // the month of the card expiration date
+    uint32 expiry_month = 2 [(wix.api.min) = 1, (wix.api.max) = 12];
+
+    // the full year of the card expiration date
+    uint32 expiry_year = 3 [(wix.api.min) = 2000, (wix.api.max) = 2099];
+
+    // the cardholder name printed on the card
+    google.protobuf.StringValue holder_name = 4 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+
+    // the CVV/CVC/CID token
+    google.protobuf.StringValue security_code_token = 5 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+}
+
+message IDealPayment {
+
+  // the code of the issuing bank
+  string issuing_bank = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+}
+
+message GooglePayPayment {
+  // the payment token
+  string token = 1 [(wix.api.minLength) = 1];
+  // Display name of the card
+  google.protobuf.StringValue displayName = 3 [(wix.api.minLength) = 1];
+  // Network of the card
+  google.protobuf.StringValue network = 4 [(wix.api.minLength) = 1];
+  // Type of the card
+  google.protobuf.StringValue type = 5 [(wix.api.minLength) = 1];
+}
+
+message ApplePayPayment {
+  // the payment token
+  string token = 1 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+  // Display name of the card
+  google.protobuf.StringValue displayName = 3 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+  // Network of the card
+  google.protobuf.StringValue network = 4 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+  // Type of the card
+  google.protobuf.StringValue type = 5 [(wix.api.minLength) = 1 /*, (wix.api.maxLength) = ? */];
+}
+
+message CardReaderPayment {
+
+  // the location ID
+  google.protobuf.StringValue location_id = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 36];
+
+  // the terminal ID
+  google.protobuf.StringValue terminal_id = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+
+  // the service ID
+  google.protobuf.StringValue service_id = 3 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+
+  // whether create intent only or complete transaction (use this flag only if you know what it means)
+  google.protobuf.BoolValue create_intent_only = 4 [deprecated=true];
+}
+
+message PayPalPayment {
+
+    google.protobuf.StringValue pay_pal_token = 1;
+}
+
+message SavedCardPayment {
+  // id of previously saved Payment Method
+  string payment_method_id  = 1;
+
+  // the CVV/CVC/CID token
+  google.protobuf.StringValue security_code_token = 2;
+}

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

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+import "wix/api/entity.proto";
+
+message PosTransaction {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v2.pos_transaction"
+        segment: PUBLIC // no domain events produced
+    };
+
+    // provider_id through which transaction was made
+    string provider_id = 1;
+
+    oneof result {
+        // required pos data for approved transaction
+        ApprovedPosTransaction approved_data = 10;
+        // required pos data for declined transaction
+        DeclinedPosTransaction declined_data = 11;
+    }
+    // any optional data which should be stored with transaction
+    map<string, string> additional_data = 20;
+}
+
+message ApprovedPosTransaction {
+    // authorisation key
+    string authorization_key    = 1;
+    // availability and limitations of using installements, as imposed by the provider
+    int32 installments = 2;
+}
+
+message DeclinedPosTransaction {
+    // failure code
+    string failure_code  = 1;
+    // failure description
+    string failure_desc  = 2;
+}

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

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Frequency unit of recurring payment
+enum SubscriptionFrequency {
+    UNDEFINED = 0;
+    DAY       = 1;
+    WEEK      = 2;
+    MONTH     = 3;
+    YEAR      = 4;
+}

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

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/payment/api/pay/v2/resources/subscription-frequency.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Trial period of subscription
+message SubscriptionTrialPeriod {
+    // trial period in units (required)
+    int32 period                = 2;
+
+    // units in which trial period is described (optional, default DAY)
+    SubscriptionFrequency unit = 1;
+}

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

@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/timestamp.proto";
+import public "wix/payment/api/pay/v2/resources/subscription-frequency.proto";
+import public "wix/payment/api/pay/v2/resources/subscription-trial-period.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Recurring payment is described by `frequency` (day, week, month) and `interval`.
+//
+// For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
+//
+// In some cases there should be a trial period for the order, after which payments start to occur.
+// Trial period is also defined as `frequency` and `interval` pair.
+//
+// So one can define a monthly 'subscription' with a 14 days trial period.
+message Subscription {
+    // frequency of recurring payment (required)
+    SubscriptionFrequency frequency = 1;
+    // interval of recurring payment (required)
+    int32 interval                  = 2;
+
+    // trial period for recurring payment (optional)
+    SubscriptionTrialPeriod trial   = 3;
+
+    // how many billing cycles should be done before subscription finishes
+    // (optional, 0 by default means endless subscription)
+    int32 billing_cycles            = 4;
+
+    // date in the future or in the past when the first billing cycle begins
+    // (the first off-session payment is performed when it ends)
+    google.protobuf.Timestamp first_cycle_start_date = 5;
+}

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

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/timestamp.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Transaction status
+message TransactionStatus {
+    // transaction status
+    Status status = 1;
+
+    // timestamp when the transaction was transmitted to the current status
+    google.protobuf.Timestamp ts    = 2;
+
+    enum Status {
+        UNDEFINED        = 0;
+        INITIALIZATION   = 1;
+        INITIALIZED      = 2;
+
+        IN_PROCESS       = 3;
+
+        APPROVED         = 4;
+        // transaction is pending, merchant action is required
+        PENDING_MERCHANT = 5;
+        // means just pending, for example transaction is pending because of fraud check
+        PENDING_BUYER    = 6;
+
+        DECLINED         = 7;
+        FAILED           = 8;
+        BUYER_CANCELED   = 9;
+        TIMEOUT          = 10;
+        REFUND           = 11;
+        CHARGE_BACK      = 12;
+        VOIDED           = 13;
+        AUTHORIZED       = 14;
+
+        OFFLINE          = 20;
+    }
+}
+
+message TransactionFailureDetails {
+    // cashier transaction failure code
+    string failure_code                    = 1;
+}

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

@@ -0,0 +1,27 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/callback.proto";
+import "wix/api/entity.proto";
+import "wix/payment/api/pay/v3/resources/payment-event.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+service PaymentEventsService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v3.PaymentEvent";
+
+    //This webhook is triggered whenever a payment transaction is updated (including refunds) via specific Wix business solutions.
+    option (wix.api.event) = {
+       topic: "cashier-payment-event"
+       payload: "wix.payment.api.pay.v3.PaymentEvent"
+       permission: "CASHIER.READ_PAYMENTS"
+       exposure: PUBLIC
+       maturity: GA
+    };
+    option (wix.api.service_exposure) = PUBLIC;
+    option (wix.api.service_maturity) = BETA;
+}