@postpaybr/protos 1.1.0

package/src/payment-calculator.proto

@@ -0,0 +1,165 @@
+syntax = "proto3";
+
+package paymentCalculator;
+
+service PaymentCalculatorService {
+  rpc calculateInstallments (CalculateInstallmentsRequest) returns (CalculateInstallmentsResponse);
+  rpc getPaymentMethods (GetPaymentMethodsRequest) returns (GetPaymentMethodsResponse);
+  rpc getPrincipalMethod (GetPrincipalMethodRequest) returns (GetPrincipalMethodResponse);
+  rpc calculatePostpayFee (CalculatePostpayFeeRequest) returns (CalculatePostpayFeeResponse);
+
+   rpc calculateIndividualTaxFees (CalculateIndividualTaxFeesRequest) returns (CalculateIndividualTaxFeesResponse);
+}
+
+message CalculateInstallmentsRequest {
+  string customerId = 1;
+  int32 count = 2;
+}
+
+message CalculateInstallmentsResponse {
+  repeated Installment installments = 1;
+}
+
+message Installment {
+  int32 installment = 1;
+  double amount = 2;
+  double fee = 3;
+  double totalAmount = 4;
+  double baseAmount = 5;
+}
+
+message GetPaymentMethodsRequest {
+  string customerId = 1;
+  PaymentSchedule paymentSchedule = 2;
+}
+
+message GetPaymentMethodsResponse {
+  repeated PaymentDetails methods = 1;
+}
+
+message PaymentDetails {
+  string method = 1;
+  double amount = 2;
+  optional double discountPercentage = 3;
+  double fee = 4;
+  optional double discountAmount = 5;
+  optional string gatewayId = 6;
+  optional Card card = 7;
+  PaymentSchedule paymentSchedule = 8;
+  double baseFee = 9;
+  double feePercentage = 10;
+  optional string chargeId = 11;
+  optional bool isRetry = 12;
+  optional string orderId = 13;
+}
+
+message Card {
+  string id = 1;
+  string shadowNumber = 2;
+  string brand = 3;
+  optional int32 installments = 4;
+  optional double installmentValue = 5;
+}
+
+message GetPrincipalMethodRequest {
+  string customerId = 1;
+  PaymentSchedule paymentSchedule = 2;
+}
+
+message GetPrincipalMethodResponse {
+  PaymentDetails principalMethod = 1;
+}
+
+message CalculatePostpayFeeRequest {
+  repeated TaxDetail taxes = 1;
+  PaymentDetails paymentDetails = 2;
+}
+
+message CalculatePostpayFeeResponse {
+  double totalPostpayFee = 1;
+}
+
+message TaxDetail {
+  Tax tax = 1;
+  Payer payer = 2;
+  LocationInfo location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+}
+
+message Meta {
+  optional Address address = 1;   
+  optional string licensePlate = 2;   
+  optional string model = 3;           
+  optional int32 yearManufacture = 4; 
+  optional string renavam = 5;        
+}
+
+message Address {
+  string street = 1;
+  string number = 2;
+  string complement = 3;
+  string neighborhood = 4;
+  string city = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message Tax {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  optional int32 quota = 11;
+  double discountAmount = 12;
+  double fee = 13;
+  double fine = 14;
+}
+
+message LocationInfo {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message Payer {
+  optional string id = 1;
+  string name = 2;
+  string document = 3;
+  optional string phone = 4;
+}
+
+message PaymentSchedule {
+  string type = 1;
+  optional string date = 2;
+}
+
+
+message CalculateIndividualTaxFeesRequest {
+  repeated TaxDetail taxes = 1;
+  string recipientId = 2;
+  string method = 3;
+  optional string brand = 4;
+  int32 installment = 5;
+}
+
+message CalculateIndividualTaxFeesResponse {
+  repeated IndividualFeePerTax feesPerTax = 1;
+  double totalFee = 2;
+  double totalAmount = 3;
+  double baseFee = 4;
+  double feePercentage = 5; 
+}
+
+message IndividualFeePerTax {
+  string taxId = 1;
+  double amount = 2;
+  double fee = 3;
+  double totalAmount = 4;
+}

package/src/payment-card.proto

@@ -0,0 +1,217 @@
+syntax = "proto3";
+
+package paymentCard;
+
+service PaymentCard {
+  rpc CreatePayment (CreatePaymentRequest) returns (CreatePaymentResponse);
+  rpc ProcessScheduledPayment (ProcessScheduledPaymentRequest) returns (ProcessScheduledPaymentResponse);
+  rpc CreateVerificationPayment (CreateVerificationPaymentRequest) returns (CreateVerificationPaymentResponse);
+
+}
+
+message CreatePaymentRequest {
+  string customerId = 1;
+  repeated TaxPayload taxes = 2;
+  PaymentDetails payment = 3;
+  optional bool closed = 4;
+  optional string ip = 5;
+  optional string sessionId = 6;
+  string pushToken = 7;
+}
+
+message TaxPayload {
+  Tax tax = 1;
+  Payer payer = 2;
+  Location location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+}
+
+message Tax {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  optional int32 quota = 11;
+  double discountAmount = 12;
+  double fee = 13;
+  double fine = 14;
+}
+
+message Payer {
+  optional string id = 1;
+  string name = 2;
+  string document = 3;
+  optional string phone = 4;
+}
+
+message Location {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message Meta {
+  optional Address address = 1;   
+  optional string licensePlate = 2;   
+  optional string model = 3;           
+  optional int32 yearManufacture = 4; 
+  optional string renavam = 5;        
+}
+
+message Address {
+  string street = 1;
+  string number = 2;
+  string complement = 3;
+  string neighborhood = 4;
+  string city = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message PaymentDetails {
+  string method = 1;
+  double amount = 2;
+  optional double discountPercentage = 3;
+  double fee = 4;
+  optional double discountAmount = 5;
+  optional string gatewayId = 6;
+  optional Card card = 7;
+  PaymentSchedule paymentSchedule = 8;
+  double baseFee = 9;
+  double feePercentage = 10;
+  optional string chargeId = 11;
+  optional bool isRetry = 12;
+  optional string orderId = 13;
+}
+
+message PaymentSchedule {
+  string type = 1;
+  optional string date = 2;
+}
+
+message Card {
+  string id = 1;
+  string shadowNumber = 2;
+  string brand = 3;
+  optional int32 installments = 4;
+  optional double installmentValue = 5;
+}
+
+message CreatePaymentResponse {
+  Order order = 1;
+  string orderType = 2;
+}
+
+message ProcessScheduledPaymentRequest {
+  string customerId = 1;
+  TaxPayload tax = 2;
+  Charge charge = 3;
+  PaymentDetails payment = 4;
+}
+
+message ProcessScheduledPaymentResponse {}
+
+message CreateVerificationPaymentRequest {
+  string customerId = 1;
+  CardDetails card = 2;
+  double value = 3;
+  optional string cardVerificationId = 4;
+}
+
+message CardDetails {
+  optional string id = 1;
+  string vaultToken = 2;
+  string vaultTokenCvv = 3;
+}
+
+message CreateVerificationPaymentResponse {}
+
+message Charge {
+  string id = 1;
+  double amount = 2;
+  string paymentMethod = 3;
+  string status = 4;
+  string dueAt = 5;
+  string txid = 6;
+  string brcode = 7;
+  string pushToken = 8;
+  int32 installmentNumber = 9;
+  double installmentValue = 10;
+  double fee = 11;
+  double baseFee = 12;
+  double feePercentage = 13;
+  bool isScheduled = 14;
+  double discountPercentage = 15;
+  double discountAmount = 16;
+  string createdAt = 17;
+  string gatewayId = 18;
+  string cardId = 19;
+  string orderId = 20;
+  string orderScheduleId = 21;
+  repeated string payableIds = 22;
+  repeated string taxIds = 23;
+  ChargeSchedule chargeSchedule = 24;
+  string endToEndId = 25;
+  string type = 26;
+  map<string, string> metadata = 27;
+}
+
+message ChargeSchedule {
+  string id = 1;
+  string executionDate = 2;
+  bool isExecuted = 3;
+  string createdAt = 4;
+  string updatedAt = 5;
+  Charge charge = 6;
+}
+
+message Recipient {
+  string id = 1;
+  string code = 2;
+  string commercialName = 3;
+  string socialReason = 4;
+  string holderType = 5;
+  string document = 6;
+  string cnaeId = 7;
+  string legalType = 8;
+  string contactName = 10;
+  string contactEmail = 11;
+  string contactPhone = 12;
+  bool isAutomaticAnticipationEnabled = 13;
+  string foundation = 14;
+  optional string avatarUrl = 15;
+}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+  repeated OrderItemEntity items = 5;
+  repeated Charge charges = 6;
+  Customer customer = 7;
+}
+
+message OrderItemEntity {
+  string id = 1;
+  Recipient recipient = 2;
+  Tax tax = 3;
+  Order order = 4;
+}
+message Customer {
+  string id = 1;
+  string firstName = 2;
+  string lastName = 3;
+  string document = 4;
+  string email = 5;
+  bool isEmailVerified = 6;
+  string phone = 7;
+}
+

package/src/payment-gateway.proto

@@ -0,0 +1,94 @@
+syntax = "proto3";
+
+package paymentGateway;
+
+service PaymentGatewayService {
+  rpc getById(GetByIdRequest) returns (PaymentGatewayResponse);
+  rpc getByGatewayId(GetByGatewayIdRequest) returns (PaymentGatewayResponse);
+  rpc getAllGateways(GetAllGatewaysRequest) returns (PaymentGatewayListResponse);
+  rpc getGatewaysByMethodSupport(GetGatewaysByMethodSupportRequest) returns (PaymentGatewayListResponse);
+  rpc createGateway(CreateGatewayRequest) returns (PaymentGatewayResponse);
+  rpc updateGateway(UpdateGatewayRequest) returns (PaymentGatewayResponse);
+  rpc deactivateGateway(DeactivateGatewayRequest) returns (Void);
+
+}
+
+message PaymentGateway {
+  string id = 1;
+  string name = 2;
+  string gatewayId = 3;
+  bool supportsPix = 4;
+  bool supportsCreditCard = 5;
+  bool supportsDebitCard = 6;
+  bool supportsAutomaticAnticipation = 7;
+  bool supportsManualAnticipation = 8;
+  bool isActive = 9;
+  string description = 10;
+  string createdAt = 11;
+  string updatedAt = 12;
+}
+
+message PaymentGatewayResponse {
+  PaymentGateway paymentGateway = 1;
+}
+
+message PaymentGatewayListResponse {
+  repeated PaymentGateway gateways = 1;
+}
+
+message GetByIdRequest {
+  string id = 1;
+}
+
+message GetByGatewayIdRequest {
+  string gatewayId = 1;
+}
+
+message GetGatewaysByMethodSupportRequest {
+  string method = 1;
+}
+
+message CreateGatewayRequest {
+  string name = 1;
+  string gatewayId = 2;
+  bool supportsPix = 3;
+  bool supportsCreditCard = 4;
+  bool supportsDebitCard = 5;
+  bool supportsAutomaticAnticipation = 6;
+  bool supportsManualAnticipation = 7;
+  bool isActive = 8;
+  string description = 9;
+}
+
+message UpdateGatewayRequest {
+  string id = 1;
+  optional string name = 2;
+  optional string gatewayId = 3;
+  optional bool supportsPix = 4;
+  optional bool supportsCreditCard = 5;
+  optional bool supportsDebitCard = 6;
+  optional bool supportsAutomaticAnticipation = 7;
+  optional bool supportsManualAnticipation = 8;
+  optional bool isActive = 9;
+  optional string description = 10;
+}
+
+message DeactivateGatewayRequest {
+  string id = 1;
+}
+
+message Void {}
+
+
+message TableFilterParams {
+  optional int32 pageIndex = 1;
+  optional int32 pageSize = 2;
+  repeated string statuses = 3;
+  optional string globalFilter = 4;
+  optional string startDate = 5;
+  optional string endDate = 6;
+}
+
+message GetAllGatewaysRequest {
+  TableFilterParams filter = 1;
+}

package/src/payment-pix.proto

@@ -0,0 +1,115 @@
+syntax = "proto3";
+
+package paymentPix;
+
+service PaymentPix {
+  rpc CreatePayment (CreatePaymentRequest) returns (CreatePaymentResponse);
+}
+
+message CreatePaymentRequest {
+  string customerId = 1;
+  repeated TaxPayload taxes = 2;
+  PaymentDetails payment = 3;
+  optional bool closed = 4;
+  optional string ip = 5;
+  optional string sessionId = 6;
+  string pushToken = 7;
+}
+
+message TaxPayload {
+  Tax tax = 1;
+  Payer payer = 2;
+  Location location = 3;
+  string metaType = 4;
+  Meta meta = 5;
+}
+
+message Tax {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  optional int32 quota = 11;
+  double discountAmount = 12;
+  double fee = 13;
+  double fine = 14;
+}
+
+message Payer {
+  optional string id = 1;
+  string name = 2;
+  string document = 3;
+  optional string phone = 4;
+}
+
+message Location {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message Meta {
+  optional Address address = 1;   
+  optional string licensePlate = 2;   
+  optional string model = 3;           
+  optional int32 yearManufacture = 4; 
+  optional string renavam = 5;        
+}
+
+message Address {
+  string street = 1;
+  string number = 2;
+  string complement = 3;
+  string neighborhood = 4;
+  string city = 5;
+  string state = 6;
+  string zipCode = 7;
+}
+
+message PaymentDetails {
+  string method = 1;
+  double amount = 2;
+  optional double discountPercentage = 3;
+  double fee = 4;
+  optional double discountAmount = 5;
+  optional string gatewayId = 6;
+  optional Card card = 7;
+  PaymentSchedule paymentSchedule = 8;
+  double baseFee = 9;
+  double feePercentage = 10;
+  optional string chargeId = 11;
+  optional bool isRetry = 12;
+  optional string orderId = 13;
+}
+
+message PaymentSchedule {
+  string type = 1;
+  optional string date = 2;
+}
+
+message Card {
+  string id = 1;
+  string shadowNumber = 2;
+  string brand = 3;
+  optional int32 installments = 4;
+  optional double installmentValue = 5;
+}
+
+message Order {
+  string id = 1;
+  double totalAmount = 2;
+  string status = 3;
+  string createdAt = 4;
+}
+
+message CreatePaymentResponse {
+  Order order = 1;
+  string orderType = 2;
+  string chargeId = 3;
+}