@alexochihua/protos 1.0.0

package/proto/kapital/contracts/v1/contracts_types.proto

@@ -0,0 +1,316 @@
+syntax = "proto3";
+
+package kapital.contracts.v1;
+
+option go_package = "kapital/contracts/v1;contractsv1";
+
+// ================== CreatePhysicalCardContract ==================
+message ModelResults {
+  string model_name = 1;
+  string model_version = 2;
+  string code = 3;
+  string text = 4;
+}
+
+message CIPFull {
+  string status = 1;
+  repeated ModelResults model_results = 2;
+  string date_time = 3;
+
+  string first_name = 4;
+  string middle_name = 5;
+  string last_name = 6;
+
+  string address_1 = 7;
+  string address_2 = 8;
+  string city = 9;
+  string state = 10;
+
+  string primary_phone = 11;
+  string other_phone = 12;
+
+  string entity_id = 13;
+  string customer_id = 14;
+}
+
+// ================== CreateVirtualCardContract ==================
+message CIP {
+  string status = 1;
+  repeated ModelResults model_results = 2;
+  string date_time = 3;
+
+  string first_name = 4;
+  string middle_name = 5;
+  string last_name = 6;
+
+  string address_1 = 7;
+  string address_2 = 8;
+  string city = 9;
+  string state = 10;
+
+  string primary_phone = 11;
+  string other_phone = 12;
+}
+
+// ================== UpdateContract ==================
+message Address {
+  string address_1 = 1;
+  string address_2 = 2;
+  string city = 3;
+  string state = 4;
+  string zip = 5;
+  string country_code = 6;
+}
+
+message CustomerProfile {
+  string first_name = 1;
+  string middle_name = 2;
+  string last_name = 3;
+  string preferred_name = 4;
+  string preferred_name_only_on_card = 5;
+  string address_1 = 6;
+  string address_2 = 7;
+  string city = 8;
+  string state = 9;
+  string zip = 10;
+  string country_code = 11;
+  string mobile_phone = 12;
+  string email = 13;
+  Address ship_address = 14;
+  string express_mail = 15;
+  int32 related_accounts = 16;
+  string occupation = 17;
+  string income_source = 18;
+  string embossed_line_2 = 19;
+}
+
+// ================== GetContractById ==================
+message Card {
+  string card_id = 1;
+  string card_status = 2;
+}
+
+message Contract {
+  string prn = 1;
+  string prod_id = 2;
+  string app_date = 3;
+  string status = 4;
+  string active_flag = 5;
+  double balance = 6;
+  string contract_number = 7;
+  repeated Card cards = 8;
+}
+
+// ================== GetRelatedContracts ==================
+message RelatedData {
+  string prn = 1;
+  string product_id = 2;
+  string contract_number = 3;
+  string status = 4;
+  string active = 5;
+}
+
+// ================== VerifyContract ==================
+message ContractVerify {
+  string max_load_amount = 1;
+  double balance = 2;
+  string external_account_id = 3;
+  string pmt_ref_number = 4;
+  string account_status = 5;
+  string contract_number = 6;
+  string product_id = 7;
+}
+
+// ================== SearchContracts ==================
+message ContractSearch {
+  string pmt_ref_number = 1;
+  string first_name = 2;
+  string middle_name = 3;
+  string last_name = 4;
+  string email = 5;
+  string status = 6;
+  string active = 7;
+  string contract_number = 8;
+  string product_id = 9;
+  string group_id = 10;
+  string application_date = 11;
+}
+
+// ================== GetContractData ==================
+message ContractOverview {
+  string pmt_ref_no = 1;
+  string status = 2;
+  string first_fund_date = 3;
+  string application_date = 4;
+  double balance = 5;
+  string currency_code = 6;
+  string start_date = 7;
+  string end_date = 8;
+  int32 transaction_count = 9;
+  int32 authorization_count = 10;
+  string kyc_ref_no = 11;
+  string curp = 12;
+  string political_affiliation = 13;
+  string place_of_birth = 14;
+  string nationality = 15;
+}
+
+// ================== GetCustomerProfile ==================
+
+message Profile {
+  string id = 1;
+  optional string id2 = 2;
+  optional string id3 = 3;
+
+  int32 id_type = 4;
+  optional int32 id2_type = 5;
+  optional int32 id3_type = 6;
+
+  string first_name = 7;
+  optional string middle_name = 8;
+  string last_name = 9;
+
+  optional string address_1 = 10;
+  optional string address_2 = 11;
+
+  optional string business_name = 12;
+
+  optional string city = 13;
+  string state = 14;
+  string postal_code = 15;
+  optional string country_code = 16;
+
+  optional string home_phone = 17;
+  optional string mobile_phone = 18;
+  optional string mobile_phone_country_code = 19;
+  optional int32 carrier_id = 20;
+
+  optional string email = 21;
+  optional string dob = 22;
+
+  Address ship_to_address = 23;
+
+  optional string express_mail = 24;
+  optional string occupation = 25;
+  optional string income_source = 26;
+  optional string monthly_income = 27;
+  optional string preferred_lang = 28;
+
+  string preferred_name = 29;
+}
+
+// ================== GetTransactions ==================
+message Transaction {
+  string pmt_ref_no = 1;
+  optional string act_id = 2;
+  optional string act_type = 3;
+  string mcc = 4;
+  optional string post_ts = 5;
+  string amt = 6;
+  string details = 7;
+  optional string description = 8;
+  string source_id = 9;
+  string bal_id = 10;
+  string prod_id = 11;
+  string auth_ts = 12;
+  string trans_code = 13;
+  optional string ach_transaction_id = 14;
+  optional string external_trans_id = 15;
+  optional string original_auth_id = 16;
+  optional string network_id = 17;
+  optional string local_amt = 18;
+  optional string local_curr_code = 19;
+  optional string settle_amt = 20;
+  optional string settle_curr_code = 21;
+  optional string billing_amt = 22;
+  optional string billing_curr_code = 23;
+  optional string credit_ind = 24;
+  optional double iac_tax = 25;
+  optional double iva_tax = 26;
+  optional string funding_account_prn = 27;
+  optional string spending_account_prn = 28;
+}
+
+// ================== GetAuthorizations ==================
+message Authorization {
+  string auth_id = 1;
+
+  string details = 2;
+  string details_formatted = 3;
+
+  string amount = 4;
+
+  optional string timestamp = 5;
+
+  string type = 6;
+
+  string mcc = 7;
+  string merchant_id = 8;
+  string acq_id = 9;
+  string terminal_id = 10;
+
+  string can_be_expired = 11;
+
+  optional string original_auth_id = 12;
+  optional string network_code = 13;
+
+  optional string local_amt = 14;
+  optional string local_curr_code = 15;
+
+  optional string settle_amt = 16;
+  optional string settle_curr_code = 17;
+
+  optional string billing_amt = 18;
+  optional string billing_curr_code = 19;
+
+  optional double iac_tax = 20;
+  optional double iva_tax = 21;
+
+  optional string latest_incremental_id = 22;
+  optional string original_incremental_id = 23;
+}
+
+// ================== GetPendingFees ==================
+message FeeRelatedTransaction {
+  optional string details = 1;
+  double amt = 2;
+  string post_ts = 3;
+}
+
+message PendingFee {
+  string fee_event_id = 1;
+  string type = 2;
+  string type_description = 3;
+  string amt = 4;
+  string fee_date = 5;
+  optional int64 card_id = 6;
+  string fee_description = 7;
+  optional FeeRelatedTransaction related_transaction = 8;
+}
+
+// ================== GetSavingsInterest ==================
+message SavingsInterest {
+  string start_date = 1;
+  string end_date = 2;
+  string accrual_interest = 3;
+  string interest_ytd = 4;
+  string apy = 5;
+}
+
+// ================== GetHolds ==================
+message Hold {
+  string hold_id = 1;
+  optional string create_dt = 2;
+  optional string expiry_dt = 3;
+  optional string source_id = 4;
+  optional string change_ts = 5;
+  optional string hold_type = 6;
+  optional string ext_id = 7;
+  optional string dscr = 8;
+  optional string originating_system_id = 9;
+  optional string agent_id = 10;
+  double amount = 11;
+  optional string xid = 12;
+  optional string expiring_system_id = 13;
+  optional string expiring_agent_id = 14;
+}

