add optional external reference to pay out

Author: fupelaqu

build.sbt

@@ -31,7 +31,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "payment"
 
-ThisBuild / version := "0.4.2.1"
+ThisBuild / version := "0.4.2.2"
 
 ThisBuild / scalaVersion := "2.12.15"
 

common/src/main/protobuf/api/payment.proto

@@ -80,6 +80,7 @@ message PayOutRequest {
     int32 creditedAmount = 3;
     int32 feesAmount = 4;
     string currency = 5;
+    google.protobuf.StringValue externalReference = 6;
 }
 
 message TransferRequest {

common/src/main/protobuf/message/payment/payment.proto

@@ -207,6 +207,7 @@ message PayOutCommandEvent{
     required int32 creditedAmount = 3;
     required int32 feesAmount = 4;
     required string currency = 5 [default = "EUR"];
+    optional string externalReference = 6;
 }
 
 message TransferCommandEvent{

common/src/main/protobuf/message/payment/transaction.proto

@@ -78,6 +78,7 @@ message PaidOutEvent {
     required string currency = 6 [default = "EUR"];
     required string transactionId = 7;
     required app.softnetwork.payment.model.Transaction.PaymentType paymentType = 8;
+    optional string externalReference = 9;
 }
 
 message PayOutFailedEvent {
@@ -86,6 +87,7 @@ message PayOutFailedEvent {
     required string orderUuid = 1;
     required string resultMessage = 2;
     optional app.softnetwork.payment.model.Transaction transaction = 3;
+    optional string externalReference = 4;
 }
 
 message RefundedEvent {

common/src/main/protobuf/model/payment/transaction.proto

@@ -162,6 +162,7 @@ message PayOutTransaction {
     required string bankAccountId = 6;
     required string authorId = 7;
     required string debitedWalletId = 8;
+    optional string externalReference = 9;
 }
 
 message DirectDebitTransaction {

common/src/main/scala/app/softnetwork/payment/api/PaymentClient.scala

@@ -70,10 +70,18 @@ trait PaymentClient extends GrpcClient {
     creditedAccount: String,
     creditedAmount: Int,
     feesAmount: Int,
-    currency: String
+    currency: String,
+    externalReference: Option[String]
   ): Future[TransactionResponse] = {
     grpcClient.payOut(
-      PayOutRequest(orderUuid, creditedAccount, creditedAmount, feesAmount, currency)
+      PayOutRequest(
+        orderUuid,
+        creditedAccount,
+        creditedAmount,
+        feesAmount,
+        currency,
+        externalReference
+      )
     )
   }
 

common/src/main/scala/app/softnetwork/payment/message/PaymentMessages.scala

@@ -264,7 +264,8 @@ object PaymentMessages {
     creditedAccount: String,
     creditedAmount: Int,
     feesAmount: Int = 0,
-    currency: String = "EUR"
+    currency: String = "EUR",
+    externalReference: Option[String] = None
   ) extends PaymentCommandWithKey {
     val key: String = creditedAccount
   }

core/src/main/scala/app/softnetwork/payment/api/PaymentServer.scala

@@ -140,7 +140,9 @@ trait PaymentServer extends PaymentServiceApi with GenericPaymentHandler {
 
   override def payOut(in: PayOutRequest): Future[TransactionResponse] = {
     import in._
-    !?(PayOut(orderUuid, creditedAccount, creditedAmount, feesAmount, currency)) map {
+    !?(
+      PayOut(orderUuid, creditedAccount, creditedAmount, feesAmount, currency, externalReference)
+    ) map {
       case r: PaidOut =>
         TransactionResponse(
           transactionId = Some(r.transactionId),

core/src/main/scala/app/softnetwork/payment/handlers/GenericPaymentHandler.scala

@@ -189,11 +189,20 @@ trait GenericPaymentDao { _: GenericPaymentHandler =>
     }
   }
 
-  def payOut(orderUuid: String, creditedAccount: String, creditedAmount: Int, feesAmount: Int)(
-    implicit system: ActorSystem[_]
+  def payOut(
+    orderUuid: String,
+    creditedAccount: String,
+    creditedAmount: Int,
+    feesAmount: Int,
+    currency: String = "EUR",
+    externalReference: Option[String]
+  )(implicit
+    system: ActorSystem[_]
   ): Future[Either[PayOutFailed, PaidOut]] = {
     implicit val ec: ExecutionContextExecutor = system.executionContext
-    !?(PayOut(orderUuid, creditedAccount, creditedAmount, feesAmount)) map {
+    !?(
+      PayOut(orderUuid, creditedAccount, creditedAmount, feesAmount, currency, externalReference)
+    ) map {
       case result: PaidOut     => Right(result)
       case error: PayOutFailed => Left(error)
       case _ =>

core/src/main/scala/app/softnetwork/payment/persistence/query/GenericPaymentCommandProcessorStream.scala

@@ -91,7 +91,14 @@ trait GenericPaymentCommandProcessorStream extends EventProcessorStream[PaymentE
             }
           case evt: PayOutCommandEvent =>
             import evt._
-            val command = PayOut(orderUuid, creditedAccount, creditedAmount, feesAmount, currency)
+            val command = PayOut(
+              orderUuid,
+              creditedAccount,
+              creditedAmount,
+              feesAmount,
+              currency,
+              externalReference
+            )
             !?(command) map {
               case _: PaidOut =>
                 if (forTests) system.eventStream.tell(Publish(event))