feat(core): [Payouts] Add reference_id to payout response

crates/api_models/src/payouts.rs

@@ -445,6 +445,10 @@ pub struct PayoutCreateResponse {
     #[schema(value_type = Option<Vec<PayoutAttemptResponse>>)]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub attempts: Option<Vec<PayoutAttemptResponse>>,
+
+    /// The reference id to check payout in the connector's dashboard
+    #[schema(value_type = String, example = "50c90b09-11d2-4c97-ab5c-42e336e7506c")]
+    pub reference_id: Option<String>,
 }
 
 #[derive(

crates/router/src/core/payments/transformers.rs

@@ -976,7 +976,7 @@ impl ForeignFrom<(storage::Payouts, storage::PayoutAttempt, domain::Customer)>
     fn foreign_from(item: (storage::Payouts, storage::PayoutAttempt, domain::Customer)) -> Self {
         let (payout, payout_attempt, customer) = item;
         let attempt = PayoutAttemptResponse {
-            attempt_id: payout_attempt.payout_attempt_id,
+            attempt_id: payout_attempt.payout_attempt_id.clone(),
             status: payout_attempt.status,
             amount: payout.amount,
             currency: Some(payout.destination_currency),
@@ -985,7 +985,7 @@ impl ForeignFrom<(storage::Payouts, storage::PayoutAttempt, domain::Customer)>
             error_message: payout_attempt.error_message.clone(),
             payment_method: Some(payout.payout_type),
             payout_method_type: None,
-            connector_transaction_id: payout_attempt.connector_payout_id,
+            connector_transaction_id: payout_attempt.connector_payout_id.clone(),
             cancellation_reason: None,
             unified_code: None,
             unified_message: None,
@@ -1019,6 +1019,9 @@ impl ForeignFrom<(storage::Payouts, storage::PayoutAttempt, domain::Customer)>
             attempts: Some(attempts),
             billing: None,
             client_secret: None,
+            reference_id: payout_attempt
+                .connector_payout_id
+                .or(Some(payout_attempt.payout_attempt_id)),
         }
     }
 }

crates/router/src/core/payouts.rs

@@ -1869,6 +1869,11 @@ pub async fn response_handler(
         }
     });
 
+    let reference_id = payout_attempt
+        .connector_payout_id
+        .clone()
+        .or(Some(payout_attempt.payout_attempt_id));
+
     let response = api::PayoutCreateResponse {
         payout_id: payouts.payout_id.to_owned(),
         merchant_id: merchant_account.merchant_id.to_owned(),
@@ -1897,6 +1902,7 @@ pub async fn response_handler(
         profile_id: payout_attempt.profile_id,
         created: Some(payouts.created_at),
         attempts: None,
+        reference_id,
     };
     Ok(services::ApplicationResponse::Json(response))
 }

openapi/openapi_spec.json

@@ -16524,7 +16524,8 @@
           "status",
           "error_message",
           "error_code",
-          "profile_id"
+          "profile_id",
+          "reference_id"
         ],
         "properties": {
           "payout_id": {
@@ -16672,6 +16673,11 @@
             },
             "description": "List of attempts",
             "nullable": true
+          },
+          "reference_id": {
+            "type": "string",
+            "description": "The reference id to check payout in the connector's dashboard",
+            "example": "50c90b09-11d2-4c97-ab5c-42e336e7506c"
           }
         },
         "additionalProperties": false