package/proto/kapital/credit_accounts/v1/credit_accounts.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package kapital.credit_accounts.v1;
+
+option go_package = "kapital/credit_accounts/v1;creditaccountsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/common/v1/pagination.proto";
+import "kapital/credit_accounts/v1/credit_accounts_types.proto";
+
+service CreditAccountsService {
+  rpc GetAccounts(GetAccountsRequest) returns (GetAccountsResponse);
+}
+
+message GetAccountsRequest {
+  kapital.common.v1.PageRequest page_request = 1;
+  string rfc = 2;
+  string business_name = 3;
+  string status = 4;
+  string q = 5;
+  string account = 6;
+}
+
+message GetAccountsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated Account accounts = 3;
+}

package/proto/kapital/credit_accounts/v1/credit_accounts_types.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package kapital.credit_accounts.v1;
+
+option go_package = "kapital/credit_accounts/v1;creditaccountsv1";
+
+message AccountProduct {
+  string id_short = 1;
+  string id_long = 2;
+  string product = 3;
+  string rate_selection = 4;
+  int32 allowed_cards = 5;
+  string credit_amount = 6;
+}
+
+message Account {
+  string id_short = 1;
+  string id_long = 2;
+  string account = 3;
+  string product_type = 4;
+  int32 number_cards = 5;
+  double rate = 6;
+  double available_limits = 7;
+  double balance = 8;
+  string status = 9;
+  string status_label = 10;
+  string rfc = 11;
+  string business_name = 12;
+}

