@riocrypto/common-server 1.0.2878 → 1.0.2879

package/build/clients/cluster-client.d.ts

@@ -2,6 +2,30 @@
 /// <reference types="node" />
 import { Quote, Fiat, Crypto, BitsoBankAccount, Side, Country, Order, CryptoAddress, BankAccount, AuthRole, Auth, ImportOrderData, TreasuryProvider, FXProvider, EmarketsFXTrade, ExternalTradingAlgorithm, ExternalTrade, ExternalTradeType, ExternalTradingProvider, ExternalTradingAlgorithmType, STPMXNWithdrawal, AuthPermission, DeferredPaymentType, TwoWaySettlementType, OrderType, EmarketsSettlementType, EmarketsOrderType, BulkBankPayout, BulkCryptoPayout, BulkBankPayment, BulkCryptoPayment, OrderStatus, TWAPSession, TransnetworkFXTrade, TransnetworkSettlementType, TransnetworkOrderType, AuthMethod, StonexFXTrade, CancelExternalTradeReason } from "@riocrypto/common";
 import { STPMXNWithdrawalDoc } from "../models/STP-mxn-withdrawal";
+import { FintocMXNWithdrawalDoc } from "../models/fintoc-mxn-withdrawal";
+export interface FintocTransfer {
+    id: string;
+    amount: number;
+    currency?: string;
+    status?: string;
+    direction?: string;
+    comment?: string;
+    reference_id?: string;
+    tracking_key?: string;
+    receipt_url?: string;
+    created_at?: string;
+    account_number?: {
+        id?: string;
+        number?: string;
+        metadata?: Record<string, string>;
+    };
+    counterparty?: {
+        account_number?: string;
+        holder_name?: string;
+        holder_id?: string;
+        bank_name?: string;
+    };
+}
 declare class ClusterClient {
     private baseUrl;
     private clusterApiKey;
@@ -218,6 +242,9 @@ declare class ClusterClient {
     generateSTPDepositCLABE(userId: string): Promise<{
         CLABE: string;
     }>;
+    generateFintocDepositCLABE(userId: string): Promise<{
+        CLABE: string;
+    }>;
     generateAlfinVirtualCci(userId: string, fiat: Fiat): Promise<{
         CCIV: string;
         codigoPagoCCIV?: string;
@@ -230,7 +257,16 @@ declare class ClusterClient {
     }>;
     getAlfinBalance(fiat: Fiat): Promise<number>;
     getSTPMXNBalance(): Promise<number>;
+    getFintocMXNBalance(): Promise<number>;
     createSTPMXNWithdrawal(amount: number, CLABE: string, concepto: string, beneficiaryName: string, internalTransferId?: string): Promise<STPMXNWithdrawalDoc>;
+    createFintocMXNWithdrawal(amount: number, CLABE: string, concepto: string, beneficiaryName: string, internalTransferId?: string): Promise<FintocMXNWithdrawalDoc>;
+    listFintocTransfers(params: {
+        since?: string;
+        startingAfter?: string;
+        limit?: number;
+    }): Promise<{
+        transfers: FintocTransfer[];
+    }>;
     getSTPMXNWithdrawal(id: string): Promise<STPMXNWithdrawal>;
     createBulkBankPayout(userId: string, payoutBankAccountId: string, deferredPaymentType: DeferredPaymentType): Promise<BulkBankPayout>;
     createBulkCryptoPayout(userId: string, payoutAddressId: string, country: Country, deferredPaymentType: DeferredPaymentType): Promise<BulkCryptoPayout>;

package/build/clients/cluster-client.js

@@ -711,6 +711,12 @@ class ClusterClient {
             return response.data;
         });
     }
+    generateFintocDepositCLABE(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.post(`${this.baseUrl}/api/bank/accounts/fintoc/CLABE`, { userId }, { headers: { "x-cluster-api-key": this.clusterApiKey } });
+            return response.data;
+        });
+    }
     generateAlfinVirtualCci(userId, fiat) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.axios.post(`${this.baseUrl}/api/bank/accounts/alfin/CCIV`, { userId, fiat }, { headers: { "x-cluster-api-key": this.clusterApiKey } });
