@alexochihua/protos 1.0.0

package/proto/kapital/payments/v1/payments.proto

@@ -0,0 +1,94 @@
+syntax = "proto3";
+
+package kapital.payments.v1;
+
+option go_package = "kapital/payments/v1;paymentsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/payments/v1/payments_types.proto";
+
+service PaymentsService {
+	rpc GetExistsContract (GetExistsContractRequest) returns (GetExistsContractResponse);
+	rpc CreatePayment (CreatePaymentRequest) returns (CreatePaymentResponse);
+  rpc GetPaymentHistory (GetPaymentHistoryRequest) returns (GetPaymentHistoryResponse);
+}
+
+// ================== GetExistsContract ==================
+message GetExistsContractRequest {
+  string contract_id = 1;
+}
+
+message GetExistsContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string contract_id = 2;
+  bool exists = 3;
+}
+
+// ================== CreatePayment ==================
+message CreatePaymentRequest {
+  string contract_id = 1;
+
+  string transaction_id = 2;
+  double amount = 3;
+  string type = 4;
+  string description = 5;
+  string location = 6;
+  int32 location_type = 7;
+  double provider_assessed_fee = 8;
+  int32 verify_only = 9;
+  string merchant_id = 10;
+  string partner = 11;
+  string retail_chain = 12;
+  string retail_sale_transaction_key = 13;
+  string store_address_1 = 14;
+  string store_address_2 = 15;
+  string store_latitude = 16;
+  string store_longitude = 17;
+  string store_number = 18;
+  string store_name = 19;
+  string store_transaction_date = 20;
+  string store_city = 21;
+  string store_zip = 22;
+  double hold_amount = 23;
+  string hold_expiration_date_time = 24;
+  string hold_description = 25;
+  string hold_external_id = 26;
+  string reference_id = 27;
+  string originator_name = 28;
+  string receiver_name = 29;
+}
+
+message CreatePaymentResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  double old_balance = 2;
+  double new_balance = 3;
+  string fee_amount = 4;
+  int64 payment_trans_id = 5;
+  string transaction_id = 6;
+  int64 hold_id = 7;
+}
+
+// ================== GetPaymentHistory ==================
+message GetPaymentHistoryRequest {
+  string contract_id = 1;
+
+  string provider_id = 2;
+  string transaction_id = 3;
+  string account_number = 4;
+  string start_date = 5;
+  string end_date = 6;
+  int32 include_related = 7;
+  int32 record_count = 8;
+  int32 page = 9;
+}
+
+message GetPaymentHistoryResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 transaction_count = 2;
+  int32 page = 3;
+  int32 total_record_count = 4;
+  int32 number_of_pages = 5;
+  string start_date = 6;
+  string end_date = 7;
+  repeated Payment payments = 8;
+}

package/proto/kapital/payments/v1/payments_types.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package kapital.payments.v1;
+
+option go_package = "kapital/payments/v1;paymentsv1";
+
+message Payment {
+  string pmt_id = 1;
+  string details = 2;
+  string amount = 3;
+  string timestamp = 4;
+  string source_id = 5;
+  string ach_transaction_id = 6;
+  string external_trans_id = 7;
+  string hold_days = 8;
+  string status = 9;
+  string status_description = 10;
+}

package/proto/kapital/products/v1/products.proto