package/proto/kapital/customers/v1/customers.proto

@@ -0,0 +1,235 @@
+syntax = "proto3";
+
+package kapital.customers.v1;
+
+option go_package = "kapital/customers/v1;customersv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/common/v1/pagination.proto";
+import "kapital/customers/v1/customers_types.proto";
+
+service CustomersService {
+  rpc GetCustomers(GetCustomersRequest) returns (GetCustomersResponse);
+  rpc GetCustomerById(GetCustomerByIdRequest) returns (GetCustomerByIdResponse);
+  rpc GetContractsByCustomer(GetContractsByCustomerRequest) returns (GetContractsByCustomerResponse);
+  rpc GetContractById(GetContractByIdRequest) returns (GetContractByIdResponse);
+
+  rpc GetTransactionsByContract(GetTransactionsByContractRequest) returns (GetTransactionsByContractResponse);
+  rpc GetCardsByContract(GetCardsByContractRequest) returns (GetCardsByContractResponse);
+  rpc GetCardDetail(GetCardDetailRequest) returns (GetCardDetailResponse);
+  rpc GetCardTransactions(GetCardTransactionsRequest) returns (GetCardTransactionsResponse);
+  rpc GetContractPeriods(GetContractPeriodsRequest) returns (GetContractPeriodsResponse);
+  rpc GetCardPeriods(GetCardPeriodsRequest) returns (GetCardPeriodsResponse);
+  rpc GetCustomerStatuses(GetCustomerStatusesRequest) returns (GetCustomerStatusesResponse);
+  rpc GetDelinquencyLevels(GetDelinquencyLevelsRequest) returns (GetDelinquencyLevelsResponse);
+  rpc GetContractStatuses(GetContractStatusesRequest) returns (GetContractStatusesResponse);
+  rpc GetCustomerCardStatuses(GetCustomerCardStatusesRequest) returns (GetCustomerCardStatusesResponse);
+  rpc GetCustomerProductTypes(GetCustomerProductTypesRequest) returns (GetCustomerProductTypesResponse);
+  rpc GetCustomerCardTypes(GetCustomerCardTypesRequest) returns (GetCustomerCardTypesResponse);
+  rpc GetMccs(GetMccsRequest) returns (GetMccsResponse);
+  rpc GetTransactionTypes(GetTransactionTypesRequest) returns (GetTransactionTypesResponse);
+  rpc GetTransactionChannels(GetTransactionChannelsRequest) returns (GetTransactionChannelsResponse);
+}
+
+// ============================================================================
+// Request/Response Messages
+// ============================================================================
+
+message GetCustomersRequest {
+  kapital.common.v1.PageRequest page_request = 1;
+  string q = 2;
+  string status = 3;
+  string rfc = 4;
+  string customer_number = 5;
+  string product_type = 6;
+  string product = 7;
+}
+
+message GetCustomersResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated Customer customers = 3;
+}
+
+message GetCustomerByIdRequest {
+  string customer_id = 1;
+}
+
+message GetCustomerByIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Customer customer = 2;
+}
+
+message GetContractsByCustomerRequest {
+  string customer_id = 1;
+  kapital.common.v1.PageRequest page_request = 2;
+  string q = 3;
+  string status = 4;
+  string rfc = 5;
+  string business_name = 6;
+  string product = 7;
+  string product_type = 8;
+  string card_number = 9;
+  string clabe = 10;
+}
+
+message GetContractsByCustomerResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string customer = 2;
+  kapital.common.v1.PageResponse page_response = 3;
+  repeated Contract contracts = 4;
+}
+
+message GetContractByIdRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+}
+
+message GetContractByIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Contract contract = 2;
+}
+
+message GetTransactionsByContractRequest {
+  string contract_number = 1;
+  kapital.common.v1.PageRequest page_request = 2;
+  string q = 3;
+  string status = 4;
+  string transaction_type = 5;
+  string date = 6;
+  string start_date = 7;
+  string end_date = 8;
+  string card_number = 9;
+  string merchant_number = 10;
+}
+
+message GetTransactionsByContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated Transaction transactions = 3;
+}
+
+message GetCardsByContractRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+  kapital.common.v1.PageRequest page_request = 3;
+}
+
+message GetCardsByContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated CustomerCard cards = 3;
+}
+
+message GetCardDetailRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+  string card_id = 3;
+}
+
+message GetCardDetailResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  CustomerCard card = 2;
+}
+
+message GetCardTransactionsRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+  string card_id = 3;
+  kapital.common.v1.PageRequest page_request = 4;
+}
+
+message GetCardTransactionsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  kapital.common.v1.PageResponse page_response = 2;
+  repeated Transaction transactions = 3;
+}
+
+message GetContractPeriodsRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+  kapital.common.v1.PageRequest page_request = 3;
+}
+
+message GetContractPeriodsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated Period periods = 3;
+}
+
+message GetCardPeriodsRequest {
+  string customer_id = 1;
+  string contract_id = 2;
+  string card_id = 3;
+  kapital.common.v1.PageRequest page_request = 4;
+}
+
+message GetCardPeriodsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated Period periods = 3;
+}
+
+// Catalogs
+message GetCustomerStatusesRequest {}
+message GetCustomerStatusesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetDelinquencyLevelsRequest {}
+message GetDelinquencyLevelsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetContractStatusesRequest {}
+message GetContractStatusesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetCustomerCardStatusesRequest {}
+message GetCustomerCardStatusesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetCustomerProductTypesRequest {}
+message GetCustomerProductTypesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetCustomerCardTypesRequest {}
+message GetCustomerCardTypesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetMccsRequest {}
+message GetMccsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetTransactionTypesRequest {}
+message GetTransactionTypesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}
+
+message GetTransactionChannelsRequest {}
+message GetTransactionChannelsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 total = 2;
+  repeated CatalogItem items = 3;
+}

