Adds a new account identifier type of BIC (#533)

sipsorcery · web-flow · commit 33eff674a88b · 2025-03-21T08:23:52.000Z
* Adjusted payout and related models for new payout BIC and country code fields.

* Updated account identifier logic.
diff --git a/src/NoFrixion.MoneyMoov/Enums/AccountIdentifierType.cs b/src/NoFrixion.MoneyMoov/Enums/AccountIdentifierType.cs
@@ -42,5 +42,10 @@ public enum AccountIdentifierType
     /// <summary>
     /// Bitcoin address.
     /// </summary>
-    BTC = 4
+    BTC = 4,
+
+    /// <summary>
+    /// Bank Identifier Code. Used for international payments. In addition to the BIC an account number and country code are required.
+    /// </summary>
+    BIC = 5
 }
diff --git a/src/NoFrixion.MoneyMoov/Mapping/CounterpartyMappers.cs b/src/NoFrixion.MoneyMoov/Mapping/CounterpartyMappers.cs
diff --git a/src/NoFrixion.MoneyMoov/Models/Account/AccountIdentifier.cs b/src/NoFrixion.MoneyMoov/Models/Account/AccountIdentifier.cs
@@ -8,6 +8,7 @@
 //  History:
 //  21 10 2021  Donal O'Connor   Created, Carmichael House, Dublin, Ireland.
 //  19 09 2023  Aaron Clauson    Added Bitcoin support.
+//  20 03 2025  Aaron Clauson    Added support for BIC identifier type.
 // 
 //  License:
 //  MIT.
@@ -30,14 +31,18 @@ public AccountIdentifierType Type
     {
         get
         {
-            if(!string.IsNullOrWhiteSpace(IBAN))
+            if (!string.IsNullOrWhiteSpace(IBAN))
             {
                 return AccountIdentifierType.IBAN;
             }
-            else if(!string.IsNullOrWhiteSpace(SortCode) && !string.IsNullOrWhiteSpace(AccountNumber))
+            else if (!string.IsNullOrWhiteSpace(SortCode))
             {
                 return AccountIdentifierType.SCAN;
             }
+            else if (!string.IsNullOrWhiteSpace(BIC))
+            {
+                return AccountIdentifierType.BIC;
+            }
 
             return AccountIdentifierType.Unknown;
         }
@@ -157,6 +162,7 @@ public string BitcoinAddress
     public string Summary =>
         Type == AccountIdentifierType.IBAN ? Type.ToString() + ": " + IBAN :
         Type == AccountIdentifierType.SCAN ? Type.ToString() + ": " + DisplayScanSummary :
+        Type == AccountIdentifierType.BIC ? Type.ToString() + ": " + DisplayBicSummary :
          "No identifier.";
 
     /// <summary>
@@ -165,13 +171,16 @@ public string BitcoinAddress
     public string DisplaySummary =>
         Type == AccountIdentifierType.IBAN ? IBAN :
         Type == AccountIdentifierType.SCAN ? DisplayScanSummary :
+        Type == AccountIdentifierType.BIC ? DisplayBicSummary :
         "No identifier.";
 
     public string DisplayScanSummary =>
         Currency == CurrencyTypeEnum.GBP && !string.IsNullOrEmpty(SortCode) && !string.IsNullOrEmpty(AccountNumber) && SortCode.Length == GBP_SORT_CODE_LENGTH
             ? $"{SortCode[..2]}-{SortCode.Substring(2, 2)}-{SortCode.Substring(4, 2)} {AccountNumber}"
             : $"{SortCode} {AccountNumber}";
 
+    public string DisplayBicSummary => $"{BIC} {AccountNumber}";
+
     public bool IsSameDestination(AccountIdentifier other)
     {
         if (other == null)
@@ -188,6 +197,7 @@ public bool IsSameDestination(AccountIdentifier other)
         {
             AccountIdentifierType.IBAN => IBAN == other.IBAN,
             AccountIdentifierType.SCAN => SortCode == other.SortCode && AccountNumber == other.AccountNumber,
+            AccountIdentifierType.BIC => BIC == other.BIC && AccountNumber == other.AccountNumber,
             _ => false
         };
     }
@@ -200,7 +210,8 @@ public virtual Dictionary<string, string> ToDictionary(string keyPrefix)
             { keyPrefix + nameof(BIC), BIC ?? string.Empty},
             { keyPrefix + nameof(IBAN), IBAN ?? string.Empty},
             { keyPrefix + nameof(SortCode), SortCode ?? string.Empty},
-            { keyPrefix + nameof(AccountNumber), AccountNumber ?? string.Empty}
+            { keyPrefix + nameof(AccountNumber), AccountNumber ?? string.Empty},
+            { keyPrefix + nameof(BIC), BIC ?? string.Empty},
         };
     }
 