@@ -0,0 +1,139 @@
+syntax = "proto3";
+
+package kapital.products.v1;
+
+option go_package = "kapital/products/v1;productsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/common/v1/pagination.proto";
+import "kapital/products/v1/products_types.proto";
+
+service ProductsService {
+  rpc GetProducts(GetProductsRequest) returns (GetProductsResponse);
+  rpc GetProductById(GetProductByIdRequest) returns (GetProductByIdResponse);
+  rpc CreateProduct(CreateProductRequest) returns (CreateProductResponse);
+  rpc UpdateProduct(UpdateProductRequest) returns (UpdateProductResponse);
+  rpc ValidateBinSubBin(ValidateBinSubBinRequest) returns (ValidateBinSubBinResponse);
+  rpc GetStatementConfig(GetStatementConfigRequest) returns (GetStatementConfigResponse);
+  rpc SaveStatementConfig(SaveStatementConfigRequest) returns (SaveStatementConfigResponse);
+}
+
+// ============================================================================
+// Request / Response Messages
+// ============================================================================
+
+message GetProductsRequest {
+  kapital.common.v1.PageRequest page_request = 1;
+  string q = 2;
+  string status = 3;
+  string name = 4;
+  string product_type = 5;
+  string brand = 6;
+  string bin = 7;
+  string sub_bin = 8;
+}
+
+message GetProductsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated Product products = 3;
+}
+
+message GetProductByIdRequest {
+  string product_id = 1;
+}
+
+message GetProductByIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Product product = 2;
+}
+
+message CreateProductRequest {
+  string name = 1;
+  string description = 2;
+  string effective_at = 3;
+  string product_type = 4;
+  string person_type = 5;
+  string brand = 6;
+  string bin = 7;
+  string sub_bin = 8;
+  string country = 9;
+  string city = 10;
+  bool multi_currency = 11;
+  repeated string currencies = 12;
+  string main_currency = 13;
+  string product_key = 14;
+  repeated CurrencyAllocation currency_allocations = 15;
+  repeated ProductRule rules = 16;
+  ProductConfigurations configurations = 17;
+  repeated string commissions = 18;
+  string created_by = 19;
+  repeated string offers = 20;
+
+}
+
+message CreateProductResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Product product = 2;
+}
+
+message UpdateProductRequest {
+  string product_id = 1;
+  string name = 2;
+  string description = 3;
+  string effective_at = 4;
+  string product_type = 5;
+  string person_type = 6;
+  string brand = 7;
+  string bin = 8;
+  string sub_bin = 9;
+  string country = 10;
+  string city = 11;
+  bool multi_currency = 12;
+  repeated string currencies = 13;
+  string main_currency = 14;
+  repeated CurrencyAllocation currency_allocations = 15;
+  repeated ProductRule rules = 16;
+  repeated string commissions = 18;
+  bool active = 19;
+  bool deleted = 20;
+  string updated_by = 21;
+  repeated string offers = 22;
+
+}
+
+message UpdateProductResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Product product = 2;
+}
+
+message ValidateBinSubBinRequest {
+  string bin = 1;
+  string sub_bin = 2;
+  string exclude_product_id = 3;
+}
+
+message ValidateBinSubBinResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  bool is_valid = 2;
+  string message = 3;
+}
+
+message GetStatementConfigRequest {
+  string product_id = 1;
+}
+
+message GetStatementConfigResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  ProductStatement statement = 2;
+}
+
+message SaveStatementConfigRequest {
+  string product_id = 1;
+  ProductStatement statement = 2;
+}
+
+message SaveStatementConfigResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  ProductStatement statement = 2;
+}

package/proto/kapital/products/v1/products_types.proto