package/proto/kapital/customers/v1/customers_types.proto

@@ -0,0 +1,87 @@
+syntax = "proto3";
+
+package kapital.customers.v1;
+
+option go_package = "kapital/customers/v1;customersv1";
+
+message Customer {
+  string id_short = 1;
+  string id_long = 2;
+  string customer_number = 3;
+  string business_name = 4;
+  string customer_name = 5;
+  string rfc = 6;
+  string curp = 7;
+  string status = 8;
+  string delinquency = 9;
+  string risk_status = 10;
+  string credit_rating = 11;
+  string registration_date = 12;
+  string address = 13;
+  string phone = 14;
+  string email = 15;
+  string assigned_branch = 16;
+  bool has_credit_contracts = 17;
+}
+
+message Contract {
+  string id_short = 1;
+  string id_long = 2;
+  string contract_number = 3;
+  string clabe = 4;
+  string product = 5;
+  string product_type = 6;
+  int32 number_cards = 7;
+  double rate = 8;
+  string status = 9;
+  string delinquency = 10;
+  int32 delinquency_days = 11;
+  int32 cutoff_day = 12;
+  string payment_due_date = 13;
+  double available_limit = 14;
+  double available_balance = 15;
+  double total_balance = 16;
+  double cutoff_debt_balance = 17;
+  double current_debt_balance = 18;
+  int32 transactions_per_period = 19;
+  string rfc = 20;
+  string business_name = 21;
+  string customer_name = 22;
+  string primary_card = 23;
+}
+
+message Transaction {
+  string id_short = 1;
+  string id_long = 2;
+  string transaction_number = 3;
+  string transaction_type = 4;
+  string transaction_channel = 5;
+  string concept = 6;
+  double amount = 7;
+  string transaction_date = 8;
+  string card_number = 9;
+  string merchant_number = 10;
+  string merchant_name = 11;
+  string status = 12;
+}
+
+message CustomerCard {
+  string id_short = 1;
+  string id_long = 2;
+  string card_number = 3;
+  string card_type = 4;
+  string status = 5;
+  string expiration_date = 6;
+}
+
+message Period {
+  string id = 1;
+  string period = 2;
+  string start_date = 3;
+  string end_date = 4;
+}
+
+message CatalogItem {
+  string value = 1;
+  string label = 2;
+}