@@ -236,39 +247,45 @@ public NoFrixionProblem Validate()
 
     public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
     {
-        switch (Currency)
+        switch (Type)
         {
-            // GBP & USD support both IBAN and SCAN.
-            case CurrencyTypeEnum.GBP:
-            case CurrencyTypeEnum.USD:
+            case AccountIdentifierType.IBAN:
+                if (string.IsNullOrWhiteSpace(IBAN))
                 {
-                    if (string.IsNullOrWhiteSpace(IBAN) && 
-                        (string.IsNullOrWhiteSpace(SortCode) || string.IsNullOrWhiteSpace(AccountNumber)))
+                    yield return new ValidationResult(
+                        $"The IBAN value is required for a {AccountIdentifierType.IBAN} identifier.",
+                        [nameof(IBAN)]);
+                }
+                break;
+
+            case AccountIdentifierType.SCAN:
+                {
+                    if (string.IsNullOrWhiteSpace(SortCode) || string.IsNullOrWhiteSpace(AccountNumber))
                     {
                         yield return new ValidationResult(
-                            $"Either the IBAN or Sort code and account number are required for a {Currency} account identifier.",
-                            [nameof(IBAN), nameof(SortCode), nameof(AccountNumber)]);
+                            $"The sort code and account number are required for a {AccountIdentifierType.SCAN} identifier.",
+                            [nameof(SortCode), nameof(AccountNumber)]);
                     }
 
                     break;
                 }
 
-            // EUR only supports IBAN.
-            case CurrencyTypeEnum.EUR:
+            case AccountIdentifierType.BIC:
                 {
-                    if (string.IsNullOrEmpty(IBAN))
+                    if (string.IsNullOrWhiteSpace(BIC) || string.IsNullOrWhiteSpace(AccountNumber))
                     {
-                        yield return new ValidationResult("IBAN is required for EUR account identifier.",
-                             [nameof(IBAN)]);
+                        yield return new ValidationResult(
+                            $"The BIC and account number are required for a {AccountIdentifierType.BIC} identifier.",
+                            [nameof(BIC), nameof(AccountNumber)]);
                     }
 
                     break;
                 }
 
             default:
                 {
-                    yield return new ValidationResult($"Currency {Currency} was not recognised when validating an account identifier.",
-                        [nameof(Currency)]);
+                    yield return new ValidationResult($"Identifier {Type} was not recognised when validating an account identifier.",
+                        [nameof(Type)]);
                     break;
                 }
         }
diff --git a/src/NoFrixion.MoneyMoov/Models/Account/AccountIdentifierCreate.cs b/src/NoFrixion.MoneyMoov/Models/Account/AccountIdentifierCreate.cs
@@ -85,7 +85,7 @@ public string SortCode
     }
 
     /// <summary>
-    /// Bank account number. Only applicable for SCAN identifiers.
+    /// Bank account number. Only applicable for SCAN and BIC identifiers.
     /// </summary>
     private string _accountNumber;
     public string AccountNumber
