@postpaybr/protos 1.1.0

package/src/charge.proto

@@ -0,0 +1,610 @@
+syntax = "proto3";
+
+package charge;
+
+service ChargeService {
+  rpc createCharge (CreateChargeRequest) returns (ChargeResponse);
+  rpc updateCharge (UpdateChargeRequest) returns (ChargeResponse);
+  rpc getChargeById (GetChargeByIdRequest) returns (ChargeResponse);
+  rpc getChargeAdministratorDetails (GetChargeByIdRequest) returns (getChargeAdministratorDetailsResponse);
+  rpc getAllCharges (GetAllChargesRequest) returns (GetAllChargesResponse);
+  rpc getChargesByOrderId (GetChargesByOrderIdRequest) returns (GetChargesByOrderIdResponse);
+  rpc getChargeByTxid (GetChargeByTxidRequest) returns (ChargeResponse);
+  rpc getScheduledChargeDetail (GetScheduledChargeDetailRequest) returns (ScheduledChargeDetailResponse);
+  rpc getLiquidatedChargesForTransfer (getLiquidatedChargesForTransferRequest) returns (getLiquidatedChargesForTransferResponse);
+  rpc forceConfirm (ForceConfirmRequest) returns (ChargeResponse);
+  rpc forceDueDate (ForceDueDateRequest) returns (ChargeResponse);
+  rpc getChargeCustomerName (GetChargeCustomerNameRequest) returns (GetChargeCustomerNameResponse);
+  rpc getConfirmedChargesByIds (GetConfirmedChargesByIdsRequest) returns (GetConfirmedChargesByIdsResponse);
+  rpc cancelScheduledCharge (cancelScheduledChargeRequest) returns (ChargeResponse);
+  rpc createVerificationCardCharge (CreateVerificationCardChargeRequest) returns (ChargeResponse);
+  rpc cancelChargeByTxid (cancelChargeByTxidRequest) returns (CancelPaymentResponse);
+  rpc forceLiquidation (ForceLiquidationRequest) returns (ForceLiquidationResponse);
+  rpc addPayableToCharge (AddPayableToChargeRequest) returns (ChargeResponse);
+  rpc getChargeClientDetails (GetChargeByIdRequest) returns (ChargeClientDetailsResponse);
+  rpc getChargesHistory (GetChargesHistoryRequest) returns (GetChargesHistoryResponse);
+  rpc getLastChargesByCustomerId (GetLastChargesRequest) returns (GetLastChargesResponse);
+  rpc cancelChargeById (cancelChargeByIdRequest) returns (CancelPaymentResponse);
+  rpc getChargeRecipientId (GetChargeByIdRequest) returns (GetChargeRecipientIdResponse);
+  rpc getChargesTimeline (GetChargesTimelineRequest) returns (GetChargesTimelineResponse);
+  rpc getChargesComparisonTimeline (GetChargesComparisonTimelineRequest) returns (GetChargesComparisonTimelineResponse);
+  rpc getLiquidTotalAmount (getLiquidTotalAmountRequest) returns (getLiquidTotalAmountResponse);
+  rpc confirmCharges (ConfirmChargesRequest) returns (ChargesBatchResponse);
+  rpc forceChargesDueDate (ForceChargesDueDateRequest) returns (ChargesBatchResponse);
+  rpc forceChargesLiquidation (ForceChargesLiquidationRequest) returns (ChargesBatchResponse);
+  rpc cancelCharges (CancelChargesRequest) returns (ChargesBatchResponse);
+  rpc getOrderPaymentSummary (GetOrderPaymentSummaryRequest) returns (GetOrderPaymentSummaryResponse);
+}
+
+message DateFilter {
+  optional string startDate = 1;
+  optional string endDate = 2;
+}
+
+message PaginationFilter {
+  optional int32 limit = 1;
+  optional int32 offset = 2;
+}
+
+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;
+  optional string taxId = 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 CreateChargeRequest {
+  double amount = 1;
+  string paymentMethod = 2;
+  string gatewayId = 3;
+  string dueAt = 4;
+  string orderId = 5;
+  string orderType = 6;
+  double baseFee = 7;
+  double feePercentage = 8;
+  double fee = 9;
+  optional string taxId = 10;
+  double discountPercentage = 11;
+  double discountAmount = 12;
+  string cardId = 13;
+  optional string txid = 14;
+  string pushToken = 15;
+  int32 installmentNumber = 16;
+  double installmentValue = 17;
+  string recipientId = 18;
+}
+
+message UpdateChargeRequest {
+  string id = 1;
+  optional double amount = 2;
+  optional string paymentMethod = 3;
+  optional string status = 4;
+  optional string pushToken = 5;
+  optional string txid = 6;
+  optional string brcode = 7;
+  optional string endToEndId = 8;
+  map<string, string> metadata = 9;
+  optional string orderId = 10;
+  optional string gatewayId = 11;
+  optional int32 installmentNumber = 12;
+  optional double installmentValue = 13;
+  optional string cardId = 14;
+  optional double fee = 15;
+  optional double baseFee = 16;
+  optional double feePercentage = 17;
+  optional double discountPercentage = 18;
+  optional double discountAmount = 19;
+  optional string taxId = 20;
+  optional string dueAt = 21;
+  optional string orderType = 22;
+  optional bool isRetry = 23;
+}
+
+message GetChargeByIdRequest {
+  string id = 1;
+}
+
+message GetAllChargesRequest {
+  optional int32 pageIndex = 1;
+  optional int32 pageSize = 2;
+  repeated string statuses = 3;
+  optional string globalFilter = 4;
+  optional string startDate = 5;
+  optional string endDate = 6;
+  optional string recipientId = 7;
+  repeated string gatewayIds = 8;
+  optional bool isScheduled = 9;
+}
+
+message GetAllChargesResponse {
+  repeated Charge charges = 1;
+}
+
+message GetChargesByOrderIdRequest {
+  string id = 1;
+}
+
+message GetChargesByOrderIdResponse {
+  repeated Charge charges = 1;
+}
+
+message GetChargeByTxidRequest {
+  string txid = 1;
+}
+
+message ChargeResponse {
+  Charge charge = 1;
+}
+
+message GetScheduledChargeDetailRequest {
+  string id = 1;
+}
+
+message ScheduledChargeDetailResponse {
+  ScheduledChargeDetail scheduledChargeDetail = 1;
+}
+
+message ScheduledChargeDetail {
+  string id = 1;
+  double amount = 2;
+  string method = 3;
+  string status = 4;
+  string dueAt = 5;
+  string createdAt = 6;
+  string executionDate = 7;
+  double fee = 8;
+  optional Tax tax = 9;
+  optional CardDetails card = 10;
+}
+
+message CardDetails {
+  string id = 1;
+  string brand = 2;
+  string shadowNumber = 3;
+  string nickname = 4;
+}
+
+
+message getLiquidatedChargesForTransferRequest {}
+
+message getLiquidatedChargesForTransferResponse {
+  repeated Charge charges = 1;
+}
+
+message getChargeAdministratorDetailsResponse {
+  string id = 1;
+  string customer = 2;
+  string status = 3;
+  string createdAt = 4;
+  double amount = 5;
+  string dueAt = 6;
+  string paymentMethod = 7;
+  double fee = 8;
+  double baseFee = 9;
+  double feePercentage = 10;
+  int32 installmentNumber = 11;
+  double installmentValue = 12;
+  double discountPercentage = 13;
+  double discountAmount = 14;
+  string txid = 15;
+  string gatewayId = 16;
+  optional string cardId = 17;
+  optional string orderId = 18;
+  optional string orderScheduleId = 19;
+  map<string, string> metadata = 20;
+  optional string failureReason = 21;
+  optional string failureDetails = 22;
+  repeated ChargeSplit splits = 23;
+  optional TaxPayload tax = 24;
+  optional ChargeScheduleDetail schedule = 25;
+}
+
+message ChargeScheduleDetail {
+  string executionDate = 2;
+  bool isExecuted = 3;
+}
+
+message ChargeSplit {
+  string recipientAccount = 1;
+  double amount = 2;
+  string status = 3;
+  int32 installment = 4;
+  string dueAt = 5;
+  bool isAnticipated = 6;
+  string processedAt = 7;
+  string id = 8;
+}
+
+message Tax {
+  string id = 1;
+  string type = 2;
+  string status = 3;
+  string description = 4;
+  double amount = 5;
+  int32 year = 6;
+  optional string dueAt = 7;
+  string documentId = 8;
+  string code = 9;
+  bool isSingleQuota = 10;
+  int32 quota = 11;
+  double fee = 12;
+  double fine = 13;
+  double discountPercentage = 14;
+  double discountAmount = 15;
+  int32 state = 16;
+  int32 city = 17;
+  string recipientId = 18;
+  string metaType = 19;
+  Meta meta = 20;
+  Payer payer = 21;
+  OrderItemEntity orderItem = 22;
+  optional Receipt receipt = 23;
+}
+
+message completeTax {
+  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;
+}
+
+message Location {
+  int32 state = 1;
+  int32 city = 2;
+  string recipientId = 3;
+}
+
+message TaxPayload {
+  completeTax tax = 1;
+  Payer payer = 2;
+  Location 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 Payer {
+  string id = 1;
+  string name = 2;
+  string document = 3;
+  string phone = 4;
+  repeated Tax taxes = 5;
+}
+
+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 Receipt {
+  string id = 1;
+  double amount = 2;
+  string protocol = 3;
+  optional string transactionId = 4;
+  string createdAt = 5;
+}
+
+message Customer {
+  string id = 1;
+  string username = 2;
+  string otherName = 3;
+  string document = 4;
+  string email = 5;
+  bool emailVerified = 6;
+  string phone = 7;
+}
+
+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 ForceConfirmRequest {
+  string chargeId = 1;
+}
+
+message ForceDueDateRequest {
+  string chargeId = 1;
+}
+
+message GetChargeCustomerNameRequest {
+  string id = 1;
+}
+
+message GetChargeCustomerNameResponse {
+  string customerName = 1;
+}
+
+message GetConfirmedChargesByIdsRequest {
+  repeated string ids = 1;
+}
+
+message GetConfirmedChargesByIdsResponse {
+  repeated Charge charges = 1;
+}
+
+message cancelScheduledChargeRequest {
+  string customerId = 1;
+  string id = 2;
+}
+
+message CreateVerificationCardChargeRequest {
+  double amount = 1;
+  string cardId = 2;
+  string gatewayId = 3;
+}
+
+message cancelChargeByTxidRequest {
+  string txid = 1;
+}
+
+message CancelPaymentResponse {
+  bool success = 1;
+}
+
+message ForceLiquidationRequest {
+  string chargeId = 1;
+}
+
+message ForceLiquidationResponse {
+  bool success = 1;
+}
+
+message AddPayableToChargeRequest {
+  string chargeId = 1;
+  string payableId = 2;
+}
+
+message ChargeClientDetailsResponse {
+  string id = 1;
+  string status = 2;
+  string createdAt = 3;
+  double amount = 4;
+  string dueAt = 5;
+  string paymentMethod = 6;
+  string txid = 7;
+  string gatewayId = 8;
+  optional string failureReason = 9;
+  optional string failureDetails = 10;
+  double fee = 11;
+  double baseFee = 12;
+  double feePercentage = 13;
+  optional int32 installmentNumber = 14;
+  optional double installmentValue = 15;
+  optional CardDetails card = 16;
+  double discountPercentage = 17;
+  double discountAmount = 18;
+  optional TaxPayload tax = 19;
+  optional ChargeScheduleDetail schedule = 20;
+  optional string orderId = 21;
+}
+
+message GetChargesHistoryRequest {
+  ChargeHistoryFilter data = 1;
+  PaginationFilter pagination = 2;
+  DateFilter date = 3;
+}
+
+message ChargeHistoryFilter {
+  string customerId = 1;
+  string status = 2;
+}
+
+message GetChargesHistoryResponse {
+  repeated ChargeCardItem charges = 1;
+  int32 count = 2;
+}
+
+message ChargeCardItem {
+  string id = 1;
+  string createdAt = 2;
+  string paymentMethod = 3;
+  string propertyDocument = 4;
+  string propertyDetail = 5;
+  int32 installmentNumber = 6;
+  double installmentValue = 7;
+  optional ChargeScheduleDetail schedule = 8;
+  string taxType = 9;
+  string status = 10;
+}
+
+message GetLastChargesRequest {
+  string customerId = 1;
+}
+
+message GetLastChargesResponse {
+  repeated ChargeCardItem charges = 1;
+}
+
+message cancelChargeByIdRequest {
+  string id = 1;
+}
+
+message GetChargeRecipientIdResponse {
+  string recipientId = 1;
+}
+
+message GetChargesTimelineRequest {
+  optional string recipientId = 1;
+  optional string startDate = 2;
+  optional string endDate = 3;
+}
+
+message TimelineDataPoint {
+  string date = 1;
+  double liquidated = 2;
+  double processing = 3;
+  double scheduled = 4;
+  double pending = 5;
+  double cancelled = 6;
+}
+
+message ComparisonDataPoint {
+  string date = 1;
+  double liquidated = 2;
+}
+
+message GetChargesTimelineResponse {
+  repeated TimelineDataPoint timeline = 1;
+}
+
+message GetChargesComparisonTimelineRequest {
+  optional string recipientId = 1;
+  optional string primaryPeriodStart = 2;
+  optional string primaryPeriodEnd = 3;
+  optional string secondaryPeriodStart = 4;
+  optional string secondaryPeriodEnd = 5;
+}
+
+message ChargeComparisonTimeline {
+  repeated ComparisonDataPoint primary = 1;
+  repeated ComparisonDataPoint secondary = 2;
+}
+
+message GetChargesComparisonTimelineResponse {
+  ChargeComparisonTimeline comparisonTimeline = 1;
+}
+
+message getLiquidTotalAmountRequest {
+  string recipientId = 1;
+  optional string startDate = 2;
+  optional string endDate = 3;
+}
+
+message getLiquidTotalAmountResponse {
+  double total = 1;
+}
+
+message ConfirmChargesRequest {
+  repeated string chargeIds = 1;
+}
+
+message ForceChargesDueDateRequest {
+  repeated string chargeIds = 1;
+}
+
+message ForceChargesLiquidationRequest {
+  repeated string chargeIds = 1;
+}
+
+message CancelChargesRequest {
+  repeated string chargeIds = 1;
+}
+
+message ChargesBatchResponse {
+  int32 successful = 1;
+  int32 failed = 2;
+}
+
+message GetOrderPaymentSummaryRequest {
+  string orderId = 1;
+  string orderType = 2;
+  string customerId = 3;
+}
+
+message GetOrderPaymentSummaryResponse {
+  double totalPaid = 1;
+  double totalPending = 2;
+  repeated IndividualPayment paymentsMade = 3;
+  repeated IndividualPayment scheduledPayments = 4;
+  IndividualPayment nextPayment = 5;
+}
+
+message IndividualPayment {
+  string id = 1;
+  string createdAt = 2;
+  string paymentMethod = 3;
+  string propertyDocument = 4;
+  string propertyDetail = 5;
+  int32 installmentNumber = 6;
+  double installmentValue = 7;
+  string status = 8;
+  optional PaymentSchedule schedule = 9;
+  string taxType = 10;
+}
+
+message PaymentSchedule {
+  string executionDate = 1;
+  bool isExecuted = 2;
+}
+