@wix/bex-utils 1.28.0

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

@@ -0,0 +1,131 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+message CofIntent {
+
+  oneof intent_type {
+
+    // an on-session payment followed by storing credentials to perform cardholder initiated transactions later (like one-click purchases)
+    SetupCofOnSession setup_cof_on_session = 1;
+
+    // an on-session payment followed by storing credentials to perform recurring merchant initiated transactions later (like regular subscription charges)
+    SetupCofRecurring setup_cof_recurring = 2;
+
+    // an on-session payment followed by storing credentials to perform unscheduled merchant initiated transactions later (like automatic top-ups)
+    SetupCofUnscheduled setup_cof_unscheduled = 3;
+
+    // an on-session cardholder initiated transaction (like a one-click purchase)
+    CofOnSession cof_on_session = 4;
+
+    // an off-session recurring merchant initiated transaction (like a regular subscription charge)
+    CofRecurring cof_recurring = 5;
+
+    // an off-session unscheduled merchant initiated transaction (like an automatic top-up)
+    CofUnscheduled cof_unscheduled = 6;
+  }
+}
+
+message SetupCofOnSession {
+
+  // keep credentials for subsequent payments on a successful payment
+  bool store_payment_credentials = 1;
+}
+
+message MandateOptions {
+
+  // a description of the mandate or subscription that is meant to be displayed to the customer
+  google.protobuf.StringValue description = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 1000];
+
+  // payment amount
+  Amount amount = 2;
+
+  // specifies time ranges for future payments
+  Interval interval = 3;
+
+  // specifies frequency of payments
+  Frequency frequency = 4;
+
+  message Amount {
+
+    // amount to be charged for future payments
+    double value = 1;
+
+    // if `FIXED`, the `amount` parameter refers to the exact amount to be charged in future payments
+    // if `MAXIMUM`, the amount charged can be up to the value passed for the `amount` parameter
+    Type type = 2;
+
+    enum Type {
+      UNKNOWN = 0;
+      FIXED = 1;
+      MAXIMUM = 2;
+    }
+  }
+
+  message Interval {
+
+    // start date of the mandate or subscription
+    google.protobuf.Timestamp start_date = 1;
+
+    // end date of the mandate or subscription. If not provided, the mandate will be active until canceled
+    google.protobuf.Timestamp end_date = 2;
+  }
+
+  message Frequency {
+
+    // the number of intervals between payments. For example, `type=MONTH` and `count=3` indicates one payment every three months
+    // maximum of one year interval allowed (1 year, 12 months, or 52 weeks)
+    // this parameter is optional only when `type=SPORADIC`
+    google.protobuf.UInt32Value count = 1 [(.wix.api.min) = 1, (.wix.api.max) = 365];
+
+    Type type = 2;
+
+    enum Type {
+      UNKNOWN = 0;
+      DAY = 1;
+      WEEK = 2;
+      MONTH = 3;
+      YEAR = 4;
+      SPORADIC = 5;
+    }
+  }
+}
+
+message SetupCofRecurring {
+
+  // keep credentials for subsequent payments on a successful payment
+  bool store_payment_credentials = 1;
+
+  // a record of the permission a customer has given to debit his payment method
+  MandateOptions mandate_options = 2;
+}
+
+message SetupCofUnscheduled {
+
+  // keep credentials for subsequent payments on a successful payment
+  bool store_payment_credentials = 1;
+
+  // a record of the permission a customer has given to debit his payment method
+  MandateOptions mandate_options = 2;
+}
+
+message CofOnSession {
+  // deprecated, please use payment agreements instead
+  string reference_order_id = 1 [deprecated = true];
+}
+
+message CofRecurring {
+  // deprecated, please use payment agreements instead
+  string reference_order_id = 1 [deprecated = true];
+}
+
+message CofUnscheduled {
+  // deprecated, please use payment agreements instead
+  string reference_order_id = 1 [deprecated = true];
+}

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