diff --git a/src/NoFrixion.MoneyMoov/Models/Account/CounterpartyCreate.cs b/src/NoFrixion.MoneyMoov/Models/Account/CounterpartyCreate.cs
@@ -42,10 +42,18 @@ public class CounterpartyCreate
     /// </summary>
     public string? EmailAddress { get; set; }
 
-    /// An email address for the counterparty. Optional to set and depending on the payment
+    /// <summary>
+    /// A phone number for the counterparty. Optional to set and depending on the payment
     /// network does not always get set for pay ins.
+    /// </summary>
     public string? PhoneNumber { get; set; }
 
+    /// <summary>
+    /// A country code for the counterparty. Optional to set and depending on the payment
+    /// network does not always get set for pay ins
+    /// </summary>
+    public string? CountryCode { get; set; }
+
     /// <summary>
     /// The counterparty's account identifier. This identifier is what is used to send the payment
     /// to them, or for a pay in is the source of the payment.
@@ -61,6 +69,7 @@ public virtual Dictionary<string, string> ToDictionary(string keyPrefix)
              { keyPrefix + nameof(Name), Name ?? string.Empty },
              { keyPrefix + nameof(EmailAddress), EmailAddress ?? string.Empty },
              { keyPrefix + nameof(PhoneNumber), PhoneNumber ?? string.Empty },
+             { keyPrefix + nameof(CountryCode), CountryCode ?? string.Empty },
         };
 
         if(Identifier != null)
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs
@@ -308,13 +308,22 @@ public Counterparty? DestinationAccount
     /// For Bitcoin payouts, when this flag is set the network fee will be deducted from the send amount.
     /// THis is particularly useful for sweeps where it can be difficult to calculate the exact fee required.
     /// </summary>
+    [Obsolete]
+    [System.Text.Json.Serialization.JsonIgnore]
+    [Newtonsoft.Json.JsonIgnore]
     public bool BitcoinSubtractFeeFromAmount { get; set; }
 
     /// <summary>
     /// The Bitcoin fee rate to apply in Satoshis per virtual byte.
     /// </summary>
+    [Obsolete]
+    [System.Text.Json.Serialization.JsonIgnore]
+    [Newtonsoft.Json.JsonIgnore]
     public int BitcoinFeeSatsPerVbyte { get; set; }
 
+    [Obsolete]
+    [System.Text.Json.Serialization.JsonIgnore]
+    [Newtonsoft.Json.JsonIgnore]
     public string FormattedBitcoinFee => $"{BitcoinFeeSatsPerVbyte} sats/vbyte" +
         (BitcoinSubtractFeeFromAmount ? " (fee will be subtracted from amount)" : "");
 
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs
@@ -39,7 +39,7 @@ public class PayoutCreate
     public CurrencyTypeEnum Currency { get; set; }
 
     [Required(ErrorMessage = "Amount is required.")]
-    [Range(0.00001, double.MaxValue,ErrorMessage = "Minimum value of 0.00001 is required for Amount")]
+    [Range(0.00001, double.MaxValue,ErrorMessage = "Minimum value of 0.01 is required for Amount")]
     public decimal Amount { get; set; }
 
     /// <summary>
@@ -151,11 +151,13 @@ public CounterpartyCreate? DestinationAccount
     /// <summary>
     /// For Bitcoin payouts, when this flag is set the network fee will be deducted from the send amount. This is particularly useful for sweeps where it can be difficult to calculate the exact fee required.
     /// </summary>
+    [Obsolete]
     public bool BitcoinSubtractFeeFromAmount { get; set; }
 
     /// <summary>
     /// The Bitcoin fee rate to apply in Satoshis per virtual byte.
     /// </summary>
+    [Obsolete]
     public int BitcoinFeeSatsPerVbyte { get; set; }
     
     /// <summary>
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutsValidator.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutsValidator.cs
@@ -371,7 +371,7 @@ public static IEnumerable<ValidationResult> Validate(Payout payout, ValidationCo
             }
 
             if (payout.Destination != null &&
-                !(payout.Type == AccountIdentifierType.IBAN || payout.Type == AccountIdentifierType.SCAN))
+                !(payout.Type == AccountIdentifierType.IBAN || payout.Type == AccountIdentifierType.SCAN || payout.Type == AccountIdentifierType.BIC))
             {
                 yield return new ValidationResult("Only destination types of IBAN and SCAN are supported.", [ nameof(payout.Type) ]);
             }
