feat: [MAPS-1487] Add missing references to Merchant Account Payment …

…and External Payment (#84) * Added missing references to MA payment and to external payment * External payment's remitter fields are all required. * Bumped version * Settled doesn't not exists for payouts, it's Executed
TrueLayer · Nov 28, 2024 · 5cf7b67 · 5cf7b67
1 parent 01cc479
commit 5cf7b67
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 15 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "truelayer-rust"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 
 [dependencies]

diff --git a/README.md b/README.md
@@ -83,6 +83,8 @@ let res = tl
             beneficiary: Beneficiary::MerchantAccount {
                 merchant_account_id: "some-merchant-account-id".to_string(),
                 account_holder_name: None,
+                reference: None,
+                statement_reference: None,
             },
         },
         user: User {

diff --git a/examples/create_payment.rs b/examples/create_payment.rs
@@ -76,6 +76,8 @@ async fn run() -> anyhow::Result<()> {
                 beneficiary: Beneficiary::MerchantAccount {
                     merchant_account_id: merchant_account.id,
                     account_holder_name: None,
+                    reference: None,
+                    statement_reference: None,
                 },
             },
             user: CreatePaymentUserRequest::NewUser {

diff --git a/src/apis/merchant_accounts/api.rs b/src/apis/merchant_accounts/api.rs
@@ -263,7 +263,7 @@ mod tests {
                 SweepingFrequency, TransactionPayinStatus, TransactionPayoutContextCode,
                 TransactionPayoutStatus, TransactionType,
             },
-            payments::{AccountIdentifier, Currency, Remitter},
+            payments::{AccountIdentifier, Currency, ExternalPaymentRemitter},
             payouts::PayoutBeneficiary,
         },
         authenticator::Authenticator,
@@ -745,7 +745,8 @@ mod tests {
                                 "sort_code": "sort-code",
                                 "account_number": "account-number"
                             },
-                            "account_holder_name": "Mr. Holder"
+                            "account_holder_name": "Mr. Holder",
+                            "reference": "ext-payment-ref"
                         }
                     },
                     {
@@ -773,9 +774,9 @@ mod tests {
                         "currency": "GBP",
                         "amount_in_minor": 100,
                         "type": "payout",
-                        "status": "settled",
+                        "status": "executed",
                         "created_at": &now,
-                        "settled_at": &now,
+                        "executed_at": &now,
                         "beneficiary": {
                             "type": "payment_source",
                             "user_id": "payout-user-id",
@@ -832,12 +833,13 @@ mod tests {
                     r#type: TransactionType::ExternalPayment {
                         status: TransactionPayinStatus::Settled,
                         settled_at: now,
-                        remitter: Remitter {
-                            account_holder_name: Some("Mr. Holder".into()),
-                            account_identifier: Some(AccountIdentifier::SortCodeAccountNumber {
+                        remitter: ExternalPaymentRemitter {
+                            account_holder_name: "Mr. Holder".into(),
+                            account_identifier: AccountIdentifier::SortCodeAccountNumber {
                                 sort_code: "sort-code".to_string(),
                                 account_number: "account-number".to_string()
-                            })
+                            },
+                            reference: "ext-payment-ref".to_string()
                         }
                     }
                 },
@@ -865,7 +867,7 @@ mod tests {
                     currency: Currency::Gbp,
                     amount_in_minor: 100,
                     r#type: TransactionType::Payout {
-                        status: TransactionPayoutStatus::Settled { settled_at: now },
+                        status: TransactionPayoutStatus::Executed { executed_at: now },
                         created_at: now,
                         beneficiary: PayoutBeneficiary::PaymentSource {
                             user_id: "payout-user-id".to_string(),

diff --git a/src/apis/merchant_accounts/model.rs b/src/apis/merchant_accounts/model.rs
@@ -1,5 +1,5 @@
 use crate::apis::{
-    payments::{AccountIdentifier, Currency, PaymentSource, Remitter},
+    payments::{AccountIdentifier, Currency, ExternalPaymentRemitter, PaymentSource},
     payouts::PayoutBeneficiary,
 };
 use chrono::{DateTime, SecondsFormat, Utc};
@@ -80,7 +80,7 @@ pub enum TransactionType {
     ExternalPayment {
         status: TransactionPayinStatus,
         settled_at: DateTime<Utc>,
-        remitter: Remitter,
+        remitter: ExternalPaymentRemitter,
     },
     Payout {
         #[serde(flatten)]
@@ -102,7 +102,7 @@ pub enum TransactionPayinStatus {
 #[serde(tag = "status", rename_all = "snake_case")]
 pub enum TransactionPayoutStatus {
     Pending,
-    Settled { settled_at: DateTime<Utc> },
+    Executed { executed_at: DateTime<Utc> },
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq, Hash)]

diff --git a/src/apis/payments/api.rs b/src/apis/payments/api.rs
@@ -476,7 +476,7 @@ mod tests {
                     },
                     "beneficiary": {
                         "type": "merchant_account",
-                        "merchant_account_id": "merchant-account-id"
+                        "merchant_account_id": "merchant-account-id",
                     },
                 },
                 "user": {
@@ -509,6 +509,8 @@ mod tests {
                     beneficiary: Beneficiary::MerchantAccount {
                         merchant_account_id: "merchant-account-id".to_string(),
                         account_holder_name: None,
+                        reference: None,
+                        statement_reference: None,
                     },
                 },
                 user: CreatePaymentUserRequest::ExistingUser {
@@ -897,7 +899,9 @@ mod tests {
                 },
                 beneficiary: Beneficiary::MerchantAccount {
                     merchant_account_id: "merchant-account-id".to_string(),
-                    account_holder_name: None
+                    account_holder_name: None,
+                    reference: None,
+                    statement_reference: None
                 }
             }
         );

diff --git a/src/apis/payments/model.rs b/src/apis/payments/model.rs
@@ -251,6 +251,8 @@ pub enum Beneficiary {
     MerchantAccount {
         merchant_account_id: String,
         account_holder_name: Option<String>,
+        reference: Option<String>,
+        statement_reference: Option<String>,
     },
     ExternalAccount {
         account_holder_name: String,
@@ -311,6 +313,13 @@ pub struct Remitter {
     pub account_identifier: Option<AccountIdentifier>,
 }
 
+#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
+pub struct ExternalPaymentRemitter {
+    pub account_holder_name: String,
+    pub account_identifier: AccountIdentifier,
+    pub reference: String,
+}
+
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
 pub struct ProviderFilter {
     pub countries: Option<Vec<CountryCode>>,

diff --git a/src/lib.rs b/src/lib.rs
@@ -64,6 +64,8 @@
 //!             beneficiary: Beneficiary::MerchantAccount {
 //!                 merchant_account_id: "some-merchant-account-id".to_string(),
 //!                 account_holder_name: None,
+//!                 reference: None,
+//!                 statement_reference: None,
 //!             },
 //!         },
 //!         user: CreatePaymentUserRequest::NewUser {

diff --git a/tests/integration_tests/helpers.rs b/tests/integration_tests/helpers.rs
@@ -34,6 +34,8 @@ pub async fn create_closed_loop_payment(
                 beneficiary: Beneficiary::MerchantAccount {
                     merchant_account_id: ctx.merchant_account_gbp_id.clone(),
                     account_holder_name: None,
+                    reference: None,
+                    statement_reference: None,
                 },
             },
             user: CreatePaymentUserRequest::NewUser {

diff --git a/tests/integration_tests/payments.rs b/tests/integration_tests/payments.rs
@@ -61,6 +61,8 @@ async fn hpp_link_returns_200() {
                 beneficiary: Beneficiary::MerchantAccount {
                     merchant_account_id: ctx.merchant_account_gbp_id.clone(),
                     account_holder_name: None,
+                    reference: None,
+                    statement_reference: None,
                 },
             },
             user: CreatePaymentUserRequest::NewUser {
@@ -193,6 +195,8 @@ impl CreatePaymentScenario {
                     ScenarioBeneficiary::ClosedLoop => Beneficiary::MerchantAccount {
                         merchant_account_id: ctx.merchant_account_gbp_id.clone(),
                         account_holder_name: None,
+                        reference: Some("Reference".to_string()),
+                        statement_reference: Some("StReference".to_string()),
                     },
                     ScenarioBeneficiary::OpenLoop {
                         ref account_identifier,