@@ -0,0 +1,146 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+
+import "wix/api/annotations.proto";
+import "wix/payment/api/pay/v2/resources/address.proto";
+import "wix/payment/api/pay/v2/resources/order-additional-charges.proto";
+import "wix/payment/api/pay/v2/resources/order-buyer-info.proto";
+import "wix/payment/api/pay/v2/resources/order-item.proto";
+import "wix/payment/api/pay/v2/resources/subscription.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Describing the order:
+// * what is bought (items, shipping, tax)
+// * payment type (one-time, subscription)
+// * info about the buyer
+// * billing and shipping addresses
+// * external references
+message OrderDescription {
+  // total amount of this order for `ONE_TIME` order or one payment amount for `SUBSCRIPTION` order (required). Only positive values.
+  double amount                     = 1;
+  // Currency of the order (required). Supported values are:
+  // `AFN`, `USD`, `EUR`, `BMD`, `BGN`, `BIF`, `CVE`, `KMF`, `CDF`, `DJF`,
+  // `ERN`, `FKP`, `GHS`, `GNF`, `LAK`, `LSL`, `LYD`, `MWK`, `MRO`, `MZN`,
+  // `PAB`, `RON`, `RUB`, `SHP`, `RSD`, `SLL`, `SBD`, `SOS`, `SZL`, `TJS`,
+  // `TOP`, `TMT`, `YER`, `ZMW`, `GIP`, `ZAR`, `XPF`, `XOF`, `XCD`, `XAF`,
+  // `WST`, `VUV`, `VND`, `VEF`, `UZS`, `UYU`, `UGX`, `UAH`, `TZS`, `TWD`,
+  // `TTD`, `TRY`, `TND`, `THB`, `STD`, `SGD`, `SEK`, `SCR`, `SAR`, `RWF`,
+  // `QAR`, `PYG`, `PLN`, `PKR`, `PHP`, `PGK`, `PEN`, `OMR`, `NZD`, `NPR`,
+  // `NOK`, `NIO`, `NGN`, `MYR`, `MXN`, `MVR`, `MUR`, `MOP`, `MNT`, `MMK`,
+  // `MKD`, `MDL`, `MAD`, `LRD`, `LKR`, `LBP`, `KZT`, `KYD`, `KWD`, `KRW`,
+  // `KHR`, `KGS`, `KES`, `JPY`, `JOD`, `JMD`, `ISK`, `INR`, `ILS`, `IDR`,
+  // `HUF`, `HTG`, `HRK`, `HNL`, `HKD`, `GYD`, `GTQ`, `GMD`, `GEL`, `GBP`,
+  // `FJD`, `ETB`, `EGP`, `DZD`, `DOP`, `DKK`, `CZK`, `CRC`, `COP`, `CNY`,
+  // `CLP`, `CHF`, `CAD`, `BZD`, `BYN`, `BWP`, `BTN`, `BSD`, `BRL`, `BOB`,
+  // `BND`, `BHD`, `BDT`, `BBD`, `BAM`, `AZN`, `AWG`, `AUD`, `ARS`, `AOA`,
+  // `ANG`, `AMD`, `ALL`, `AED`, `MGA`, `MZN`, `NAD`, `RON`, `GHS`, `SRD`,
+  // `TMT`, `ZMW`, `IQD`
+  string currency                   = 2;
+  // order type (optional, default: `ONE_TIME`)
+  OrderType type                    = 3;
+
+  // items which are included in the order (required)
+  repeated OrderItem items          = 10;
+  // billing address of the order (optional)
+  Address billing_address           = 11;
+  // shipping address of the order (optional)
+  Address shipping_address          = 12;
+  // additional charges which are included in the order, like tax, shipping or discount (optional)
+  OrderAdditionalCharges charges    = 13;
+  // indicate that shipping is not needed for the order (optional)
+  bool noShipping                   = 14;
+
+  // information about subscription (required for `SUBSCRIPTION` order, not allowed for `ONE_TIME` order)
+  Subscription subscription         = 20;
+
+  // order reference in third party system (required)
+  string vertical_order_id          = 40;
+  // buyer information which can use to provide better service (optional)
+  OrderBuyerInfo buyer_info         = 41;
+  // any external data which is stored with the order on cashier side
+  // and can be used in future by third party system
+  // Well-known keys:
+  // providers.square.orderId - value to pass as [order_id][1] if payment is made via Square
+  // [1]: https://developer.squareup.com/reference/square/payments-api/create-payment#request__property-order_id
+  map<string, string> external_data = 42;
+
+  // timestamp on which event/delivery/ect. happens and order is considered fulfilled
+  google.protobuf.Timestamp fulfillment_date = 43;
+
+  // Complete description that appears on the customers' statements.
+  google.protobuf.StringValue soft_descriptor = 44;
+
+  // Vertical invoice id
+  google.protobuf.StringValue vertical_invoice_id = 45;
+
+  // indicate that order is created by merchant
+  bool merchant_initiated = 46;
+
+  // List of allowed payment providers the order can be paid with
+  repeated string allowed_payment_provider_ids = 47;
+
+  // Type of the order
+  enum OrderType {
+    UNDEFINED    = 0;
+    ONE_TIME     = 1;
+    SUBSCRIPTION = 2;
+  }
+
+  // Capture method
+  CaptureMethod capture_method = 48;
+  enum CaptureMethod {
+    UNKNOWN_CAPTURE_METHOD = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    IMMEDIATE = 1;
+    DELAYED = 2;
+    FORCE_MANUAL = 3; // Will deprecate after migrate sbs
+    AUTOMATIC = 4; // Will be removed
+    PREFER_MANUAL = 5; // Will be removed
+  }
+
+  DelayedCaptureOptions delayed_capture_options = 49;
+
+  // indicate that payment method is allowed to save for MIT
+  bool allow_save_for_mit = 50;
+}
+
+message DelayedCaptureOptions {
+  // If auth & capture is not supported by the provider, capture immediately.
+  bool allow_immediate = 1;
+
+  // Specifies the automatic action (void/capture) for authorized transaction after the specified duration
+  ScheduledAction scheduled_action = 2;
+}
+
+message ScheduledAction {
+  Action action = 1;
+  Duration delay = 2;
+
+  enum Action {
+    UNKNOWN_ACTION = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    VOID = 1;
+    CAPTURE = 2;
+  }
+
+  message Duration {
+    // Duration unit: MINUTE, HOUR and DAY
+    DurationUnitEnum.DurationUnit unit = 1;
+
+    // Amount of units. For example,  30 MINUTE, 1 HOUR, 7 DAY, etc. Optional.
+    google.protobuf.Int32Value count = 2;
+
+    message DurationUnitEnum {
+      enum DurationUnit {
+        UNKNOWN_DURATION_UNIT = 0;
+        MINUTE = 1;
+        HOUR = 2;
+        DAY = 3;
+      }
+    }
+  }
+}
+

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

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// item included in order
+message OrderItem {
+  // order item id (required)
+  string id           = 1;
+  // order item name (required)
+  string name         = 2;
+  // quantity (required)
+  int32 quantity      = 3;
+  // one item price, amount of this item is quantity * price (required). Only positive values.
+  double price        = 4;
+  // order item description
+  string description  = 5;
+  // weight of one item
+  double weight_in_kg = 6;
+  // whether the item is a physical good or a digital one
+  OrderItemCategory category = 7;
+
+  // The type of order item
+  enum OrderItemCategory {
+    UNDEFINED         = 0;
+    // a physical good
+    PHYSICAL          = 1;
+    // a digital good
+    DIGITAL           = 2;
+  }
+}

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

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Callback URLs which are used to return buyer to third party system.
+//
+// When user clicks to pay for the order he/she is redirected to the payment page. After that (depending on the payment
+// status) user is redirected to one of return URLs.
+message OrderReturnUrls {
+  // URL to redirect buyer in case of approved (successful) transaction (required)
+  string success_url = 1;
+  // URL to redirect buyer in case of failed/rejected transaction (required)
+  string error_url   = 2;
+  // URL to redirect buyer in case of buyer canceled the transaction (optional, default: `{error_url}`)
+  string cancel_url  = 3;
+  // URL to redirect buyer in case of pending transaction (that might take some time to process) (optional, default:
+  // `{success_url}`)
+  string pending_url = 4;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/order-status.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";
+
+// status of the order
+message OrderStatus {
+  // status of the order
+  Status status                = 1;
+  // timestamp when the order was transmited to the current status
+  google.protobuf.Timestamp ts = 2;
+
+  // status of the order (more info [here][1])
+  //
+  //  [1]: /cashier-pay/guides/Order%20overview
+  enum Status {
+    UNDEFINED              = 0;
+    // meaning the order was created
+    INITIALIZED            = 1;
+    // meaning payment process for this order has started OR has been successfully completed
+    IN_PROCESS             = 2;
+    // meaning payment process for this order didn't finish in time
+    EXPIRED                = 3;
+    // meaning payment process has failed (due to any of the reasons)
+    NOT_APPROVED           = 4;
+    // meaning that order has been approved (has approved transaction)
+    APPROVED               = 5;
+    // meaning order can become EXPIRED or APPROVED based on existing transactions
+    // prevents from adding new transactions to order
+    PENDING_EXPIRATION     = 6;
+
+    // meaning recurring payment is active
+    SUBSCRIPTION_ACTIVE    = 10;
+    // meaning recurring payment was cancelled by user
+    SUBSCRIPTION_CANCELLED = 11;
+    // meaning the total billing cycles for the optional trial and the regular payment periods was completed (not yet supported)
+    SUBSCRIPTION_FINISHED  = 12;
+    // meaning recurring payment is not active yet, waiting for the first payment
+    SUBSCRIPTION_PENDING   = 13;
+    // meaning recurring payment was suspended by user
+    SUBSCRIPTION_SUSPENDED = 14;
+  }
+}

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

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/payment/api/pay/v2/resources/order-return-urls.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// Third party system urls which should be used as callback/event_hook.
+//
+// * Event hook is used for sending update notifications (order expired, transaction status update or subscription
+// status update)
+//
+// * Callback is where buyer is redirected when payment is finished (regardless the actual state). **Only one** of
+// `return_urls`/`simple_return_url` should be used. If nothing is provided - buyer is redirected to the custom cashier
+// page which can be used in pair with Cashier Client SDK to support payments in separate tab.
+message OrderUrls {
+  // Event hook which should be used (required if async payments providers are used).
+  //
+  // Supported values:
+  // * web url (starts with `https://`) - web hook, events are sent via http protocol
+  // * `rpc:${groupId.artifactId}` - RPC hook, webhook listener should be registered on application side as rpc service
+  //
+  // For more information, please read related section of [this guide][1].
+  //
+  //  [1]: /cashier-pay/guides/Order%20overview
+  string event_hook = 3;
+
+  oneof callback {
+    // Callback urls which are used to return buyer to third party system.
+    OrderReturnUrls return_urls = 20;
+
+    // Simple callback url to return buyer to the third party system after redirect url will contain payment status in
+    // 'status' query parameter.
+    //
+    // Examples:
+    // * `{complete_url}?status=approved`
+    // * `{complete_url}?status=pending`
+    string simple_return_url    = 21;
+  }
+}

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

@@ -0,0 +1,37 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import public "wix/payment/api/pay/v2/resources/order-additional-charges.proto";
+import public "wix/payment/api/pay/v2/resources/order-buyer-info.proto";
+import public "wix/payment/api/pay/v2/resources/order-description.proto";
+import public "wix/payment/api/pay/v2/resources/order-item.proto";
+import public "wix/payment/api/pay/v2/resources/order-return-urls.proto";
+import public "wix/payment/api/pay/v2/resources/order-status.proto";
+import public "wix/payment/api/pay/v2/resources/order-urls.proto";
+
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+// entity representing an order
+message Order {
+
+  option (wix.api.entity) = {
+    fqdn: "wix.cashier.pay.v2.order"
+    segment: PUBLIC // no domain events produced
+  };
+
+  // unique identifier of each order
+  string id                     = 1;
+  // order description
+  OrderDescription description  = 2;
+  // return urls
+  OrderReturnUrls return_urls   = 3;
+
+  // Unique identifier of an account for which the order was created.
+  string account_id             = 5;
+
+  // current and historical statuses of this order, ordered descending by `ts`
+  repeated OrderStatus statuses = 100;
+}