diff --git a/src/NoFrixion.MoneyMoov/Models/Transaction/Counterparty.cs b/src/NoFrixion.MoneyMoov/Models/Transaction/Counterparty.cs
@@ -52,10 +52,18 @@ public class Counterparty
     /// </summary>
     public string? EmailAddress { get; set; }
 
-    /// An email address for the counterparty. Optional to set and depending on the payment
+    /// <summary>
+    /// A phone number for the counterparty. Optional to set and depending on the payment
     /// network does not always get set for pay ins.
+    /// </summary>
     public string? PhoneNumber { get; set; }
 
+    /// <summary>
+    /// A country code for the counterparty. Optional to set and depending on the payment
+    /// network does not always get set for pay ins
+    /// </summary>
+    public string? CountryCode { get; set; }
+
     /// <summary>
     /// The counterparty's account identifier. This identifier is what is used to send the payment
     /// to them, or for a pay in is the source of the payment.
@@ -113,6 +121,7 @@ public virtual Dictionary<string, string> ToDictionary(string keyPrefix)
              { keyPrefix + nameof(Name), Name ?? string.Empty },
              { keyPrefix + nameof(EmailAddress), EmailAddress ?? string.Empty },
              { keyPrefix + nameof(PhoneNumber), PhoneNumber ?? string.Empty },
+             { keyPrefix + nameof(CountryCode), CountryCode ?? string.Empty },
         };
 
         if(Identifier != null)
@@ -135,6 +144,7 @@ public virtual string GetApprovalHash()
             (!string.IsNullOrEmpty(Name) ? Name : string.Empty) +
             (!string.IsNullOrEmpty(EmailAddress) ? EmailAddress : string.Empty) +
             (!string.IsNullOrEmpty(PhoneNumber) ? PhoneNumber : string.Empty) +
+            (!string.IsNullOrEmpty(CountryCode) ? CountryCode : string.Empty) +
             (Identifier != null ? Identifier.GetApprovalHash() : string.Empty);
         return HashHelper.CreateHash(input);
     }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`// History:`
`9`	`9`	`// 21 10 2021 Donal O'Connor Created, Carmichael House, Dublin, Ireland.`
`10`	`10`	`// 19 09 2023 Aaron Clauson Added Bitcoin support.`
	`11`	`+// 20 03 2025 Aaron Clauson Added support for BIC identifier type.`
`11`	`12`	`//`
`12`	`13`	`// License:`
`13`	`14`	`// MIT.`
`@@ -30,14 +31,18 @@ public AccountIdentifierType Type`
`30`	`31`	`{`
`31`	`32`	`get`
`32`	`33`	`{`
`33`		`- if(!string.IsNullOrWhiteSpace(IBAN))`
	`34`	`+ if (!string.IsNullOrWhiteSpace(IBAN))`
`34`	`35`	`{`
`35`	`36`	`return AccountIdentifierType.IBAN;`
`36`	`37`	`}`
`37`		`- else if(!string.IsNullOrWhiteSpace(SortCode) && !string.IsNullOrWhiteSpace(AccountNumber))`
	`38`	`+ else if (!string.IsNullOrWhiteSpace(SortCode))`
`38`	`39`	`{`
`39`	`40`	`return AccountIdentifierType.SCAN;`
`40`	`41`	`}`
	`42`	`+ else if (!string.IsNullOrWhiteSpace(BIC))`
	`43`	`+ {`
	`44`	`+ return AccountIdentifierType.BIC;`
	`45`	`+ }`
