@alexochihua/protos 1.0.0

package/proto/kapital/cards/v1/cards.proto

@@ -0,0 +1,298 @@
+syntax = "proto3";
+
+package kapital.cards.v1;
+
+option go_package = "kapital/cards/v1;cardsv1";
+
+import "kapital/common/v1/meta.proto";
+import "kapital/cards/v1/cards_types.proto";
+
+service CardsService {
+  rpc GetExistsCustomer (GetExistsCustomerRequest) returns (GetExistsCustomerResponse);
+  rpc GetExistsContract (GetExistsContractRequest) returns (GetExistsContractResponse);
+  rpc GetExistsCard (GetExistsCardRequest) returns (GetExistsCardResponse);
+  rpc GetContractCards (GetContractCardsRequest) returns (GetContractCardsResponse);
+  rpc GetCard (GetCardRequest) returns (GetCardResponse);
+  rpc ActivateCard (ActivateCardRequest) returns (ActivateCardResponse);
+  rpc ReplaceLostStolenCard (ReplaceLostStolenCardRequest) returns (ReplaceLostStolenCardResponse);
+  rpc VerifyCvv (VerifyCvvRequest) returns (VerifyCvvResponse);
+  rpc VoidAddCard (VoidAddCardRequest) returns (VoidAddCardResponse);
+  rpc ReissueCard (ReissueCardRequest) returns (ReissueCardResponse);
+  rpc CreateSingleUseVirtualCard (CreateSingleUseVirtualCardRequest) returns (CreateSingleUseVirtualCardResponse);
+  rpc ModifyContract (ModifyContractRequest) returns (ModifyContractResponse);
+  rpc GetCardId (GetCardIdRequest) returns (GetCardIdResponse);
+  rpc ModifyCard (ModifyCardRequest) returns (ModifyCardResponse);
+  rpc ModifyContractAndCard (ModifyContractAndCardRequest) returns (ModifyContractAndCardResponse);
+  rpc GetCardPinChangeKey (GetCardPinChangeKeyRequest) returns (GetCardPinChangeKeyResponse);
+}
+
+// ================== GetExistsCustomer ==================
+message GetExistsCustomerRequest {
+  string customer_id = 1;
+}
+
+message GetExistsCustomerResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string customer_id = 2;
+  bool exists = 3;
+}
+
+// ================== GetExistsContract ==================
+message GetExistsContractRequest {
+  string contract_id = 1;
+}
+
+message GetExistsContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string contract_id = 2;
+  bool exists = 3;
+}
+
+// ================== GetExistsCard ==================
+message GetExistsCardRequest {
+  string card_id = 1;
+}
+
+message GetExistsCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string card_id = 2;
+  bool exists = 3;
+}
+
+// ================== GetContractCards ==================
+message GetContractCardsRequest {
+  string customer_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional int32 included_related = 4;
+}
+
+message GetContractCardsResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  CustomerContractCards customer = 2;
+  repeated CardContractCards contracts = 3;
+}
+
+// ================== GetCard ==================
+message GetCardRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+}
+
+message GetCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string card_number = 2;
+  optional string expiry_date = 3;
+  optional string card_security_code = 4;
+  string status = 5;
+  string card_id = 6;
+  optional string external_card_id = 7;
+  string pmt_ref_no = 8;
+  optional string first_name = 9;
+  optional string middle_name = 10;
+  optional string last_name = 11;
+  optional string encrypted_card_number = 12;
+  optional string encrypted_expiry_date = 13;
+  optional string emboss_uuid = 14;
+  repeated EmbossedCard embossed_cards = 15;
+  FreezeInfo freeze_info = 16;
+  optional string pin_fail_count = 17;
+  optional string pin_fail_date = 18;
+  SpendControls spend_controls = 19;
+  optional string ssn = 20;
+  optional string card_format = 21;
+  optional string card_type = 22;
+  optional string address_1 = 23;
+  optional string address_2 = 24;
+  optional string city = 25;
+  optional string state = 26;
+  optional string postal_code = 27;
+  optional string country_code = 28;
+  optional string preferred_name = 29;
+}
+
+// ================== ActivateCard ==================
+message ActivateCardRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string card_expiry_date = 4;
+  optional string card_security_code = 5;
+  optional string card_number_last_4 = 6;
+  optional int32 deactivate_temporary_cards = 7;
+}
+
+message ActivateCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string card_number_last_4 = 2;
+  string emboss_uuid = 3;
+}
+
+// ================== ReplaceLostStolenCard ==================
+message ReplaceLostStolenCardRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string by_pass_rep_fee = 4;
+  optional string card_status = 5;
+  optional string card_number_last_4 = 6;
+}
+
+message ReplaceLostStolenCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string card_number = 2;
+  string emboss_uuid = 3;
+  string expiry_date = 4;
+  string card_security_code = 5;
+  string status = 6;
+  string card_id = 7;
+  string external_card_id = 8;
+  string pmt_ref_number = 9;
+}
+
+// ================== VerifyCvv ==================
+message VerifyCvvRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  string card_number = 4;
+  string card_security_code = 5;
+  optional string card_expiry_date = 6;
+}
+
+message VerifyCvvResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  bool verified = 2;
+}
+
+// ================== VoidAddCard ==================
+message VoidAddCardRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+}
+
+message VoidAddCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  bool voided = 2;
+}
+
+// ================== ReissueCard ==================
+message ReissueCardRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+  optional string new_pan = 4;
+  optional string new_expiry_date = 5;
+  optional string emboss = 6;
+  optional string old_card_status = 7;
+  optional string by_pass_mail_fee = 8;
+}
+
+message ReissueCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string prn = 2;
+  string prod_id = 3;
+  string app_date = 4;
+  string status = 5;
+  string active_flag = 6;
+  int32 bill_cycle_day = 7;
+  string group_id = 8;
+  string start_date = 9;
+  string contract_number = 10;
+  string new_emboss_uuid = 11;
+  repeated ContractCardReissue cards = 12;
+}
+
+// ================== CreateSingleUseVirtualCard ==================
+message CreateSingleUseVirtualCardRequest {
+  string provider_id = 1;
+  string transaction_id = 2;
+  string primary_account_number = 3;
+  int32 prod_id = 4;
+  double credit_limit = 5;
+}
+
+message CreateSingleUseVirtualCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string card_id = 3;
+}
+
+// ================== ModifyStatus ==================
+message ModifyStatusRequest {
+  string provider_id = 1;
+  string transaction_id = 2;
+  string contract_id = 3;
+  int32 type = 4;
+  optional string start_date = 5;
+  optional string end_date = 6;
+  optional string by_pass_rep_fee = 7;
+  optional string card_number_last_4 = 8;
+  optional string closure_reason = 9;
+  optional string by_pass_mail_fee = 10;
+}
+
+// ================== ModifyContract ==================
+message ModifyContractRequest {
+  string contract_id = 1;
+  ModifyStatusRequest modify_status_dto = 2;
+}
+
+message ModifyContractResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string account_status = 3;
+  string new_emboss_uuid = 4;
+}
+
+// ================== GetCardId ==================
+message GetCardIdRequest {
+  string contract_id = 1;
+  string card_number_last_4 = 2;
+}
+
+message GetCardIdResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string card_id = 2;
+}
+
+// ================== ModifyCard ==================
+message ModifyCardRequest {
+  string card_id = 1;
+  ModifyStatusRequest modify_status_dto = 2;
+}
+
+message ModifyCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string account_status = 3;
+  string new_emboss_uuid = 4;
+}
+
+// ================== ModifyContractAndCard ==================
+message ModifyContractAndCardRequest {
+  string contract_id = 1;
+  string card_id = 2;
+  ModifyStatusRequest modify_status_dto = 3;
+}
+
+message ModifyContractAndCardResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string pmt_ref_number = 2;
+  string account_status = 3;
+  string new_emboss_uuid = 4;
+}
+
+// ================== GetCardPinChangeKey ==================
+message GetCardPinChangeKeyRequest {
+  string card_id = 1;
+  string provider_id = 2;
+  string transaction_id = 3;
+}
+
+message GetCardPinChangeKeyResponse {
+  kapital.common.v1.ResponseMeta meta = 1;
+  string token = 2;
+}

