@alexochihua/protos 1.0.0

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

@@ -0,0 +1,629 @@
+syntax = "proto3";
+
+package kapital.contracts.v1;
+
+option go_package = "kapital/contracts/v1;contractsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/contracts/v1/contracts_types.proto";
+
+service ContractsService {
+	rpc CreateContract (CreateContractRequest) returns (CreateContractResponse);
+	rpc CreatePhysicalCardContract (CreatePhysicalCardContractRequest) returns (CreatePhysicalCardContractResponse);
+  rpc CreateVirtualCardContract (CreateVirtualCardContractRequest) returns (CreateVirtualCardContractResponse);
+	rpc GetExistsContract (GetExistsContractRequest) returns (GetExistsContractResponse);
+	rpc AddBalance (AddBalanceRequest) returns (AddBalanceResponse);
+  rpc GetBalance (GetBalanceRequest) returns (GetBalanceResponse);
+	rpc GetCustomerIdByContractId (GetCustomerIdByContractIdRequest) returns (GetCustomerIdByContractIdResponse);
+	rpc UpdateContract (UpdateContractRequest) returns (UpdateContractResponse);
+	rpc GetExistsCustomer (GetExistsCustomerRequest) returns (GetExistsCustomerResponse);
+	rpc GetContractById (GetContractByIdRequest) returns (GetContractByIdResponse);
+	rpc GetRelatedContracts (GetRelatedContractsRequest) returns (GetRelatedContractsResponse);
+	rpc VerifyContract (VerifyContractRequest) returns (VerifyContractResponse);
+	rpc AddContract (AddContractRequest) returns (AddContractResponse);
+	rpc SearchContracts (SearchContractsRequest) returns (SearchContractsResponse);
+	rpc ChargeOffContract (ChargeOffContractRequest) returns (ChargeOffContractResponse);
+	rpc GetContractData (GetContractDataRequest) returns (GetContractDataResponse);
+  rpc GetCustomerProfile (GetCustomerProfileRequest) returns (GetCustomerProfileResponse);
+	rpc GetTransactions (GetTransactionsRequest) returns (GetTransactionsResponse);
+	rpc GetAuthorizations (GetAuthorizationsRequest) returns (GetAuthorizationsResponse);
+	rpc GetPendingFees (GetPendingFeesRequest) returns (GetPendingFeesResponse);
+	rpc GetSavingsInterest (GetSavingsInterestRequest) returns (GetSavingsInterestResponse);
+	rpc GetHolds (GetHoldsRequest) returns (GetHoldsResponse);
+}
+
+// ================== CreateContract ==================
+message CreateContractRequest {
+  string customer_id = 1;
+  string first_name = 2;
+  optional string middle_name = 3;
+  string last_name = 4;
+  string date_of_birth = 5;
+
+  string address_1 = 6;
+  string address_2 = 7;
+  string address_3 = 8;
+  string city = 9;
+  string state = 10;
+  string postal_code = 11;
+  string country_code = 12;
+
+  string primary_phone = 13;
+  optional string other_phone = 14;
+
+  string email = 15;
+
+  string income_source = 16;
+  string curp = 17;
+  string rfc = 18;
+
+  optional string external_customer_id = 19;
+
+  int32 prod_id = 20;
+  string product_type = 21;
+  string load_amount = 22;
+  optional string load_amount_physical = 23;
+
+  optional string load_type = 24;
+  optional string primary_account = 25;
+  optional string funding_account_number = 26;
+  optional int32 shared_balance = 27;
+
+  optional string authorized_user = 28;
+  optional string user_data = 29;
+  optional string offline = 30;
+
+  optional int32 verify_only = 31;
+  optional string cip_status = 32;
+
+  optional string emboss_line_2 = 33;
+
+  optional double provider_assessed_fee = 34;
+
+  optional string load_from_account = 35;
+  optional string sweep_date = 36;
+
+  optional string express_mail = 37;
+
+  optional string ship_adress_permanent = 38;
+  optional string ship_adress_1 = 39;
+  optional string ship_adress_2 = 40;
+  optional string shitp_city = 41;
+  optional string ship_state = 42;
+  optional string ship_zip = 43;
+  optional string ship_country_code = 44;
+
+  optional string business_name = 45;
+}
+
+message CreateContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string product_id = 3;
+  string contract_number = 4;
+
+  repeated CIPFull cip = 5;
+
+  string card_number_virtual = 6;
+  string card_number_physical = 7;
+  string new_emboss_uuid = 8;
+
+  string expiry_date = 9;
+  string card_security_code = 10;
+  string emboss_line_2 = 11;
+
+  int32 billing_cycle_day = 12;
+}
+
+// ================== CreatePhysicalCardContract ==================
+message CreatePhysicalCardContractRequest {
+  string customer_id = 1;
+  string first_name = 2;
+  optional string middle_name = 3;
+  string last_name = 4;
+  string date_of_birth = 5;
+
+  string address_1 = 6;
+  string address_2 = 7;
+  string address_3 = 8;
+  string city = 9;
+  string state = 10;
+  string postal_code = 11;
+  string country_code = 12;
+
+  string primary_phone = 13;
+  optional string other_phone = 14;
+
+  string email = 15;
+
+  string income_source = 16;
+  string curp = 17;
+  string rfc = 18;
+
+  optional string external_customer_id = 19;
+
+  int32 prod_id = 20;
+  string product_type = 21;
+  string load_amount = 22;
+  optional string load_amount_physical = 23;
+
+  optional string load_type = 24;
+  optional string primary_account = 25;
+  optional string funding_account_number = 26;
+  optional int32 shared_balance = 27;
+
+  optional string authorized_user = 28;
+  optional string user_data = 29;
+  optional string offline = 30;
+
+  optional int32 verify_only = 31;
+  optional string cip_status = 32;
+
+  optional string emboss_line_2 = 33;
+
+  optional double provider_assessed_fee = 34;
+
+  optional string load_from_account = 35;
+  optional string sweep_date = 36;
+
+  optional string express_mail = 37;
+
+  optional string ship_adress_permanent = 38;
+  optional string ship_adress_1 = 39;
+  optional string ship_adress_2 = 40;
+  optional string shitp_city = 41;
+  optional string ship_state = 42;
+  optional string ship_zip = 43;
+  optional string ship_country_code = 44;
+
+  optional string business_name = 45;
+}
+
+message CreatePhysicalCardContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string product_id = 3;
+  string contract_number = 4;
+
+  repeated CIPFull cip = 5;
+
+  string card_number_virtual = 6;
+  string card_number_physical = 7;
+  string new_emboss_uuid = 8;
+
+  string expiry_date = 9;
+  string card_security_code = 10;
+  string emboss_line_2 = 11;
+
+  int32 billing_cycle_day = 12;
+}
+
+// ================== CreateVirtualCardContract ==================
+message CreateVirtualCardContractRequest {
+  string provider_id = 1;
+  string transaction_id = 2;
+
+  int32 prod_id = 3;
+
+  int32 id_type = 4;
+  string id = 5;
+
+  int32 id_type_2 = 6;
+  string id_2 = 7;
+
+  string locale = 8;
+
+  string first_name = 9;
+  string middle_name = 10;
+  string last_name = 11;
+  string date_of_birth = 12;
+
+  string address_1 = 13;
+  string address_2 = 14;
+  string address_3 = 15;
+  string address_4 = 16;
+  string address_5 = 17;
+
+  string city = 18;
+  string state = 19;
+  string zip = 20;
+  string country_code = 21;
+
+  string primary_phone = 22;
+  string other_phone = 23;
+  string mobile_phone = 24;
+  string mobile_carrier_id = 25;
+
+  string email = 26;
+
+  string secret_question = 27;
+  string secret_answer = 28;
+
+  double load_amount = 29;
+  string load_type = 30;
+
+  string external_account_id = 31;
+  string primary_account = 32;
+
+  int32 shared_balance = 33;
+
+  string user_data = 34;
+
+  int32 verify_only = 35;
+
+  string load_from_account = 36;
+  string sweep_date = 37;
+
+  double credit_limit = 38;
+
+  string single_use = 39;
+
+  string business_name = 40;
+
+  string mobile_phone_country_code = 41;
+}
+
+message CreateVirtualCardContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string product_id = 3;
+  string contract_number = 4;
+
+  string card_id = 5;
+  string card_number = 6;
+  string expiry_date = 7;
+  string card_security_code = 8;
+
+  repeated CIP cip = 9;
+
+  int32 billing_cycle_day = 10;
+}
+
+// ================== GetExistsContract ==================
+message GetExistsContractRequest {
+	string contract_id = 1;
+}
+
+message GetExistsContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string contract_id = 2;
+  bool exists = 3;
+}
+
+// ================== AddBalance ==================
+message AddBalanceRequest {
+	string contract_id = 1;
+  double amount = 2; 
+}
+
+message AddBalanceResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string contract_id = 2;
+  double balance = 3;
+}
+
+// ================== GetBalance ==================
+message GetBalanceRequest {
+	string contract_id = 1;
+}
+
+message GetBalanceResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  double ledger_balance = 2;
+  double balance = 3;
+  string balance_without_pending = 4;
+  string currency_code = 5;
+  double pending_adjustments = 6;
+  double pending_billpay = 7;
+  double pending_purchase = 8;
+  double balance_without_auths = 9;
+}
+
+// ================== GetCustomerIdByContractId ==================
+message GetCustomerIdByContractIdRequest {
+  string contract_id = 1;
+}
+
+message GetCustomerIdByContractIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string customer_id = 2;
+  bool exists = 3;
+}
+
+// ================== UpdateContract ==================
+message UpdateContractRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+
+  int32 id_type = 4;
+  string id = 5;
+
+  int32 id_type_2 = 6;
+  string id_2 = 7;
+
+  int32 id_type_3 = 8;
+  string id_3 = 9;
+
+  int32 location_type = 10;
+  string location = 11;
+  string locale = 12;
+
+  string external_account_id = 13;
+
+  string first_name = 14;
+  string middle_name = 15;
+  string last_name = 16;
+  string date_of_birth = 17;
+
+  string address_1 = 18;
+  string address_2 = 19;
+  string address_3 = 20;
+  string address_4 = 21;
+  string address_5 = 22;
+
+  string city = 23;
+  string state = 24;
+  string zip = 25;
+  string country_code = 26;
+
+  string primary_phone = 27;
+  string other_phone = 28;
+  string mobile_phone = 29;
+  string mobile_carrier_id = 30;
+
+  string email = 31;
+
+  string secret_question = 32;
+  string secret_answer = 33;
+
+  string income_source = 34;
+  string occupation = 35;
+
+  string nationality = 36;
+  string place_of_birth = 37;
+  string curp = 38;
+
+  int32 political_affiliation = 39;
+
+  string key_ref_number = 40;
+  double monthly_income = 41;
+
+  string external_customer_id = 42;
+
+  string mail_bounced = 43;
+
+  string shipping_address_1 = 44;
+  string shipping_address_2 = 45;
+  string shipping_city = 46;
+  string shipping_state = 47;
+  string shipping_zip = 48;
+  string shipping_country_code = 49;
+  string shipping_address_permanent = 50;
+
+  string emboss_line_2 = 51;
+  string business_name = 52;
+
+  string mobile_phone_country_code = 53;
+}
+
+message UpdateContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  CustomerProfile customer_profile = 2;
+}
+
+// ================== GetExistsCustomer ==================
+message GetExistsCustomerRequest {
+  string customer_id = 1;
+}
+
+message GetExistsCustomerResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string customer_id = 2;
+  bool exists = 3;
+}
+
+// ================== GetContractById ==================
+message GetContractByIdRequest {
+  string customer_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  int32 id_type = 4;
+  string external_customer_id = 5;
+}
+
+message GetContractByIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated Contract contracts = 2;
+}
+
+// ================== GetRelatedContracts ==================
+message GetRelatedContractsRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+}
+
+message GetRelatedContractsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated RelatedData self_contracts = 2;
+  repeated RelatedData child_contracts = 3;
+  repeated RelatedData parent_contracts = 4;
+  repeated RelatedData sibling_contracts = 5;
+}
+
+// ================== VerifyContract ==================
+message VerifyContractRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  string load_type = 4;
+  int32 included_related = 5;
+}
+
+message VerifyContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  ContractVerify contract = 2;
+}
+
+// ================== AddContract ==================
+message AddContractRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  int32 prod_id = 4;
+  string location = 5;
+  int32 location_type = 6;
+  int32 shared_balance = 7;
+  string funding_account_number = 8;
+}
+
+message AddContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string product_id = 3;
+  string contract_number = 4;
+  string card_id = 5;
+  string card_number = 6;
+  string expiry_date = 7;
+  string card_security_code = 8;
+  string emboss_line_2 = 9;
+  int32 billing_cycle_day = 10;
+}
+
+// ================== SearchContracts ==================
+message SearchContractsRequest {
+  string provider_id = 1;
+  string transaction_id = 2;
+  optional string account_number = 3;
+  optional string first_name = 4;
+  optional string middle_name = 5;
+  optional string last_name = 6;
+  optional string date_of_birth = 7;
+  optional string zip = 8;
+  optional string primary_phone = 9;
+  optional string other_phone = 10;
+  optional string mobile_phone = 11;
+  optional string email = 12;
+  optional string user_data = 13;
+  optional string eext_id = 14;
+  optional int32 record_cnt = 15;
+  optional int32 page = 16;
+  optional string mobile_phone_country_code = 17;
+}
+
+message SearchContractsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  int32 page = 2;
+  int32 total_record_count = 3;
+  int32 number_of_pages = 4;
+  repeated ContractSearch contracts = 5;
+}
+
+// ================== ChargeOffContract ==================
+message ChargeOffContractRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  string charge_off_details = 4;
+  optional int32 close_associated_accounts = 5;
+}
+
+message ChargeOffContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  bool charged_off = 2;
+}
+
+// ================== GetContractData ==================
+message GetContractDataRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetContractDataResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  ContractOverview contract = 2;
+}
+
+// ================== GetCustomerProfile ==================
+message GetCustomerProfileRequest {
+  string customer_id = 1;
+}
+
+message GetCustomerProfileResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  Profile profile = 2;
+}
+
+// ================== GetTransactions ==================
+message GetTransactionsRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetTransactionsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated Transaction transactions = 2;
+}
+
+// ================== GetAuthorizations ==================
+message GetAuthorizationsRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetAuthorizationsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated Authorization authorizations = 2;
+}
+
+// ================== GetPendingFees ==================
+message GetPendingFeesRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetPendingFeesResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated PendingFee pending_fees = 2;
+}
+
+// ================== GetSavingsInterest ==================
+message GetSavingsInterestRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetSavingsInterestResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  SavingsInterest saving_interest = 2;
+}
+
+// ================== GetHolds ==================
+message GetHoldsRequest {
+  string contract_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string start_date = 4;
+  optional string end_date = 5;
+}
+
+message GetHoldsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  repeated Hold holds = 2;
+}