`41`	`46`
`42`	`47`	`return AccountIdentifierType.Unknown;`
`43`	`48`	`}`
`@@ -157,6 +162,7 @@ public string BitcoinAddress`
`157`	`162`	`public string Summary =>`
`158`	`163`	`Type == AccountIdentifierType.IBAN ? Type.ToString() + ": " + IBAN :`
`159`	`164`	`Type == AccountIdentifierType.SCAN ? Type.ToString() + ": " + DisplayScanSummary :`
	`165`	`+ Type == AccountIdentifierType.BIC ? Type.ToString() + ": " + DisplayBicSummary :`
`160`	`166`	`"No identifier.";`
`161`	`167`
`162`	`168`	`/// <summary>`
`@@ -165,13 +171,16 @@ public string BitcoinAddress`
`165`	`171`	`public string DisplaySummary =>`
`166`	`172`	`Type == AccountIdentifierType.IBAN ? IBAN :`
`167`	`173`	`Type == AccountIdentifierType.SCAN ? DisplayScanSummary :`
	`174`	`+ Type == AccountIdentifierType.BIC ? DisplayBicSummary :`
`168`	`175`	`"No identifier.";`
`169`	`176`
`170`	`177`	`public string DisplayScanSummary =>`
`171`	`178`	`Currency == CurrencyTypeEnum.GBP && !string.IsNullOrEmpty(SortCode) && !string.IsNullOrEmpty(AccountNumber) && SortCode.Length == GBP_SORT_CODE_LENGTH`
`172`	`179`	`? $"{SortCode[..2]}-{SortCode.Substring(2, 2)}-{SortCode.Substring(4, 2)} {AccountNumber}"`
`173`	`180`	`: $"{SortCode} {AccountNumber}";`
`174`	`181`
	`182`	`+ public string DisplayBicSummary => $"{BIC} {AccountNumber}";`
	`183`	`+`
`175`	`184`	`public bool IsSameDestination(AccountIdentifier other)`
`176`	`185`	`{`
`177`	`186`	`if (other == null)`
`@@ -188,6 +197,7 @@ public bool IsSameDestination(AccountIdentifier other)`
`188`	`197`	`{`
`189`	`198`	`AccountIdentifierType.IBAN => IBAN == other.IBAN,`
`190`	`199`	`AccountIdentifierType.SCAN => SortCode == other.SortCode && AccountNumber == other.AccountNumber,`
	`200`	`+ AccountIdentifierType.BIC => BIC == other.BIC && AccountNumber == other.AccountNumber,`
`191`	`201`	`_ => false`
`192`	`202`	`};`
`193`	`203`	`}`
`@@ -200,7 +210,8 @@ public virtual Dictionary<string, string> ToDictionary(string keyPrefix)`
`200`	`210`	`{ keyPrefix + nameof(BIC), BIC ?? string.Empty},`
`201`	`211`	`{ keyPrefix + nameof(IBAN), IBAN ?? string.Empty},`
`202`	`212`	`{ keyPrefix + nameof(SortCode), SortCode ?? string.Empty},`
`203`		`- { keyPrefix + nameof(AccountNumber), AccountNumber ?? string.Empty}`
	`213`	`+ { keyPrefix + nameof(AccountNumber), AccountNumber ?? string.Empty},`
	`214`	`+ { keyPrefix + nameof(BIC), BIC ?? string.Empty},`
`204`	`215`	`};`
`205`	`216`	`}`
`206`	`217`
`@@ -236,39 +247,45 @@ public NoFrixionProblem Validate()`
`236`	`247`
`237`	`248`	`public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)`
`238`	`249`	`{`
`239`		`- switch (Currency)`
	`250`	`+ switch (Type)`
`240`	`251`	`{`
`241`		`- // GBP & USD support both IBAN and SCAN.`
`242`		`- case CurrencyTypeEnum.GBP:`
`243`		`- case CurrencyTypeEnum.USD:`
	`252`	`+ case AccountIdentifierType.IBAN:`
	`253`	`+ if (string.IsNullOrWhiteSpace(IBAN))`
