@devvit/protos 0.11.4 → 0.11.5-next-2024-12-09-8401a61d8.0

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_order.proto

@@ -0,0 +1,31 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/payapi/v1/checkout.proto";
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message Order {
+  string id = 1;
+  OrderStatus status = 2;
+  google.protobuf.Timestamp created_at = 3;
+  google.protobuf.Timestamp updated_at = 4;
+  repeated OrderItem items = 5;
+  CheckoutAction checkout_action = 6;
+  StatusReason status_reason = 7;
+  Environment environment = 8;
+  string seller_id = 9;
+  string buyer_id = 10;
+  map<string, string> metadata = 11; // Recorded at order creation
+}
+
+message GetOrderResponse {
+  Order order = 1;
+}
+
+message GetOrderRequest {
+  string order_id = 1;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_order.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message GetOrdersRequest {
+  CallerID caller_id = 1;
+  string seller_id = 2; // t2_id of the seller
+  string buyer_id = 3; // t2_id of the buyer
+  repeated string order_ids = 4; // the order ids filter
+  OrderStatus status = 5; // the status filter of the order
+  google.protobuf.Timestamp create_at_start = 6; // the start of the time range filter
+  google.protobuf.Timestamp create_at_end = 7; // the end of the time range filter
+  Environment environment = 8; // the environment filter of the order
+  PageInfo page_info = 20;
+}
+
+message GetOrdersResponse {
+  repeated Order orders = 1;
+  PageInfo next_page = 2;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders_by_user.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/get_order.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message GetOrdersByUserRequest {
+  string user_id = 1;
+}
+
+message GetOrdersByUserResponse {
+  repeated Order orders = 1;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_payout_info_batch.proto

@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_gold_balances.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message PayoutContext {
+  Environment environment = 1;
+  string user_id = 2;
+}
+
+message GetPayoutInfoBatchRequest {
+  repeated PayoutContext requests = 1;
+}
+
+message GetPayoutInfoBatchResponse {
+  repeated PayoutInfo payout_infos = 1;
+}
+
+message PayoutInfo {
+  ProductPrice current_earnings = 1;
+  ProductPrice all_time_earnings = 2;
+  PayoutTransactionsConnection transactions_connection = 3;
+  Environment environment = 4;
+}
+
+message PayoutTransactionsConnection {
+  repeated PayoutTransaction transactions = 1;
+  PageInfo page_info = 2;
+}
+
+message PayoutTransaction {
+  // string id = 1; // Reserved to support pagination
+  // Earnings for this payout, in the Redditor's currency
+  ProductPrice earnings = 2;
+  // Amount of earned gold that was (or will be) paid out
+  int32 gold = 3;
+  ContributorPayoutStatus status = 4;
+  google.protobuf.Timestamp date = 5;
+}
+
+enum ContributorPayoutStatus {
+  CONTRIBUTOR_PAYOUT_STATUS_UNSPECIFIED = 0;
+
+  CONTRIBUTOR_PAYOUT_STATUS_PROCESSING = 1;
+  CONTRIBUTOR_PAYOUT_STATUS_COMPLETE = 2;
+  CONTRIBUTOR_PAYOUT_STATUS_FAILED = 3;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_products.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message GetProductsRequest {
+  CallerID caller_id = 1;
+  Environment environment = 2;
+  repeated PaymentProvider payment_providers = 3;
+  Currency currency = 4;
+  ClientInfo client_info = 5;
+  string calling_user_id = 6; // Reddit user calling the API
+  string owner_id = 7;
+  repeated string product_ids = 8;
+  map<string, string> metadata = 9; // Free-form metadata filter
+}
+
+message GetProductsResponse {
+  repeated Product products = 1;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_user_profiles.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message GetUserProfilesRequest {
+  repeated string user_ids = 1;
+}
+
+message UserProfileList {
+  repeated UserProfile user_profiles = 1;
+}
+
+message UserProfile {
+  Environment environment = 1;
+  StripeProfile stripe_profile = 2;
+}
+
+message StripeProfile {
+  string stripe_account_id = 1;
+}
+
+message GetUserProfilesResponse {
+  map<string, UserProfileList> user_profiles = 1;
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/refund_order.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message RefundOrderRequest {
+  string order_id = 1;
+  StatusReason reason = 2;
+
+  string initiator_id = 98; // t2_id of the user initiating the refund.
+  CallerID caller_id = 99; // This is the ID of the service that is calling this API.
+}
+
+message RefundOrderResponse {}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/acknowledge_order_delivery.proto";
+import "reddit/xpaymentsplatform/payapi/v1/checkout.proto";
+import "reddit/xpaymentsplatform/payapi/v1/delete_products.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_batch_products.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_gold_balances.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_order.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_orders.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_orders_by_user.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_payout_info_batch.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_products.proto";
+import "reddit/xpaymentsplatform/payapi/v1/get_user_profiles.proto";
+import "reddit/xpaymentsplatform/payapi/v1/refund_order.proto";
+import "reddit/xpaymentsplatform/payapi/v1/upsert_products.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+service PayApiService {
+  rpc AcknowledgeOrderDelivery(AcknowledgeOrderDeliveryRequest) returns (AcknowledgeOrderDeliveryResponse) {}
+
+  rpc Checkout(CheckoutRequest) returns (CheckoutResponse) {}
+
+  rpc CheckoutDevvitProducts(CheckoutDevvitProductsRequest) returns (CheckoutDevvitProductsResponse) {}
+
+  rpc DeleteProducts(DeleteProductsRequest) returns (DeleteProductsResponse) {}
+
+  rpc GetBatchProducts(GetBatchProductsRequest) returns (GetBatchProductsResponse) {}
+
+  rpc GetGoldBalances(GetGoldBalancesRequest) returns (GetGoldBalancesResponse) {}
+
+  rpc GetOrder(GetOrderRequest) returns (GetOrderResponse) {}
+
+  rpc GetPayoutInfoBatch(GetPayoutInfoBatchRequest) returns (GetPayoutInfoBatchResponse) {}
+
+  rpc GetProducts(GetProductsRequest) returns (GetProductsResponse) {}
+
+  rpc GetUserProfiles(GetUserProfilesRequest) returns (GetUserProfilesResponse) {}
+
+  rpc GetOrders(GetOrdersRequest) returns (GetOrdersResponse) {}
+
+  rpc GetOrdersByUser(GetOrdersByUserRequest) returns (GetOrdersByUserResponse) {}
+
+  rpc RefundOrder(RefundOrderRequest) returns (RefundOrderResponse) {}
+
+  rpc UpsertProducts(UpsertProductsRequest) returns (UpsertProductsResponse) {}
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service_data_compliance.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message DeleteUsersDataRequest {
+  repeated string user_ids = 1; // The user IDs to delete data for
+  CallerID caller_id = 99;
+}
+
+message DeleteUsersDataResponse {
+  repeated string user_ids = 1; // The user IDs that were successfully deleted
+}
+
+service DataComplianceService {
+  rpc DeleteUsersData(DeleteUsersDataRequest) returns (DeleteUsersDataResponse) {}
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/upsert_products.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payapi.v1;
+
+import "reddit/xpaymentsplatform/payapi/v1/common.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-api/api/xpaymentsplatform/payapipb/v1;payapipb";
+
+message UpsertProductsRequest {
+  CallerID caller_id = 1;
+  Environment environment = 2; // It must match the environment of the products.
+  repeated Product products = 3;
+}
+
+message UpsertProductsResponse {
+  repeated Product products = 1; // These are the products that were successfully upserted.
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paygatewaypsps/v1/paygatewaypsps.proto

@@ -0,0 +1,158 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.paygatewaypsps.v1;
+
+import "google/protobuf/timestamp.proto";
+import "products-api/protos/reddit/xpaymentsplatform/payproducts/v1/currencies.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-gateway-psps/gateway-api/api/xpaymentsplatform/paygatewaypspspb/v1;paygatewaypspspb";
+
+enum PaymentProvider {
+  PAYMENT_PROVIDER_UNSPECIFIED = 0;
+  PAYMENT_PROVIDER_GOOGLE = 1;
+  PAYMENT_PROVIDER_STRIPE = 2;
+}
+
+enum Environment {
+  ENVIRONMENT_UNSPECIFIED = 0;
+  ENVIRONMENT_SANDBOX = 1;
+  ENVIRONMENT_PRODUCTION = 2;
+}
+
+enum PaymentStatus {
+  PAYMENT_STATUS_UNSPECIFIED = 0;
+  PAYMENT_STATUS_SUCCESS = 1;
+  PAYMENT_STATUS_CANCELED = 2;
+  PAYMENT_STATUS_PROCESSING = 3;
+  PAYMENT_STATUS_REQUIRES_PAYMENT_METHOD = 4;
+}
+
+enum RefundStatus {
+  REFUND_STATUS_UNSPECIFIED = 0;
+  REFUND_STATUS_PENDING = 1;
+  REFUND_STATUS_REQUIRES_ACTION = 2;
+  REFUND_STATUS_SUCCEEDED = 3;
+  REFUND_STATUS_FAILED = 4;
+  REFUND_STATUS_CANCELED = 5;
+}
+
+enum AcknowledgementState {
+  ACKNOWLEDGEMENT_STATE_UNSPECIFIED = 0;
+  ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED = 1;
+  ACKNOWLEDGEMENT_STATE_UNACKNOWLEDGED = 2;
+}
+
+message AcknowledgeDeliveryRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string package_name = 3;
+  string product_id = 4;
+  string purchase_token = 5;
+}
+
+message AcknowledgeDeliveryResponse {}
+
+message CreateProfileRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string email = 3;
+  string metadata = 4; // JSON to attach to the profile TODO: currently unused
+}
+
+message CreateProfileResponse {
+  string profile_id = 1;
+}
+
+message CreateClientTokenRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_unit_id = 3; // idempotency key
+  int64 price = 4;
+  string statement_descriptor = 5;
+  PaymentProfile profile = 6;
+  string metadata = 7; // JSON to attach to the receipt TODO: currently unused
+  reddit.xpaymentsplatform.payproducts.v1.Currency currency = 8;
+}
+
+message PaymentProfile {
+  string email = 1;
+  string provider_id = 2;
+}
+
+message CreateClientTokenResponse {
+  string payment_id = 1;
+  string token = 2;
+  PaymentStatus status = 3;
+}
+
+message GetPaymentStatusRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3;
+  string package_name = 4;
+  string product_id = 5;
+  string purchase_token = 6;
+}
+
+message GetPaymentStatusResponse {
+  PaymentStatus status = 1;
+}
+
+message RefundRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3;
+}
+
+message RefundResponse {
+  string refund_id = 1;
+  RefundStatus status = 2;
+}
+
+message GetProductPurchaseRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string package_name = 3;
+  string product_id = 4;
+  string purchase_token = 5;
+}
+
+message GetProductPurchaseResponse {
+  string order_id = 1;
+  PaymentStatus purchase_state = 2;
+  google.protobuf.Timestamp purchase_time = 3;
+  AcknowledgementState acknowledgement_state = 4;
+  string purchase_token = 5;
+  string product_id = 6;
+  string region_code = 7; // ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted
+}
+
+message GetProductRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string package_name = 3;
+  string product_id = 4;
+}
+
+message GetProductResponse {
+  string product_id = 1;
+  string price = 2; // Price in 1/million of the currency base unit, represented as a string
+  reddit.xpaymentsplatform.payproducts.v1.Currency currency = 3;
+}
+
+service PayGatewayPSPsService {
+  rpc AcknowledgeDelivery(AcknowledgeDeliveryRequest) returns (AcknowledgeDeliveryResponse) {}
+  rpc CreateProfile(CreateProfileRequest) returns (CreateProfileResponse) {}
+  rpc CreateClientToken(CreateClientTokenRequest) returns (CreateClientTokenResponse) {}
+  rpc GetPaymentStatus(GetPaymentStatusRequest) returns (GetPaymentStatusResponse) {}
+  rpc Refund(RefundRequest) returns (RefundResponse) {}
+  rpc GetProductPurchase(GetProductPurchaseRequest) returns (GetProductPurchaseResponse) {}
+  rpc GetProduct(GetProductRequest) returns (GetProductResponse) {}
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payments_data_compliance.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+message DeleteUsersDataRequest {
+  string requester_id = 1;
+  repeated string user_ids = 2;
+}
+
+message DeleteUsersDataResponse {
+  repeated string user_ids = 1;
+}
+
+service DataComplianceService {
+  rpc DeleteUsersData(DeleteUsersDataRequest) returns (DeleteUsersDataResponse) {}
+}

package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payorders.proto

@@ -0,0 +1,195 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/paypayments/v1/paypayments.proto";
+import "reddit/xpaymentsplatform/payproducts/v1/payproducts.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+enum OrderStatus {
+  ORDER_STATUS_UNSPECIFIED = 0;
+
+  NEW = 1;
+  CREATED = 2;
+  PAID = 3;
+  DELIVERED = 4;
+  CANCELED = 5; // [Before payment] Reddit decides to cancel a checkout before it was paid.
+  REVERTED = 6; // [After payment] Refund, chargeback.
+}
+
+enum StatusReason {
+  STATUS_REASON_UNSPECIFIED = 0;
+
+  REFUND_REDDIT_ADMIN = 1;
+  REFUND_PAYMENT_PLATFORM_INTERNAL = 2;
+  REFUND_PRODUCT_OWNER = 3;
+
+  CHARGEBACK = 4;
+
+  EXPIRED_INTERNAL_ERROR = 5;
+  EXPIRED_NOT_PAID = 6;
+  EXPIRED_NOT_DELIVERED = 7;
+
+  ECON_BLOCKER_VALIDATION_FAILED = 8;
+}
+
+message CheckoutAction {
+  reddit.xpaymentsplatform.paypayments.v1.PaymentMode mode = 1;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider payment_provider = 2;
+  string client_token = 3;
+}
+
+message ProductCheckoutMetadata {
+  bool is_anonymous = 1; // If the true, buyer info can't be shown to the seller.
+  string raw_client_metadata = 100; // The raw metadata sent by the client. Payment Platform will not interpret it.
+}
+
+message CartItem {
+  reddit.xpaymentsplatform.payproducts.v1.Product product = 1;
+  ProductCheckoutMetadata product_checkout_metadata = 2;
+}
+
+message Order {
+  string id = 1;
+  OrderStatus status = 2;
+  google.protobuf.Timestamp created_at = 3;
+  google.protobuf.Timestamp updated_at = 4;
+
+  repeated CartItem cart_items = 5;
+
+  CheckoutAction checkout_action = 6; // Each order has only one checkout possible
+  optional StatusReason status_reason = 7; // Set only if status == CANCELED or REVERTED
+
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 8;
+}
+
+message GetOrderRequest {
+  string order_id = 1;
+}
+
+message GetOrderResponse {
+  Order order = 1;
+}
+
+message GetOrdersRequest {
+  repeated string order_ids = 1; // the order ids filter
+  string seller_id = 2; // t2_id of the app account
+  string buyer_id = 3; // t2_id of the buyer
+  google.protobuf.Timestamp created_at_start = 4; // the start of the time range
+  google.protobuf.Timestamp created_at_end = 5; // the end of the time range
+  OrderStatus status = 6; // the status filter of the order
+  map<string, string> checkout_metadata = 7; // the metadata filter of the order
+  PageInfo page_info = 20;
+}
+
+message GetOrdersResponse {
+  repeated Order orders = 1;
+  PageInfo next_page = 2;
+}
+
+// Required to support pagination of GetOrders.
+message PageInfo {
+  string start_cursor = 1; // if empty, start from the most recent transaction
+  int32 page_size = 2;
+  bool has_next_page = 3;
+}
+
+message CreateOrderRequest {
+  // Optional ID for a new order if client wants to use its own,
+  // otherwise new UUID will be generated and lower-case string representation will
+  // be used as an order ID.
+  // If order with provided ID already exists, check if:
+  // - buyerID is present, and it matches the one in the order
+  // - products are present, and they match the ones in the order
+  // return the stored order if all checks are positive. == Implementation of Order Idempotency
+  string order_id = 1;
+
+  string buyer_id = 2; // t2_Id
+
+  // It can only be [NEW, PAID]
+  // [NEW]: a new order is being created. It will require a payment
+  // [PAID]: a new order is being created. It will not require a payment
+  OrderStatus status = 3;
+
+  repeated CartItem cart_items = 4;
+
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 5;
+  // [P3] The order will expire at the given time
+  // required google.protobuf.Timestamp expiresAt = 4;
+
+  // User-scoped (buyer_id) idempotency key to provide instead of order_id if
+  // client wants to get server-generated order ID.
+  string reference_id = 6;
+}
+
+message MigrateOrdersRequest {
+  repeated MigrationOrder orders = 1;
+}
+
+message MigrationOrder {
+  string order_id = 1;
+  string buyer_id = 2;
+  OrderStatus status = 3;
+  repeated CartItem cart_items = 4;
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 5;
+  string reference_id = 6;
+  google.protobuf.Timestamp created_at = 7;
+}
+
+message MigrateOrdersResponse {}
+
+message CreateOrderResponse {
+  Order order = 1;
+}
+
+message UpdateOrderRequest {
+  string order_id = 1;
+
+  // The new status of the order. Check the state machine for allowed transitions
+  OrderStatus status = 2;
+
+  CheckoutAction checkout_action = 3;
+  optional StatusReason reason = 4;
+  repeated CartItem cart_items = 5;
+}
+
+message UpdateOrderResponse {
+  Order order = 1;
+}
+
+message AcknowledgeOrderDeliveryRequest {
+  string order_id = 1;
+}
+
+message AcknowledgeOrderDeliveryResponse {}
+
+message GetOrdersByUserRequest {
+  string user_id = 1;
+  optional int32 limit = 2;
+}
+
+message GetOrdersByUserResponse {
+  repeated Order orders = 1;
+}
+
+service PayOrdersService {
+  // Same as public APIs
+  rpc GetOrder(GetOrderRequest) returns (GetOrderResponse) {}
+
+  rpc GetOrders(GetOrdersRequest) returns (GetOrdersResponse) {}
+
+  rpc CreateOrder(CreateOrderRequest) returns (CreateOrderResponse) {}
+
+  rpc MigrateOrders(MigrateOrdersRequest) returns (MigrateOrdersResponse) {}
+
+  // The update will be executed only if the update complies with the state machine
+  // To be used for CANCELATION and REFUND
+  rpc UpdateOrder(UpdateOrderRequest) returns (UpdateOrderResponse) {}
+
+  rpc AcknowledgeOrderDelivery(AcknowledgeOrderDeliveryRequest) returns (AcknowledgeOrderDeliveryResponse) {}
+
+  // should only be used by admin panel
+  rpc GetOrdersByUser(GetOrdersByUserRequest) returns (GetOrdersByUserResponse) {}
+}