@@ -0,0 +1,156 @@
+syntax = "proto3";
+
+package kapital.products.v1;
+
+option go_package = "kapital/products/v1;productsv1";
+
+// ============================================================================
+// Product Entity
+// ============================================================================
+
+message CurrencyAllocation {
+  string currency = 1;
+  string currency_code = 2;
+  string currency_label = 3;
+  int32 order = 4;
+  double percentage = 5;
+}
+
+message ProductRule {
+  string parameter = 1;
+  string operator = 2;
+  string value = 3;
+  double value_amount = 4;
+  double value_percentage = 5;
+  double value_number = 6;
+  repeated string value_days = 7;
+  string value_start = 8;
+  string value_end = 9;
+  repeated string value_country_groups = 10;
+  repeated string value_mcc_groups = 11;
+  repeated string value_merchant_groups = 12;
+  repeated string channels = 13;
+}
+
+message CreditConfig {
+  string credit_type = 1;
+  string rate_type = 2;
+  double min_limit = 3;
+  double max_limit = 4;
+  bool overdraft_enabled = 5;
+  string overdraft_type = 6;
+  double overdraft_amount = 7;
+  double overdraft_percentage = 8;
+  double ordinary_min_interest_rate = 9;
+  double ordinary_max_interest_rate = 10;
+  double late_interest_rate = 11;
+  double disposition_interest_rate = 12;
+  int32 delinquency_days_for_penalty = 13;
+  int32 delinquency_days_for_suspension = 14;
+  repeated int32 cutoff_days = 15;
+  int32 days_between_cutoff_and_payment = 16;
+  string refinancing_option = 17;
+  int32 decimals = 18;
+  string rounding_type = 19;
+  string min_payment_method = 20;
+}
+
+message CardSettings {
+  repeated string card_personalization = 1;
+  int32 max_cards_per_client = 2;
+}
+
+message AccessMethods {
+  bool physical_card = 1;
+  string physical_card_validity = 2;
+  bool digital_card = 3;
+  string digital_card_validity = 4;
+}
+
+message CardUsageCoverage {
+  bool national_level = 1;
+  bool international_level = 2;
+}
+
+message OriginationChannels {
+  bool branches = 1;
+  bool app = 2;
+  bool electronic_banking = 3;
+}
+
+message DispositionMethods {
+  bool branches = 1;
+  bool national_atm_network = 2;
+  bool international_atm_network = 3;
+}
+
+message PurchaseMethods {
+  bool card_present = 1;
+  bool card_not_present = 2;
+  bool ecommerce = 3;
+  bool wallet = 4;
+}
+
+message ProductConfigurations {
+  CreditConfig credit = 1;
+  CardSettings card_settings = 2;
+  AccessMethods access_methods = 3;
+  CardUsageCoverage card_usage_coverage = 4;
+  OriginationChannels origination_channels = 5;
+  DispositionMethods disposition_methods = 6;
+  PurchaseMethods purchase_methods = 7;
+}
+
+message ProductCommission {
+  repeated string application_conditions = 1;
+  string commission_type = 2;
+  string currency = 3;
+  repeated string exemptions = 4;
+  string periodicity = 5;
+  string rate_type = 6;
+  double rate_value_amount = 7;
+  double rate_value_percentage = 8;
+  bool vat_applicable = 9;
+  double vat_percentage = 10;
+}
+
+message ProductStatement {
+  string terms_and_conditions = 1;
+  string important_messages = 2;
+  string informative_notes = 3;
+  string legal_notices = 4;
+  string logo = 5;
+  string card_image = 6;
+}
+
+message Product {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  string effective_at = 4;
+  string product_type = 5;
+  string person_type = 6;
+  string brand = 7;
+  string bin = 8;
+  string sub_bin = 9;
+  string country = 10;
+  string city = 11;
+  bool multi_currency = 12;
+  repeated string currencies = 13;
+  string main_currency = 14;
+  bool active = 15;
+  string product_key = 16;
+  string currency_bin = 17;
+  repeated CurrencyAllocation currency_allocations = 18;
+  repeated ProductRule rules = 19;
+  ProductConfigurations configurations = 20;
+  repeated string commissions = 21;
+  ProductStatement statement = 22;
+  bool deleted = 23;
+  string created_by = 24;
+  string updated_by = 25;
+  string created_at = 26;
+  string updated_at = 27;
+  repeated string offers = 28;
+
+}

package/proto/kapital/transactions/v1/transactions.proto