@@ -735,12 +741,36 @@ class ClusterClient {
             return response.data.balance;
         });
     }
+    getFintocMXNBalance() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.get(`${this.baseUrl}/api/bank/accounts/fintoc/MXN/balance`, { headers: { "x-cluster-api-key": this.clusterApiKey } });
+            return response.data.balance;
+        });
+    }
     createSTPMXNWithdrawal(amount, CLABE, concepto, beneficiaryName, internalTransferId) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.axios.post(`${this.baseUrl}/api/bank/accounts/STP/MXN/withdrawals`, { amount, CLABE, concepto, beneficiaryName, internalTransferId }, { headers: { "x-cluster-api-key": this.clusterApiKey } });
             return response.data;
         });
     }
+    createFintocMXNWithdrawal(amount, CLABE, concepto, beneficiaryName, internalTransferId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.post(`${this.baseUrl}/api/bank/accounts/fintoc/MXN/withdrawals`, { amount, CLABE, concepto, beneficiaryName, internalTransferId }, { headers: { "x-cluster-api-key": this.clusterApiKey } });
+            return response.data;
+        });
+    }
+    // Read-only listing of transfers on Rio's Fintoc treasury account, used by the
+    // liquidity-management treasury import. Paginate with `startingAfter` (the id
+    // of the last transfer from the previous page).
+    listFintocTransfers(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.axios.get(`${this.baseUrl}/api/bank/accounts/fintoc/transfers`, {
+                params,
+                headers: { "x-cluster-api-key": this.clusterApiKey },
+            });
+            return response.data;
+        });
+    }
     getSTPMXNWithdrawal(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.axios.get(`${this.baseUrl}/api/bank/accounts/STP/MXN/withdrawals/${id}`, { headers: { "x-cluster-api-key": this.clusterApiKey } });
@@ -1005,7 +1035,7 @@ const buildClusterClient = () => __awaiter(void 0, void 0, void 0, function* ()
         throw new common_1.SecretManagerError();
     }
     const baseUrl = process.env.RIO_ENV === common_1.RioEnv.Local
-        ? "https://app.local.rio.trade:3443"
+        ? process.env.API_URL || "https://app.local.rio.trade:3443"
         : process.env.RIO_ENV === common_1.RioEnv.Development
             ? "https://app.dev.rio.trade"
             : process.env.RIO_ENV === common_1.RioEnv.Production

package/build/helpers/get-custom-rio-bank-account.d.ts

@@ -0,0 +1,10 @@
+import { Country, Fiat, Processor, User } from "@riocrypto/common";
+import { Mongoose } from "mongoose";
+export declare const getCustomRioBankAccount: ({ mongoose, user, country, fiat, }: {
+    mongoose: Mongoose;
+    user: Pick<User, "rioBankAccount">;
+    country: Country;
+    fiat: Fiat;
+}) => Promise<{
+    processor?: Processor;
+} | undefined>;

package/build/helpers/get-custom-rio-bank-account.js

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCustomRioBankAccount = void 0;
+const rio_bank_account_1 = require("../models/rio-bank-account");
+// Looks up the custom Rio bank account assigned to a user for one corridor, if
+// any. Returning an object with an undefined `processor` is meaningful and is
+// not the same as returning undefined: it says the user does have a custom
+// account but we do not know which rail it belongs to, which routing treats
+// differently from having no custom account at all.
+const getCustomRioBankAccount = ({ mongoose, user, country, fiat, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    const rioBankAccountId = (_c = (_b = (_a = user.rioBankAccount) === null || _a === void 0 ? void 0 : _a[country]) === null || _b === void 0 ? void 0 : _b[fiat]) === null || _c === void 0 ? void 0 : _c.id;
+    if (!rioBankAccountId) {
+        return undefined;
+    }
+    const RioBankAccount = (0, rio_bank_account_1.buildRioBankAccount)(mongoose);
+    const rioBankAccount = yield RioBankAccount.findById(rioBankAccountId)
+        .select({ processor: 1 })
+        .lean();
+    // A dangling reference still means the user is on a custom account as far as
+    // routing is concerned. getBankDetails throws on it, and that error is far
+    // easier to act on than a payin silently routed to a shared rail.
+    if (!rioBankAccount) {
+        return {};
+    }
+    return { processor: rioBankAccount.processor };
+});
+exports.getCustomRioBankAccount = getCustomRioBankAccount;

package/build/helpers/get-processor.d.ts

@@ -1,9 +1,12 @@
-import { Country, Fiat, Processor, Side, User } from "@riocrypto/common";
-export declare const getProcessor: ({ country, fiat, user, activeProcessors, side, isBinanceRFQ, }: {
+import { Country, Fiat, Processor, ProcessorRoutingConfig, Side } from "@riocrypto/common";
+export declare const getProcessor: ({ country, fiat, side, isBinanceRFQ, routingConfig, disabledProcessors, customRioBankAccount, }: {
     country: Country;
     fiat: Fiat;
-    user: User;
-    activeProcessors: Processor[];
     side: Side;
     isBinanceRFQ: boolean;
+    routingConfig?: ProcessorRoutingConfig | undefined;
+    disabledProcessors?: Processor[] | undefined;
+    customRioBankAccount?: {
+        processor?: Processor | undefined;
+    } | undefined;
 }) => Processor;

package/build/helpers/get-processor.js

@@ -2,18 +2,80 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProcessor = void 0;
 const common_1 = require("@riocrypto/common");
+const resolve_processor_1 = require("./resolve-processor");
 // Alfin takes effect only in Production (Alfin prod). In every other
-// environment we never route to Alfin, regardless of user attributes or active
-// processors; non-prod Peru flows fall back to the mocked Interbank path.
+// environment we never route to Alfin, regardless of what the routing config
+// says; non-prod Peru flows fall back to the mocked Interbank path.
 const isAlfinEnabled = () => [common_1.RioEnv.Production].includes(process.env.RIO_ENV);
-const getProcessor = ({ country, fiat, user, activeProcessors, side, isBinanceRFQ, }) => {
-    var _a, _b, _c, _d, _e, _f;
+// How far STP reaches depends on the direction. Allocating a deposit CLABE runs
+// in Production alone, so a buy routed to STP anywhere else has no account for
+// the customer to pay into. Payouts run in Development too, alongside the payout
+// retry cron and the treasury imports it depends on.
+//
+// Covers what the rio-settings validator cannot: it rejects an STP share outside
+// Production and Development, but says nothing about the structural default.
+// Mexican pesos name a second default rail for exactly this reason.
+const isSTPAvailable = (purpose) => (purpose === common_1.ProcessorRoutingPurpose.Buy
+    ? [common_1.RioEnv.Production]
+    : [common_1.RioEnv.Production, common_1.RioEnv.Development]).includes(process.env.RIO_ENV);
+const getProcessor = ({ country, fiat, side, isBinanceRFQ, routingConfig, disabledProcessors, customRioBankAccount, }) => {
     if (isBinanceRFQ === true) {
         return common_1.Processor.BinanceRFQ;
     }
+    const purpose = side === common_1.Side.Buy
+        ? common_1.ProcessorRoutingPurpose.Buy
+        : common_1.ProcessorRoutingPurpose.Sell;
+    const excludedProcessors = [
+        ...(isAlfinEnabled() ? [] : [common_1.Processor.Alfin]),
+        ...(isSTPAvailable(purpose) ? [] : [common_1.Processor.SPEI_STP]),
+    ];
+    // Applied only inside the branches that genuinely have more than one rail, so
+    // a stray rule cannot hijack structural routing (COP, USD in the US or Mexico)
+    // or bypass the country checks below. Returns undefined when no rule is
+    // configured, leaving the corridor's structural default in charge.
+    const trySplit = () => {
+        const routed = (0, resolve_processor_1.resolveProcessor)({
+            country,
+            fiat,
+            purpose,
+            routingConfig,
+            excludedProcessors,
+            disabledProcessors,
+            customRioBankAccount,
+        });
+        if (routed.processor) {
+            return routed.processor;
+        }
+        // Every rail in this corridor is switched off for this direction, so there is
+        // nowhere to send them - a rail at zero percent would still have taken the
+        // order. Says so specifically, and names where to fix it, since the fix is
+        // theirs to make rather than something support has to escalate.
+        if (routed.reason === "noEnabledCandidate") {
+            throw new common_1.GenericInputError(side === common_1.Side.Buy
+                ? "You need to enable a payment account for this currency before you can buy. You can turn one back on from the payment accounts page."
+                : "You need to enable a payout account for this currency before you can sell. You can turn one back on from the payout accounts page.");
+        }
+        // No rail in the corridor can be reached in this environment at all, which is
+        // a deployment fact rather than anything the customer can act on.
+        if (routed.reason === "noEligibleCandidate") {
+            throw new common_1.GenericInputError("No payment processor is currently available for this order");
+        }
+        return undefined;
+    };
+    // The rail this corridor runs on when no split decides it, from the one table
+    // the routing editor reads as well - so the page can name the rail an empty
+    // split leaves in charge. Throwing on a missing entry keeps the two honest: a
+    // corridor that gets this far has to have a default.
+    const structural = () => {
+        const fallback = (0, common_1.getDefaultProcessor)(country, fiat, purpose, excludedProcessors);
+        if (!fallback) {
+            throw new common_1.GenericInputError("No payment processor is configured for this currency");
+        }
+        return fallback;
+    };
     if (fiat === common_1.Fiat.COP) {
         if (country === common_1.Country.Colombia) {
-            return common_1.Processor.Coltefinanciera;
+            return structural();
         }
         else {
             throw new common_1.GenericInputError("COP is not supported in your country");
@@ -21,19 +83,7 @@ const getProcessor = ({ country, fiat, user, activeProcessors, side, isBinanceRF
     }
     else if (fiat === common_1.Fiat.PEN) {
         if (country === common_1.Country.Peru) {
-            if (side === common_1.Side.Buy &&
-                isAlfinEnabled() &&
-                ((_a = user.attributes) === null || _a === void 0 ? void 0 : _a.includes(common_1.UserAttribute.UseAlfinForPENDeposits)) &&
-                activeProcessors.includes(common_1.Processor.Alfin)) {
-                return common_1.Processor.Alfin;
-            }
-            if (side === common_1.Side.Sell &&
-                isAlfinEnabled() &&
-                ((_b = user.attributes) === null || _b === void 0 ? void 0 : _b.includes(common_1.UserAttribute.UseAlfinForPENWithdrawals)) &&
-                activeProcessors.includes(common_1.Processor.Alfin)) {
-                return common_1.Processor.Alfin;
-            }
-            return common_1.Processor.Interbank;
+            return trySplit() || structural();
         }
         else {
             throw new common_1.GenericInputError("PEN is not supported in your country");
@@ -41,28 +91,7 @@ const getProcessor = ({ country, fiat, user, activeProcessors, side, isBinanceRF
     }
     else if (fiat === common_1.Fiat.MXN) {
         if (country === common_1.Country.Mexico) {
-            if ((side === common_1.Side.Sell &&
-                ((_c = user.attributes) === null || _c === void 0 ? void 0 : _c.includes(common_1.UserAttribute.UseSTPForMXNWithdrawals))) ||
-                (side === common_1.Side.Buy &&
-                    ((_d = user.attributes) === null || _d === void 0 ? void 0 : _d.includes(common_1.UserAttribute.UseSTPForMXNDeposits)))) {
-                if (activeProcessors.includes(common_1.Processor.SPEI_STP)) {
-                    return common_1.Processor.SPEI_STP;
-                }
-                else if (activeProcessors.includes(common_1.Processor.SPEI_NVIO)) {
-                    return common_1.Processor.SPEI_NVIO;
-                }
-                else {
-                    return common_1.Processor.SPEI;
-                }
-            }
-            else {
-                if (activeProcessors.includes(common_1.Processor.SPEI_NVIO)) {
-                    return common_1.Processor.SPEI_NVIO;
-                }
-                else {
-                    return common_1.Processor.SPEI;
-                }
-            }
+            return trySplit() || structural();
         }
         else {
             throw new common_1.GenericInputError("MXN is not supported in your country");
@@ -70,25 +99,13 @@ const getProcessor = ({ country, fiat, user, activeProcessors, side, isBinanceRF
     }
     else if (fiat === common_1.Fiat.USD) {
         if (country === common_1.Country.UnitedStates) {
-            return common_1.Processor.Bridge;
+            return structural();
         }
         else if (country === common_1.Country.Mexico) {
-            return common_1.Processor.SPID;
+            return structural();
         }
         else if (country === common_1.Country.Peru) {
-            if (side === common_1.Side.Buy &&
-                isAlfinEnabled() &&
-                ((_e = user.attributes) === null || _e === void 0 ? void 0 : _e.includes(common_1.UserAttribute.UseAlfinForUSDDeposits)) &&
-                activeProcessors.includes(common_1.Processor.Alfin)) {
-                return common_1.Processor.Alfin;
-            }
-            if (side === common_1.Side.Sell &&
-                isAlfinEnabled() &&
-                ((_f = user.attributes) === null || _f === void 0 ? void 0 : _f.includes(common_1.UserAttribute.UseAlfinForUSDWithdrawals)) &&
-                activeProcessors.includes(common_1.Processor.Alfin)) {
-                return common_1.Processor.Alfin;
-            }
-            return common_1.Processor.Interbank;
+            return trySplit() || structural();
         }
         else {
             throw new common_1.GenericInputError("USD is not supported in your country");

package/build/helpers/get-tax-rate.js

@@ -8,6 +8,7 @@ const getTaxRate = (user, country, fiat, processor) => {
     if ((fiat === common_1.Fiat.MXN && processor === common_1.Processor.SPEI) ||
         (fiat === common_1.Fiat.MXN && processor === common_1.Processor.SPEI_NVIO) ||
         (fiat === common_1.Fiat.MXN && processor === common_1.Processor.SPEI_STP) ||
+        (fiat === common_1.Fiat.MXN && processor === common_1.Processor.SPEI_FINTOC) ||
         (fiat === common_1.Fiat.USD && processor === common_1.Processor.SPID)) {
         if (country === common_1.Country.Mexico &&
             ((_a = user === null || user === void 0 ? void 0 : user.address) === null || _a === void 0 ? void 0 : _a.country) === common_1.CountryOfOrigin.Mexico) {

package/build/helpers/payin-destinations.d.ts

@@ -0,0 +1,37 @@
+import { Country, Fiat, Processor, ProcessorReadinessStatus, User } from "@riocrypto/common";
+import { Mongoose } from "mongoose";
+export interface PayinBankDetails {
+    bankName?: string;
+    companyName?: string;
+    companyAddress?: string;
+    accountNumber?: string;
+    CCI?: string;
+    RUC?: string;
+    CLABE?: string;
+    RFC?: string;
+    bankAddress?: string;
+    NIT?: string;
+}
+export declare const PER_USER_PAYIN_PROCESSORS: Processor[];
+export declare const getPayinBankDetails: ({ mongoose, processor, fiat, country, user, }: {
+    mongoose: Mongoose;
+    processor: Processor;
+    fiat: Fiat;
+    country: Country;
+    user: User;
+}) => Promise<PayinBankDetails>;
+export interface PayinDestination {
+    processor: Processor;
+    bankDetails: PayinBankDetails;
+    isProvisioned: boolean;
+    isEnabled: boolean;
+    readinessStatus?: ProcessorReadinessStatus;
+}
+export declare const getPayinDestinations: ({ mongoose, user, country, fiat, processors, provision, }: {
+    mongoose: Mongoose;
+    user: User;
+    country: Country;
+    fiat: Fiat;
+    processors: Processor[];
+    provision?: boolean | undefined;
+}) => Promise<PayinDestination[]>;