Mural Pay integration (#4520)

* wip: muralpay integration * Basic Mural Pay API bindings * Fix clippy * use dotenvy in muralpay example * Refactor payout creation code * wip: muralpay payout requests * Mural Pay payouts work * Fix clippy * add mural pay fees API * Work on payout fee API * Fees API for more payment methods * Fix CI * Temporarily disable Venmo and PayPal methods from frontend * wip: counterparties * Start on counterparties and payment methods API * Mural Pay multiple methods when fetching * Don't send supported_countries to frontend * Add countries to muralpay fiat methods * Compile fix * Add exchange rate info to fees endpoint * Add fees to premium Tremendous options * Add delivery email field to Tremendous payouts * Add Tremendous product category to payout methods * Add bank details API to muralpay * Fix CI * Fix CI * Remove prepaid visa, compute fees properly for Tremendous methods * Add more details to Tremendous errors * Add fees to Mural * Payout history route and bank details * Re-add legacy PayPal/Venmo options for US * move the mural bank details route * Add utoipa support to payout endpoints * address some PR comments * add CORS to new utoipa routes * Immediately approve mural payouts * Add currency support to Tremendous payouts * Currency forex * add forex to tremendous fee request * Add Mural balance to bank balance info * Add more Tremendous currencies support * Transaction payouts available use the correct date * Address my own review comment * Address PR comments * Change Mural withdrawal limit to 3k * maybe fix tremendous gift cards * Change how Mural minimum withdrawals are calculated * Tweak min/max withdrawal values --------- Co-authored-by: Calum H. <contact@cal.engineer> Co-authored-by: Alejandro González <me@alegon.dev>
2025-11-03 14:19:46 -08:00
parent b11934054d
commit 17f395ee55
34 changed files with 4381 additions and 690 deletions
--- a/packages/muralpay/src/organization.rs
+++ b/packages/muralpay/src/organization.rs
@@ -0,0 +1,277 @@
+use std::str::FromStr;
+
+use chrono::{DateTime, Utc};
+use derive_more::{Deref, Display};
+use secrecy::ExposeSecret;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+use crate::{
+    CurrencyCode, MuralError, MuralPay, SearchResponse, util::RequestExt,
+};
+
+impl MuralPay {
+    pub async fn search_organizations(
+        &self,
+        req: SearchRequest,
+    ) -> Result<SearchResponse<OrganizationId, Organization>, MuralError> {
+        #[derive(Debug, Serialize)]
+        #[serde(rename_all = "camelCase")]
+        struct Body {
+            #[serde(skip_serializing_if = "Option::is_none")]
+            filter: Option<Filter>,
+        }
+
+        #[derive(Debug, Serialize)]
+        #[serde(rename_all = "camelCase")]
+        struct Filter {
+            #[serde(rename = "type")]
+            ty: FilterType,
+            name: String,
+        }
+
+        #[derive(Debug, Clone, Copy, Serialize)]
+        #[serde(rename_all = "snake_case")]
+        pub enum FilterType {
+            Name,
+        }
+
+        let query = [
+            req.limit.map(|limit| ("limit", limit.to_string())),
+            req.next_id
+                .map(|next_id| ("nextId", next_id.hyphenated().to_string())),
+        ]
+        .into_iter()
+        .flatten()
+        .collect::<Vec<_>>();
+
+        let body = Body {
+            filter: req.name.map(|name| Filter {
+                ty: FilterType::Name,
+                name,
+            }),
+        };
+
+        self.http_post(|base| format!("{base}/api/organizations/search"))
+            .bearer_auth(self.api_key.expose_secret())
+            .query(&query)
+            .json(&body)
+            .send_mural()
+            .await
+    }
+
+    pub async fn get_organization(
+        &self,
+        id: OrganizationId,
+    ) -> Result<Organization, MuralError> {
+        self.http_post(|base| format!("{base}/api/organizations/{id}"))
+            .send_mural()
+            .await
+    }
+}
+
+#[derive(
+    Debug,
+    Display,
+    Clone,
+    Copy,
+    PartialEq,
+    Eq,
+    Hash,
+    Deref,
+    Serialize,
+    Deserialize,
+)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[display("{}", _0.hyphenated())]
+pub struct OrganizationId(pub Uuid);
+
+impl FromStr for OrganizationId {
+    type Err = <Uuid as FromStr>::Err;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        s.parse::<Uuid>().map(Self)
+    }
+}
+
+#[derive(Debug, Clone, Default)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+pub struct SearchRequest {
+    pub limit: Option<u64>,
+    pub next_id: Option<Uuid>,
+    pub name: Option<String>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "snake_case")]
+pub enum Organization {
+    Individual(Individual),
+    Business(Business),
+    EndUserCustodialIndividual(EndUserCustodialIndividual),
+    EndUserCustodialBusiness(EndUserCustodialBusiness),
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct Individual {
+    pub id: OrganizationId,
+    pub created_at: DateTime<Utc>,
+    pub updated_at: DateTime<Utc>,
+    pub first_name: String,
+    pub last_name: String,
+    pub tos_status: TosStatus,
+    pub kyc_status: KycStatus,
+    pub currency_capabilities: Vec<CurrencyCapability>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct Business {
+    pub id: OrganizationId,
+    pub created_at: DateTime<Utc>,
+    pub updated_at: DateTime<Utc>,
+    pub name: String,
+    pub tos_status: TosStatus,
+    pub kyc_status: KycStatus,
+    pub currency_capabilities: Vec<CurrencyCapability>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct EndUserCustodialIndividual {
+    pub id: OrganizationId,
+    pub created_at: DateTime<Utc>,
+    pub updated_at: DateTime<Utc>,
+    pub first_name: String,
+    pub last_name: String,
+    pub approver: Approver,
+    pub tos_status: TosStatus,
+    pub kyc_status: KycStatus,
+    pub currency_capabilities: Vec<CurrencyCapability>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct EndUserCustodialBusiness {
+    pub id: OrganizationId,
+    pub created_at: DateTime<Utc>,
+    pub updated_at: DateTime<Utc>,
+    pub name: String,
+    pub approver: Approver,
+    pub tos_status: TosStatus,
+    pub kyc_status: KycStatus,
+    pub currency_capabilities: Vec<CurrencyCapability>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct Approver {
+    pub id: Uuid,
+    pub created_at: DateTime<Utc>,
+    pub name: String,
+    pub email: String,
+    pub auth_methods: Vec<String>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "SCREAMING_SNAKE_CASE")]
+pub enum TosStatus {
+    NotAccepted,
+    NeedsReview,
+    Accepted,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "camelCase")]
+pub enum KycStatus {
+    Inactive,
+    Pending,
+    Approved {
+        approved_at: DateTime<Utc>,
+    },
+    Errored {
+        details: String,
+        errored_at: DateTime<Utc>,
+    },
+    Rejected {
+        reason: String,
+        rejected_at: DateTime<Utc>,
+    },
+    PreValidationFailed {
+        failed_validation_reason: FailedValidationReason,
+        failed_validation_at: DateTime<Utc>,
+    },
+    NeedsUpdate {
+        needs_update_reason: String,
+        verification_status_updated_at: DateTime<Utc>,
+    },
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "camelCase")]
+pub enum FailedValidationReason {
+    DocumentPrevalidationFailed {
+        document_id: String,
+        failed_validation_reason: String,
+    },
+    UltimateBeneficialOwnerPrevalidationFailed {
+        ultimate_beneficial_owner_id: String,
+        failed_validation_reason: String,
+    },
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(rename_all = "camelCase")]
+pub struct CurrencyCapability {
+    pub fiat_and_rail_code: String,
+    pub currency_code: CurrencyCode,
+    pub deposit_status: TransactionCapabilityStatus,
+    pub pay_out_status: TransactionCapabilityStatus,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "camelCase")]
+pub enum TransactionCapabilityStatus {
+    TermsOfService {
+        details: String,
+    },
+    #[serde(rename = "awaitingKYC")]
+    AwaitingKyc {
+        details: String,
+    },
+    Enabled,
+    Rejected {
+        reason: RejectedReason,
+        details: String,
+    },
+    Disabled {
+        reason: DisabledReason,
+        details: String,
+    },
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "SCREAMING_SNAKE_CASE")]
+pub enum RejectedReason {
+    KycFailed,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[serde(tag = "type", rename_all = "SCREAMING_SNAKE_CASE")]
+pub enum DisabledReason {
+    CapabilityUnavailable,
+    ProcessingError,
+}