package/proto/kapital/cards/v1/cards_types.proto

@@ -0,0 +1,117 @@
+syntax = "proto3";
+
+package kapital.cards.v1;
+
+option go_package = "kapital/cards/v1;cardsv1";
+
+// ================== GetContractCards ==================
+message CustomerContractCards {
+  string first_name = 1;
+  optional string middle_name = 2;
+  string last_name = 3;
+  string address_1 = 4;
+  optional string address_2 = 5;
+  string city = 6;
+  string state = 7;
+  string postal_code = 8;
+  string country_code = 9;
+  optional string phone = 10;
+  string mobile_phone = 11;
+  optional string mobile_phone_country_code = 12;
+  optional string email = 13;
+  AddressContractCards ship_to_address = 14;
+  string express_mail = 15;
+  repeated RelatedContractCards related_contracts = 16;
+  optional string occupation = 17;
+  optional string income_source = 18;
+}
+
+message AddressContractCards {
+	string address_1 = 1;
+  optional string address_2 = 2;
+  string city = 3;
+  string state = 4;
+  string postal_code = 5;
+  string country_code = 6;
+}
+
+message RelatedContractCards {
+  string pmt_ref_no = 1;
+  string product_id = 2;
+  string active = 3;
+  string status = 4;
+  optional string group_id = 5;
+  string application_date = 6;
+  string start_date = 7;
+  optional string bill_cycle_day = 8;
+}
+
+message ContractContractCards {
+  string active = 1;
+  string application_date = 2;
+  optional string bill_cycle_day = 3;
+  optional string group_id = 4;
+  string pmt_ref_no = 5;
+  string product_id = 6;
+  string start_date = 7;
+  string status = 8;
+  repeated CardContractCards cards = 9;
+}
+
+message CardContractCards {
+  string card_id = 1;
+  string card_number = 2;
+  string emboss_uuid = 3;
+  string card_status = 4;
+  string expiry_date = 5;
+  optional string external_card_id = 6;
+  string pin_fail_count = 7;
+  optional string pin_fail_date = 8;
+  FreezeInfo freeze_info = 9;
+  repeated EmbossedCard embossed_cards = 10;
+}
+
+message FreezeInfo {
+  string status = 1;
+  optional string start_date = 2;
+  optional string end_date = 3;
+}
+
+message EmbossedCard {
+  string created_date = 1;
+  string emboss_uuid = 2;
+  string emboss_date = 3;
+  string expiry_date = 4;
+  string status = 5;
+  string shipping_type = 6;
+  string product_id = 7;
+}
+
+// ================== GetCard ==================
+message SpendControls {
+  optional string available_credit = 1;
+  optional string single_use = 2;
+  optional string credit_limit = 3;
+}
+
+// ================== ReissueCard ==================
+message ContractCardReissue {
+  string card_number = 1;
+  optional string expiry_date = 2;
+  optional string card_security_code = 3;
+  string status = 4;
+  string card_id = 5;
+  optional string emboss_uuid = 6;
+  optional string external_card_id = 7;
+  string pmt_ref_no = 8;
+  optional string first_name = 9;
+  optional string middle_name = 10;
+  optional string last_name = 11;
+  optional string encrypted_card_number = 12;
+  optional string encrypted_expiry_date = 13;
+  repeated EmbossedCard embossed_cards = 14;
+  optional string pin_fail_count = 15;
+  optional string pin_fail_date = 16;
+  FreezeInfo freeze_info = 17;
+  SpendControls spend_controls = 18;
+}

package/proto/kapital/common/v1/error.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package kapital.common.v1;
+
+option go_package = "kapital/common/v1;commonv1";
+
+import "kapital/common/v1/meta.proto";
+
+message FieldViolation {
+  string field = 1;
+  string description = 2;
+}
+
+message ErrorDetail {
+  ResponseMeta meta = 1;
+  repeated FieldViolation field_violations = 2;
+}
+

package/proto/kapital/common/v1/meta.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+package kapital.common.v1;
+
+option go_package = "kapital/common/v1;commonv1";
+
+message ResponseMeta {
+  string request_id = 1;
+  string code = 2;
+  string title = 3;
+  string description = 4;
+}
+

package/proto/kapital/common/v1/pagination.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package kapital.common.v1;
+
+option go_package = "kapital/common/v1;commonv1";
+
+message PageRequest {
+  int32 page = 1;
+  int32 rows_per_page = 2;
+  string sort_by = 3;
+  bool descending = 4;
+}
+
+message PageResponse {
+  int32 total = 1;
+  int32 page = 2;
+  int32 rows_per_page = 3;
+}