`244`	`254`	`{`
`245`		`- if (string.IsNullOrWhiteSpace(IBAN) &&`
`246`		`- (string.IsNullOrWhiteSpace(SortCode) \|\| string.IsNullOrWhiteSpace(AccountNumber)))`
	`255`	`+ yield return new ValidationResult(`
	`256`	`+ $"The IBAN value is required for a {AccountIdentifierType.IBAN} identifier.",`
	`257`	`+ [nameof(IBAN)]);`
	`258`	`+ }`
	`259`	`+ break;`
	`260`	`+`
	`261`	`+ case AccountIdentifierType.SCAN:`
	`262`	`+ {`
	`263`	`+ if (string.IsNullOrWhiteSpace(SortCode) \|\| string.IsNullOrWhiteSpace(AccountNumber))`
`247`	`264`	`{`
`248`	`265`	`yield return new ValidationResult(`
`249`		`- $"Either the IBAN or Sort code and account number are required for a {Currency} account identifier.",`
`250`		`- [nameof(IBAN), nameof(SortCode), nameof(AccountNumber)]);`
	`266`	`+ $"The sort code and account number are required for a {AccountIdentifierType.SCAN} identifier.",`
	`267`	`+ [nameof(SortCode), nameof(AccountNumber)]);`
`251`	`268`	`}`
`252`	`269`
`253`	`270`	`break;`
`254`	`271`	`}`
`255`	`272`
`256`		`- // EUR only supports IBAN.`
`257`		`- case CurrencyTypeEnum.EUR:`
	`273`	`+ case AccountIdentifierType.BIC:`
`258`	`274`	`{`
`259`		`- if (string.IsNullOrEmpty(IBAN))`
	`275`	`+ if (string.IsNullOrWhiteSpace(BIC) \|\| string.IsNullOrWhiteSpace(AccountNumber))`
`260`	`276`	`{`
`261`		`- yield return new ValidationResult("IBAN is required for EUR account identifier.",`
`262`		`- [nameof(IBAN)]);`
	`277`	`+ yield return new ValidationResult(`
	`278`	`+ $"The BIC and account number are required for a {AccountIdentifierType.BIC} identifier.",`
	`279`	`+ [nameof(BIC), nameof(AccountNumber)]);`
`263`	`280`	`}`
`264`	`281`
`265`	`282`	`break;`
`266`	`283`	`}`
`267`	`284`
`268`	`285`	`default:`
`269`	`286`	`{`
`270`		`- yield return new ValidationResult($"Currency {Currency} was not recognised when validating an account identifier.",`
`271`		`- [nameof(Currency)]);`
	`287`	`+ yield return new ValidationResult($"Identifier {Type} was not recognised when validating an account identifier.",`
	`288`	`+ [nameof(Type)]);`
`272`	`289`	`break;`
`273`	`290`	`}`
`274`	`291`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public string SortCode`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`/// <summary>`
`88`		`- /// Bank account number. Only applicable for SCAN identifiers.`
	`88`	`+ /// Bank account number. Only applicable for SCAN and BIC identifiers.`
`89`	`89`	`/// </summary>`
`90`	`90`	`private string _accountNumber;`
`91`	`91`	`public string AccountNumber`
Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ public static IEnumerable<ValidationResult> Validate(Payout payout, ValidationCo`
`371`	`371`	`}`
`372`	`372`
`373`	`373`	`if (payout.Destination != null &&`
`374`		`- !(payout.Type == AccountIdentifierType.IBAN \|\| payout.Type == AccountIdentifierType.SCAN))`
	`374`	`+ !(payout.Type == AccountIdentifierType.IBAN \|\| payout.Type == AccountIdentifierType.SCAN \|\| payout.Type == AccountIdentifierType.BIC))`
`375`	`375`	`{`
`376`	`376`	`yield return new ValidationResult("Only destination types of IBAN and SCAN are supported.", [ nameof(payout.Type) ]);`
`377`	`377`	`}`