@@ -0,0 +1,70 @@
+syntax = "proto3";
+
+package kapital.transactions.v1;
+
+option go_package = "kapital/transactions/v1;transactionsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/transactions/v1/transactions_types.proto";
+
+service TransactionsService {
+	rpc GetExistsContract (GetExistsContractRequest) returns (GetExistsContractResponse);
+	rpc GetTransactionsPosted (GetTransactionsPostedRequest) returns (GetTransactionsPostedResponse);
+  rpc GetAllTransactions (GetAllTransactionsRequest) returns (GetAllTransactionsResponse);
+}
+
+// ================== GetExistsContract ==================
+message GetExistsContractRequest {
+  string contract_id = 1;
+}
+
+message GetExistsContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string contract_id = 2;
+  bool exists = 3;
+}
+
+// ================== GetTransactionsPosted ==================
+message GetTransactionsPostedRequest {
+  string contract_id = 1;
+	string transaction_id = 2;
+  string start_date = 3;
+  string end_date = 4;
+  int32 record_count = 5;
+  int32 page = 6;
+  int32 included_related = 7;
+}
+
+message GetTransactionsPostedResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string start_date = 2;
+  string end_date = 3;
+  int32 number_of_pages = 4;
+  int32 page = 5;
+  int32 total_record_count = 6;
+  repeated Transaction transactions = 7;
+}
+
+// ================== GetAllTransactions ==================
+message GetAllTransactionsRequest {
+  string contract_id = 1;
+	string transaction_id = 2;
+  string start_date = 3;
+  string end_date = 4;
+  int32 record_count = 5;
+  int32 page = 6;
+}
+
+message GetAllTransactionsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 transaction_count = 2;
+  int32 page = 3;
+  int32 total_record_count = 4;
+  int32 number_of_pages = 5;
+  string start_date = 6;
+  string end_date = 7;
+  Sums sums = 8;
+  repeated TransactionDetail transactions = 9;
+  double beginning_balance = 10;
+}
+

package/proto/kapital/transactions/v1/transactions_types.proto

@@ -0,0 +1,91 @@
+syntax = "proto3";
+
+package kapital.transactions.v1;
+
+option go_package = "kapital/transactions/v1;transactionsv1";
+
+message TransactionDetail {
+  bool is_savings = 1;
+  string deny_code = 2;
+  bool disputable = 3;
+  string details = 4;
+  string act_type = 5;
+  string act_type_description = 6;
+  string latest_incremental_id = 7;
+  string original_incremental_id = 8;
+  string post_ts = 9;
+  double amt = 10;
+  string source_id = 11;
+  string type = 12;
+  string type_description = 13;
+  string trans_code = 14;
+  string arn = 15;
+  string merchant_id = 16;
+  string external_trans_id = 17;
+  double calculated_balance = 18;
+  string ach_trans_id = 19;
+  string auth_ts = 20;
+  string prior_id = 21;
+  string card_id = 22;
+  string formatted_merchant_desc = 23;
+  string network_code = 24;
+  string auth_id = 25;
+  double local_amt = 26;
+  string local_curr_code = 27;
+  double settle_amt = 28;
+  string settle_curr_code = 29;
+  double billing_amt = 30;
+  string billing_curr_code = 31;
+  string pmt_ref_no = 32;
+  string mcc_code = 33;
+  string credit_ind = 34;
+  double iac_tax = 35;
+  double iva_tax = 36;
+  string funding_account_prn = 37;
+  string spending_account_prn = 38;
+}
+
+message Sums {
+  double unsettled = 1;
+  double settled = 2;
+  double adjustment = 3;
+  double fee = 4;
+  double payment = 5;
+}
+
+message Transaction {
+  string pmt_ref_no = 1;
+  string act_id = 2;
+  string act_type = 3;
+  string post_ts = 4;
+  string amt = 5;
+  string details = 6;
+  string description = 7;
+  string source_id = 8;
+  string bal_id = 9;
+  string prod_id = 10;
+  string auth_ts = 11;
+  string trans_code = 12;
+  string ach_transaction_id = 13;
+  string external_trans_id = 14;
+  string original_auth_id = 15;
+  string network_code = 16;
+  string local_amt = 17;
+  string local_curr_code = 18;
+  string settle_amt = 19;
+  string settle_curr_code = 20;
+  string billing_amt = 21;
+  string billing_curr_code = 22;
+  string mcc = 23;
+  string merchant_id = 24;
+  string formatted_merchant_desc = 25;
+  string terminal_id = 26;
+  string card_id = 27;
+  string credit_ind = 28;
+  double iac_tax = 29;
+  double iva_tax = 30;
+  string funding_account_prn = 31;
+  string spending_account_prn = 32;
+  int64 original_incremental_id = 33;
+  int64 latest_incremental_id = 34;
+}