@riocrypto/common 1.0.2694 → 1.0.2698

package/build/events/bank-account-verification-dispatched-event.d.ts

@@ -4,7 +4,7 @@ export interface BankAccountVerificationDispatchedEvent {
     subject: Subjects.BankAccountVerificationDispatched;
     data: {
         id: string;
-        provider?: Processor.SPEI_STP | Processor.SPEI_NVIO | Processor.Alfin;
+        provider?: Processor.SPEI_STP | Processor.SPEI_NVIO | Processor.SPEI_FINTOC | Processor.Alfin;
         providerWithdrawalId?: string;
     };
 }

package/build/events/fintoc-deposit-CLABE-created-event.d.ts

@@ -0,0 +1,7 @@
+import { Subjects } from "./subjects";
+export interface FintocDepositCLABECreatedEvent {
+    subject: Subjects.FintocDepositCLABECreated;
+    data: {
+        id: string;
+    };
+}

package/build/events/fintoc-deposit-CLABE-created-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/fintoc-deposit-completed-event.d.ts

@@ -0,0 +1,8 @@
+import { Subjects } from "./subjects";
+export interface FintocDepositCompletedEvent {
+    subject: Subjects.FintocDepositCompleted;
+    data: {
+        internalTransferId: string;
+        amount: number;
+    };
+}

package/build/events/fintoc-deposit-completed-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/fintoc-payment-received-event.d.ts

@@ -0,0 +1,12 @@
+import { Subjects } from "./subjects";
+export interface FintocPaymentReceivedEvent {
+    subject: Subjects.FintocPaymentReceived;
+    data: {
+        orderId?: string;
+        bulkBankPaymentId?: string;
+        amount: number;
+        originAccountHolderName?: string;
+        originCLABE?: string;
+        originBank?: string;
+    };
+}

package/build/events/fintoc-payment-received-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/fintoc-withdrawal-completed-event.d.ts

@@ -0,0 +1,14 @@
+import { Subjects } from "./subjects";
+export interface FintocWithdrawalCompletedEvent {
+    subject: Subjects.FintocWithdrawalCompleted;
+    data: {
+        orderId?: string;
+        bulkBankPayoutId?: string;
+        internalTransferId?: string;
+        amount: number;
+        fintocTransferId?: string;
+        trackingKey?: string;
+        receiptUrl?: string;
+        reference?: string;
+    };
+}

package/build/events/fintoc-withdrawal-completed-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/fintoc-withdrawal-failed-event.d.ts

@@ -0,0 +1,11 @@
+import { BankPayoutFailureReason } from "../types/bank-payout-failure-reason";
+import { Subjects } from "./subjects";
+export interface FintocWithdrawalFailedEvent {
+    subject: Subjects.FintocWithdrawalFailed;
+    data: {
+        orderId?: string;
+        bulkBankPayoutId?: string;
+        reason: BankPayoutFailureReason;
+        errorMessage?: string;
+    };
+}

package/build/events/fintoc-withdrawal-failed-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/fintoc-withdrawal-initiated-event.d.ts

@@ -0,0 +1,7 @@
+import { Subjects } from "./subjects";
+export interface FintocWithdrawalInitiatedEvent {
+    subject: Subjects.FintocWithdrawalInitiated;
+    data: {
+        orderId: string;
+    };
+}

package/build/events/fintoc-withdrawal-initiated-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/inbound-fintoc-bank-deposit-received-event.d.ts

@@ -0,0 +1,15 @@
+import { Fiat } from "../types/fiat";
+import { Subjects } from "./subjects";
+export interface InboundFintocBankDepositReceivedEvent {
+    subject: Subjects.InboundFintocBankDepositReceived;
+    data: {
+        fiat: Fiat;
+        amount: number;
+        originAccountHolderName: string;
+        originAccountNumber?: string;
+        originCLABE?: string;
+        originBank?: string;
+        reference?: string;
+        fintocTransferId: string;
+    };
+}

package/build/events/inbound-fintoc-bank-deposit-received-event.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/rio-settings-updated-event.d.ts

@@ -3,7 +3,6 @@ import { DeferredPaymentType } from "../types/deferred-payment-type";
 import { Fiat } from "../types/fiat";
 import { FXProvider } from "../types/fx-provider";
 import { FXTradingPolicies } from "../types/fx-trading-policy";
-import { Processor } from "../types/processor";
 import { Side } from "../types/side";
 import { TVFXDataProvider } from "../types/TV-FX-data-provider";
 import { Subjects } from "./subjects";
@@ -67,11 +66,6 @@ export interface RioSettingsUpdatedEvent {
                 [key in Side]?: number;
             };
         };
-        activeFiatPaymentProcessors?: {
-            [Side.Buy]: Processor[];
-            [Side.Sell]: Processor[];
-            bankAccountVerifications: Processor[];
-        };
         TVFXDataProvider?: {
             [key in Fiat]?: TVFXDataProvider;
         };

package/build/events/rio-settings-updated-event.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const side_1 = require("../types/side");

package/build/events/subjects.d.ts

@@ -174,6 +174,13 @@ export declare enum Subjects {
     STPWithdrawalFailed = "stpWithdrawal:failed",
     STPWithdrawalCompleted = "stpWithdrawal:completed",
     STPDepositCompleted = "stpDeposit:completed",
+    FintocWithdrawalInitiated = "fintocWithdrawal:initiated",
+    FintocWithdrawalFailed = "fintocWithdrawal:failed",
+    FintocWithdrawalCompleted = "fintocWithdrawal:completed",
+    FintocDepositCompleted = "fintocDeposit:completed",
+    FintocPaymentReceived = "fintocPayment:received",
+    FintocDepositCLABECreated = "fintocDepositCLABE:created",
+    InboundFintocBankDepositReceived = "inboundFintocBankDeposit:received",
     LiquidityOrderCreated = "liquidityOrder:created",
     OnboardingUpdated = "onboarding:updated",
     OnboardingCreated = "onboarding:created",

package/build/events/subjects.js

@@ -178,6 +178,13 @@ var Subjects;
     Subjects["STPWithdrawalFailed"] = "stpWithdrawal:failed";
     Subjects["STPWithdrawalCompleted"] = "stpWithdrawal:completed";
     Subjects["STPDepositCompleted"] = "stpDeposit:completed";
+    Subjects["FintocWithdrawalInitiated"] = "fintocWithdrawal:initiated";
+    Subjects["FintocWithdrawalFailed"] = "fintocWithdrawal:failed";
+    Subjects["FintocWithdrawalCompleted"] = "fintocWithdrawal:completed";
+    Subjects["FintocDepositCompleted"] = "fintocDeposit:completed";
+    Subjects["FintocPaymentReceived"] = "fintocPayment:received";
+    Subjects["FintocDepositCLABECreated"] = "fintocDepositCLABE:created";
+    Subjects["InboundFintocBankDepositReceived"] = "inboundFintocBankDeposit:received";
     Subjects["LiquidityOrderCreated"] = "liquidityOrder:created";
     Subjects["OnboardingUpdated"] = "onboarding:updated";
     Subjects["OnboardingCreated"] = "onboarding:created";

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

@@ -0,0 +1,5 @@
+import { Country } from "../types/country";
+import { Fiat } from "../types/fiat";
+import { Processor } from "../types/processor";
+import { ProcessorRoutingPurpose } from "../types/processor-routing";
+export declare const getDefaultProcessor: (country: Country, fiat: Fiat, purpose: ProcessorRoutingPurpose, excludedProcessors?: Processor[]) => Processor | undefined;

package/build/helpers/get-default-processor.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultProcessor = void 0;
+const country_1 = require("../types/country");
+const fiat_1 = require("../types/fiat");
+const processor_1 = require("../types/processor");
+const processor_routing_1 = require("../types/processor-routing");
+// The rail a corridor runs on when no split is configured for a purpose, in
+// order of preference.
+//
+// These were literals inside getProcessor, which meant nothing else could name
+// them: the routing editor could only say "its default processor" and leave an
+// operator to go read the routing code, and the liquidity callers had to restate
+// the same rail from memory and hope they still matched. Single-rail corridors are
+// included too - COP, US dollars - where the default is simply the only option.
+//
+// More than one entry only where the first choice cannot be reached everywhere.
+// The head of the list is the rail we mean to use; the rest exist so an
+// environment that cannot talk to it still has somewhere to send an order.
+const DEFAULT_PROCESSORS = {
+    [country_1.Country.Mexico]: {
+        [fiat_1.Fiat.MXN]: {
+            // STP cannot be reached from every environment, so buys and sells each
+            // name a second rail for the ones that cannot. Fondeadora (Processor.SPEI)
+            // can only stand in on buys: its payouts are keyed in by hand, so a sell
+            // defaulted there would sit in awaitingPayout with no service to dispatch
+            // it. Verifications need no stand-in - the only caller picks the rail
+            // itself when routing gives it nothing usable.
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.SPEI_STP, processor_1.Processor.SPEI],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.SPEI_STP, processor_1.Processor.SPEI_NVIO],
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [processor_1.Processor.SPEI_STP],
+        },
+        [fiat_1.Fiat.USD]: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.SPID],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.SPID],
+        },
+    },
+    [country_1.Country.Peru]: {
+        [fiat_1.Fiat.PEN]: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [processor_1.Processor.Alfin],
+        },
+        [fiat_1.Fiat.USD]: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [processor_1.Processor.Alfin],
+        },
+    },
+    [country_1.Country.Colombia]: {
+        [fiat_1.Fiat.COP]: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Coltefinanciera],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Coltefinanciera],
+        },
+    },
+    [country_1.Country.UnitedStates]: {
+        [fiat_1.Fiat.USD]: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Bridge],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Bridge],
+        },
+    },
+};
+// Pass the environment's excluded rails to get the default that can actually be
+// used there. Called without them it answers with the rail we mean to use, which
+// is what the routing editor should name whatever environment it runs in.
+const getDefaultProcessor = (country, fiat, purpose, excludedProcessors) => {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = DEFAULT_PROCESSORS[country]) === null || _a === void 0 ? void 0 : _a[fiat]) === null || _b === void 0 ? void 0 : _b[purpose]) === null || _c === void 0 ? void 0 : _c.find((processor) => !(excludedProcessors === null || excludedProcessors === void 0 ? void 0 : excludedProcessors.includes(processor)));
+};
+exports.getDefaultProcessor = getDefaultProcessor;

package/build/helpers/get-processors-for-corridor.d.ts

@@ -0,0 +1,10 @@
+import { Country } from "../types/country";
+import { Fiat } from "../types/fiat";
+import { Processor } from "../types/processor";
+import { ProcessorRoutingPurpose } from "../types/processor-routing";
+export declare const getProcessorsForCorridor: (country: Country, fiat: Fiat, purpose: ProcessorRoutingPurpose) => Processor[];
+export declare const getCorridorsForPurpose: (purpose: ProcessorRoutingPurpose) => {
+    country: Country;
+    fiat: Fiat;
+    processors: Processor[];
+}[];

package/build/helpers/get-processors-for-corridor.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCorridorsForPurpose = exports.getProcessorsForCorridor = void 0;
+const country_1 = require("../types/country");
+const fiat_1 = require("../types/fiat");
+const processor_1 = require("../types/processor");
+const processor_routing_1 = require("../types/processor-routing");
+// Every rail that can serve a country/fiat, by what it is serving. The single
+// source of truth for three questions that used to be answered by three
+// separate tables: which splits the rio-settings validator accepts, which
+// corridors the routing editor offers, and which accounts a customer has to
+// whitelist to fund a buy.
+//
+// A corridor with one rail for a purpose is structural rather than a commercial
+// choice - COP is always Coltefinanciera, USD is Bridge in the US and SPID in
+// Mexico - so a split against it is rejected instead of silently ignored. A
+// corridor can also serve one purpose and not another: Mexican pesos reach three
+// rails on a sell, four on a buy, and two for a verification.
+const CORRIDOR_PROCESSORS = [
+    {
+        country: country_1.Country.Mexico,
+        fiat: fiat_1.Fiat.MXN,
+        processors: {
+            // Fondeadora (Processor.SPEI) withdrawals are keyed in by hand, so it can
+            // only take buys; giving it a sell share would route customers into a rail
+            // nothing dispatches.
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [
+                processor_1.Processor.SPEI_STP,
+                processor_1.Processor.SPEI_FINTOC,
+                processor_1.Processor.SPEI_NVIO,
+                processor_1.Processor.SPEI,
+            ],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [
+                processor_1.Processor.SPEI_STP,
+                processor_1.Processor.SPEI_FINTOC,
+                processor_1.Processor.SPEI_NVIO,
+            ],
+            // NVIO is deliberately absent: nothing dispatches an NVIO micro-deposit,
+            // so giving it a share would silently fall through to the default rail.
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [
+                processor_1.Processor.SPEI_STP,
+                processor_1.Processor.SPEI_FINTOC,
+            ],
+        },
+    },
+    {
+        country: country_1.Country.Mexico,
+        fiat: fiat_1.Fiat.USD,
+        processors: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.SPID],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.SPID],
+            // No verification purpose: a micro-deposit only has an amount for MXN, so
+            // a Mexican USD account is never verified that way.
+        },
+    },
+    {
+        country: country_1.Country.Peru,
+        fiat: fiat_1.Fiat.PEN,
+        processors: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Alfin, processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Alfin, processor_1.Processor.Interbank],
+            // Alfin is the only programmatic Peru provider, so verifications there
+            // are structural.
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [processor_1.Processor.Alfin],
+        },
+    },
+    {
+        country: country_1.Country.Peru,
+        fiat: fiat_1.Fiat.USD,
+        processors: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Alfin, processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Alfin, processor_1.Processor.Interbank],
+            [processor_routing_1.ProcessorRoutingPurpose.BankAccountVerification]: [processor_1.Processor.Alfin],
+        },
+    },
+    {
+        country: country_1.Country.Colombia,
+        fiat: fiat_1.Fiat.COP,
+        processors: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Coltefinanciera],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Coltefinanciera],
+        },
+    },
+    {
+        country: country_1.Country.UnitedStates,
+        fiat: fiat_1.Fiat.USD,
+        processors: {
+            [processor_routing_1.ProcessorRoutingPurpose.Buy]: [processor_1.Processor.Bridge],
+            [processor_routing_1.ProcessorRoutingPurpose.Sell]: [processor_1.Processor.Bridge],
+        },
+    },
+];
+const getProcessorsForCorridor = (country, fiat, purpose) => {
+    var _a;
+    return ((_a = CORRIDOR_PROCESSORS.find((corridor) => corridor.country === country && corridor.fiat === fiat)) === null || _a === void 0 ? void 0 : _a.processors[purpose]) || [];
+};
+exports.getProcessorsForCorridor = getProcessorsForCorridor;
+// Every corridor that serves the purpose at all, single-rail ones included. The
+// routing editor shows those read-only: there is nothing to decide, but an
+// operator should still be able to see where a corridor's money goes without
+// reading the routing code to find out. Whether a corridor can be split is left
+// to the caller, which is the length of the list it gets back.
+const getCorridorsForPurpose = (purpose) => CORRIDOR_PROCESSORS.map((corridor) => ({
+    country: corridor.country,
+    fiat: corridor.fiat,
+    processors: corridor.processors[purpose] || [],
+})).filter((corridor) => corridor.processors.length > 0);
+exports.getCorridorsForPurpose = getCorridorsForPurpose;

package/build/helpers/get-routing-candidates.d.ts

@@ -0,0 +1,10 @@
+import { Country } from "../types/country";
+import { Fiat } from "../types/fiat";
+import { Processor } from "../types/processor";
+import { ProcessorRoutingConfig, ProcessorRoutingPurpose } from "../types/processor-routing";
+export declare const getRoutingCandidates: ({ country, fiat, purpose, routingConfig, }: {
+    country: Country;
+    fiat: Fiat;
+    purpose: ProcessorRoutingPurpose;
+    routingConfig?: ProcessorRoutingConfig | undefined;
+}) => Processor[];

package/build/helpers/get-routing-candidates.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRoutingCandidates = void 0;
+const get_default_processor_1 = require("./get-default-processor");
+const get_processors_for_corridor_1 = require("./get-processors-for-corridor");
+// The rails an order in this corridor could end up on: whatever the split gives
+// a share to, or the corridor's default when nothing is configured.
+//
+// For callers that have to answer a question before the rail is drawn - how much
+// liquidity is available, what a quote preview should show - since the draw
+// happens per order, the honest answer covers every rail the order could get.
+// Never used to pick a rail: that is `resolveProcessor`'s job, and it drops the
+// rails the customer has switched off, which this deliberately ignores.
+//
+// One case it therefore misses: a customer who has switched off every rail the
+// split gives a share to is routed to one of the rails they left on, since a zero
+// share is not an off switch. Naming that rail here would take their enablement
+// records, which these callers do not read, so a preview for such a customer can
+// still name a rail they will not get.
+const getRoutingCandidates = ({ country, fiat, purpose, routingConfig, }) => {
+    var _a, _b;
+    const rule = (_b = (_a = routingConfig === null || routingConfig === void 0 ? void 0 : routingConfig[country]) === null || _a === void 0 ? void 0 : _a[fiat]) === null || _b === void 0 ? void 0 : _b[purpose];
+    if (!rule) {
+        const fallback = (0, get_default_processor_1.getDefaultProcessor)(country, fiat, purpose);
+        return fallback ? [fallback] : [];
+    }
+    return (0, get_processors_for_corridor_1.getProcessorsForCorridor)(country, fiat, purpose).filter((processor) => (rule.percentages[processor] || 0) > 0);
+};
+exports.getRoutingCandidates = getRoutingCandidates;

package/build/helpers/verifiable-payin-processors.d.ts

@@ -0,0 +1,3 @@
+import { Processor } from "../types/processor";
+export declare const VERIFIABLE_PAYIN_PROCESSORS: Processor[];
+export declare const isPayinVerifiable: (processor: Processor) => boolean;

package/build/helpers/verifiable-payin-processors.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPayinVerifiable = exports.VERIFIABLE_PAYIN_PROCESSORS = void 0;
+const processor_1 = require("../types/processor");
+// Rails whose payins land in a shared Rio account and whose inbound activity we
+// receive programmatically. Both halves matter: the shared account is what the
+// customer has to whitelist with their own bank before they can fund an order,
+// and the inbound feed is what lets a test deposit - or a real one - prove they
+// have done it.
+//
+// Only these rails can offer a test deposit. Interbank and SPID (Bancrea) are
+// deliberately absent: neither gives us an inbound feed, so a test sent to them
+// could never be matched and the customer would be left waiting on a result that
+// will not come.
+//
+// Says nothing about routing. Whether a rail takes a customer's buys is decided
+// by whether they have it enabled, which applies to every rail - see
+// resolveProcessor.
+exports.VERIFIABLE_PAYIN_PROCESSORS = [
+    processor_1.Processor.SPEI_STP,
+    processor_1.Processor.SPEI_FINTOC,
+    processor_1.Processor.SPEI_NVIO,
+    processor_1.Processor.SPEI,
+    processor_1.Processor.Alfin,
+];
+const isPayinVerifiable = (processor) => exports.VERIFIABLE_PAYIN_PROCESSORS.includes(processor);
+exports.isPayinVerifiable = isPayinVerifiable;

package/build/index.d.ts

@@ -179,6 +179,13 @@ export * from "./events/alfin-payment-received-event";
 export * from "./events/alfin-withdrawal-completed-event";
 export * from "./events/alfin-withdrawal-failed-event";
 export * from "./events/STP-deposit-CLABE-created-event";
+export * from "./events/fintoc-withdrawal-initiated-event";
+export * from "./events/fintoc-withdrawal-failed-event";
+export * from "./events/fintoc-withdrawal-completed-event";
+export * from "./events/fintoc-deposit-completed-event";
+export * from "./events/fintoc-payment-received-event";
+export * from "./events/fintoc-deposit-CLABE-created-event";
+export * from "./events/inbound-fintoc-bank-deposit-received-event";
 export * from "./events/axe-created-event";
 export * from "./events/axe-partially-taken-event";
 export * from "./events/axe-taken-event";
@@ -284,6 +291,9 @@ export * from "./types/order-status";
 export * from "./types/payment-method";
 export * from "./types/payout-method";
 export * from "./types/processor";
+export * from "./types/processor-routing";
+export * from "./types/processor-readiness";
+export * from "./types/payment-address-verification";
 export * from "./types/side";
 export * from "./types/auth";
 export * from "./types/auth-update";
@@ -436,6 +446,9 @@ export * from "./types/admin-auth-dashboard-settings";
 export * from "./types/STP-mxn-withdrawal";
 export * from "./types/STP-deposit-CLABE";
 export * from "./types/STP-settings";
+export * from "./types/fintoc-mxn-withdrawal";
+export * from "./types/fintoc-mxn-withdrawal-status";
+export * from "./types/fintoc-deposit-CLABE";
 export * from "./types/axe";
 export * from "./types/axe-status";
 export * from "./types/TV-FX-data-provider";
@@ -564,6 +577,10 @@ export * from "./helpers/get-country-timezone";
 export * from "./helpers/get-active-platform-fee-ranges";
 export * from "./helpers/find-platform-fee-range-conflict";
 export * from "./helpers/get-country-for-fiat";
+export * from "./helpers/get-processors-for-corridor";
+export * from "./helpers/get-default-processor";
+export * from "./helpers/get-routing-candidates";
+export * from "./helpers/verifiable-payin-processors";
 export * from "./helpers/get-days-between-agreed-two-way-settlement-date-and-payment-date";
 export * from "./helpers/get-days-until-two-way-settlement-date";
 export * from "./helpers/get-two-way-settlement-date-offset-from-date";

package/build/index.js

@@ -195,6 +195,13 @@ __exportStar(require("./events/alfin-payment-received-event"), exports);
 __exportStar(require("./events/alfin-withdrawal-completed-event"), exports);
 __exportStar(require("./events/alfin-withdrawal-failed-event"), exports);
 __exportStar(require("./events/STP-deposit-CLABE-created-event"), exports);
+__exportStar(require("./events/fintoc-withdrawal-initiated-event"), exports);
+__exportStar(require("./events/fintoc-withdrawal-failed-event"), exports);
+__exportStar(require("./events/fintoc-withdrawal-completed-event"), exports);
+__exportStar(require("./events/fintoc-deposit-completed-event"), exports);
+__exportStar(require("./events/fintoc-payment-received-event"), exports);
+__exportStar(require("./events/fintoc-deposit-CLABE-created-event"), exports);
+__exportStar(require("./events/inbound-fintoc-bank-deposit-received-event"), exports);
 __exportStar(require("./events/axe-created-event"), exports);
 __exportStar(require("./events/axe-partially-taken-event"), exports);
 __exportStar(require("./events/axe-taken-event"), exports);
@@ -300,6 +307,9 @@ __exportStar(require("./types/order-status"), exports);
 __exportStar(require("./types/payment-method"), exports);
 __exportStar(require("./types/payout-method"), exports);
 __exportStar(require("./types/processor"), exports);
+__exportStar(require("./types/processor-routing"), exports);
+__exportStar(require("./types/processor-readiness"), exports);
+__exportStar(require("./types/payment-address-verification"), exports);
 __exportStar(require("./types/side"), exports);
 __exportStar(require("./types/auth"), exports);
 __exportStar(require("./types/auth-update"), exports);
@@ -452,6 +462,9 @@ __exportStar(require("./types/admin-auth-dashboard-settings"), exports);
 __exportStar(require("./types/STP-mxn-withdrawal"), exports);
 __exportStar(require("./types/STP-deposit-CLABE"), exports);
 __exportStar(require("./types/STP-settings"), exports);
+__exportStar(require("./types/fintoc-mxn-withdrawal"), exports);
+__exportStar(require("./types/fintoc-mxn-withdrawal-status"), exports);
+__exportStar(require("./types/fintoc-deposit-CLABE"), exports);
 __exportStar(require("./types/axe"), exports);
 __exportStar(require("./types/axe-status"), exports);
 __exportStar(require("./types/TV-FX-data-provider"), exports);
@@ -580,6 +593,10 @@ __exportStar(require("./helpers/get-country-timezone"), exports);
 __exportStar(require("./helpers/get-active-platform-fee-ranges"), exports);
 __exportStar(require("./helpers/find-platform-fee-range-conflict"), exports);
 __exportStar(require("./helpers/get-country-for-fiat"), exports);
+__exportStar(require("./helpers/get-processors-for-corridor"), exports);
+__exportStar(require("./helpers/get-default-processor"), exports);
+__exportStar(require("./helpers/get-routing-candidates"), exports);
+__exportStar(require("./helpers/verifiable-payin-processors"), exports);
 __exportStar(require("./helpers/get-days-between-agreed-two-way-settlement-date-and-payment-date"), exports);
 __exportStar(require("./helpers/get-days-until-two-way-settlement-date"), exports);
 __exportStar(require("./helpers/get-two-way-settlement-date-offset-from-date"), exports);

package/build/types/bank-account-verification.d.ts

@@ -7,7 +7,7 @@ export interface BankAccountVerification {
     bankAccountId: string;
     status: BankAccountVerificationStatus;
     amount: number;
-    provider?: Processor.SPEI_STP | Processor.SPEI_NVIO;
+    provider?: Processor.SPEI_STP | Processor.SPEI_NVIO | Processor.SPEI_FINTOC;
     providerWithdrawalId?: string;
     SPEITrackingNumber?: string;
     CEPLink?: string;

package/build/types/fintoc-deposit-CLABE.d.ts

@@ -0,0 +1,12 @@
+export interface FintocDepositCLABE {
+    id: string;
+    createdAt: Date;
+    userId: string;
+    CLABE: string;
+    fintocAccountNumberId?: string;
+    processedFintocEventIds?: string[];
+    orderId?: string;
+    metadata?: Record<string, string>;
+    disabled?: boolean;
+    disabledAt?: Date;
+}

package/build/types/fintoc-deposit-CLABE.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/fintoc-mxn-withdrawal-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum FintocMXNWithdrawalStatus {
+    PendingApproval = "pendingApproval",
+    Processing = "processing",
+    Complete = "complete",
+    Failed = "failed",
+    Cancelled = "cancelled"
+}

package/build/types/fintoc-mxn-withdrawal-status.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FintocMXNWithdrawalStatus = void 0;
+var FintocMXNWithdrawalStatus;
+(function (FintocMXNWithdrawalStatus) {
+    FintocMXNWithdrawalStatus["PendingApproval"] = "pendingApproval";
+    FintocMXNWithdrawalStatus["Processing"] = "processing";
+    FintocMXNWithdrawalStatus["Complete"] = "complete";
+    FintocMXNWithdrawalStatus["Failed"] = "failed";
+    FintocMXNWithdrawalStatus["Cancelled"] = "cancelled";
+})(FintocMXNWithdrawalStatus = exports.FintocMXNWithdrawalStatus || (exports.FintocMXNWithdrawalStatus = {}));

package/build/types/fintoc-mxn-withdrawal.d.ts

@@ -0,0 +1,22 @@
+import { FintocMXNWithdrawalStatus } from "./fintoc-mxn-withdrawal-status";
+export interface FintocMXNWithdrawal {
+    createdAt: Date;
+    type: "transaction" | "bankAccountVerification" | "liquidityOrder" | "internalTransfer";
+    orderId?: string;
+    internalTransferId?: string;
+    bankAccountVerificationId?: string;
+    orderVersion?: number;
+    bulkBankPayoutId?: string;
+    FintocWithdrawals: {
+        uuid: string;
+        fintocTransferId?: string;
+        trackingKey?: string;
+        idempotencyKey?: string;
+        partNumber: number;
+        amount: number;
+        reference: string;
+        status: FintocMXNWithdrawalStatus;
+    }[];
+    numberOfParts?: number;
+    partsCompleted?: number;
+}

package/build/types/fintoc-mxn-withdrawal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/map-imported-transfer-status.js

@@ -43,6 +43,10 @@ const CATEGORY_TOKENS = [
             "completed",
             "success",
             "successful",
+            // Fintoc reports terminal success as "succeeded", which shares no
+            // substring with "success" and would otherwise fall through to Other.
+            "succeeded",
+            "succeed",
             "settled",
             "confirmed",
             "credited",

package/build/types/payment-address-verification.d.ts

@@ -0,0 +1,24 @@
+import { Crypto } from "./crypto";
+import { ProcessorReadinessStatus, ProcessorReadinessVerificationMethod } from "./processor-readiness";
+export interface PaymentAddressVerification {
+    id: string;
+    createdAt: Date;
+    userId: string;
+    crypto: Crypto;
+    fireblocksVaultId: string;
+    address: string;
+    memo?: string;
+    status: ProcessorReadinessStatus;
+    testAmount?: number;
+    observedTransfer?: {
+        amount: number;
+        blockchainTxId?: string;
+        fireblocksTransferId?: string;
+        originBlockchainAddress?: string;
+        receivedAt: Date;
+    };
+    verifiedAt?: Date;
+    verifiedVia?: ProcessorReadinessVerificationMethod;
+    verifiedByAdminId?: string;
+    verificationNote?: string;
+}

package/build/types/payment-address-verification.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/processor-readiness.d.ts

@@ -0,0 +1,38 @@
+import { Country } from "./country";
+import { Fiat } from "./fiat";
+import { Processor } from "./processor";
+import { Side } from "./side";
+export declare enum ProcessorReadinessStatus {
+    Provisioned = "provisioned",
+    AwaitingTestDeposit = "awaitingTestDeposit",
+    Verified = "verified",
+    Failed = "failed"
+}
+export declare enum ProcessorReadinessVerificationMethod {
+    TestDeposit = "testDeposit",
+    ObservedDeposit = "observedDeposit",
+    AdminOverride = "adminOverride"
+}
+export interface ProcessorReadiness {
+    id: string;
+    createdAt: Date;
+    userId: string;
+    country: Country;
+    fiat: Fiat;
+    processor: Processor;
+    enablement?: {
+        [side in Side]?: {
+            isEnabled: boolean;
+            updatedAt: Date;
+            updatedByAdminId?: string;
+        };
+    };
+    status: ProcessorReadinessStatus;
+    CLABE?: string;
+    testReference?: string;
+    testAmount?: number;
+    verifiedAt?: Date;
+    verifiedVia?: ProcessorReadinessVerificationMethod;
+    verifiedByAdminId?: string;
+    verificationNote?: string;
+}

package/build/types/processor-readiness.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorReadinessVerificationMethod = exports.ProcessorReadinessStatus = void 0;
+var ProcessorReadinessStatus;
+(function (ProcessorReadinessStatus) {
+    // A payin destination exists for the user on this rail, but we have not seen
+    // money arrive through it yet, so we cannot assume their whitelist allows it.
+    ProcessorReadinessStatus["Provisioned"] = "provisioned";
+    // The user has been given a test amount and reference and we are waiting for
+    // the deposit to land.
+    ProcessorReadinessStatus["AwaitingTestDeposit"] = "awaitingTestDeposit";
+    ProcessorReadinessStatus["Verified"] = "verified";
+    ProcessorReadinessStatus["Failed"] = "failed";
+})(ProcessorReadinessStatus = exports.ProcessorReadinessStatus || (exports.ProcessorReadinessStatus = {}));
+var ProcessorReadinessVerificationMethod;
+(function (ProcessorReadinessVerificationMethod) {
+    // A deliberate test deposit that the user was asked to send.
+    ProcessorReadinessVerificationMethod["TestDeposit"] = "testDeposit";
+    // A real order payin that arrived on this rail. Proves the same thing a test
+    // deposit does, so it verifies the rail without asking the customer for
+    // anything.
+    ProcessorReadinessVerificationMethod["ObservedDeposit"] = "observedDeposit";
+    // An admin asserted the user can pay this rail. Recorded with who and why,
+    // because a wrong assertion strands their orders on an undeliverable CLABE.
+    ProcessorReadinessVerificationMethod["AdminOverride"] = "adminOverride";
+})(ProcessorReadinessVerificationMethod = exports.ProcessorReadinessVerificationMethod || (exports.ProcessorReadinessVerificationMethod = {}));

package/build/types/processor-routing.d.ts

@@ -0,0 +1,20 @@
+import { Country } from "./country";
+import { Fiat } from "./fiat";
+import { Processor } from "./processor";
+export declare enum ProcessorRoutingPurpose {
+    Buy = "buy",
+    Sell = "sell",
+    BankAccountVerification = "bankAccountVerification"
+}
+export interface ProcessorRoutingRule {
+    percentages: {
+        [key in Processor]?: number;
+    };
+}
+export type ProcessorRoutingConfig = {
+    [country in Country]?: {
+        [fiat in Fiat]?: {
+            [purpose in ProcessorRoutingPurpose]?: ProcessorRoutingRule;
+        };
+    };
+};

package/build/types/processor-routing.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessorRoutingPurpose = void 0;
+// What a rule routes. Buy and Sell deliberately carry the same values as the
+// Side enum, so a config written when rules were keyed by side needs no
+// migration. Bank account verifications route through the same machinery rather
+// than their own settings list: the micro-deposit is just another outbound
+// payment whose rail we want to control centrally.
+var ProcessorRoutingPurpose;
+(function (ProcessorRoutingPurpose) {
+    ProcessorRoutingPurpose["Buy"] = "buy";
+    ProcessorRoutingPurpose["Sell"] = "sell";
+    ProcessorRoutingPurpose["BankAccountVerification"] = "bankAccountVerification";
+})(ProcessorRoutingPurpose = exports.ProcessorRoutingPurpose || (exports.ProcessorRoutingPurpose = {}));

package/build/types/processor.d.ts

@@ -7,6 +7,7 @@ export declare enum Processor {
     Bridge = "bridge",
     SPEI_STP = "spei-stp",
     SPEI_NVIO = "spei-nvio",
+    SPEI_FINTOC = "spei-fintoc",
     BinanceRFQ = "binance-rfq",
     Coltefinanciera = "coltefinanciera",
     Alfin = "alfin"

package/build/types/processor.js

@@ -11,6 +11,7 @@ var Processor;
     Processor["Bridge"] = "bridge";
     Processor["SPEI_STP"] = "spei-stp";
     Processor["SPEI_NVIO"] = "spei-nvio";
+    Processor["SPEI_FINTOC"] = "spei-fintoc";
     Processor["BinanceRFQ"] = "binance-rfq";
     Processor["Coltefinanciera"] = "coltefinanciera";
     Processor["Alfin"] = "alfin";

package/build/types/rio-bank-account.d.ts

@@ -1,9 +1,11 @@
 import { Country } from "./country";
 import { Fiat } from "./fiat";
+import { Processor } from "./processor";
 export interface RioBankAccount {
     id: string;
     country: Country;
     fiat: Fiat;
+    processor?: Processor;
     bankName?: string;
     companyName?: string;
     companyAddress?: string;

package/build/types/rio-settings-update.d.ts

@@ -2,7 +2,6 @@ import { Country } from "./country";
 import { Fiat } from "./fiat";
 import { FXProvider } from "./fx-provider";
 import { FXTradingPolicies } from "./fx-trading-policy";
-import { Processor } from "./processor";
 import { Side } from "./side";
 import { TVFXDataProvider } from "./TV-FX-data-provider";
 export interface RioSettingsUpdate {
@@ -54,11 +53,6 @@ export interface RioSettingsUpdate {
             [key in Side]?: number;
         };
     };
-    activeFiatPaymentProcessors?: {
-        [Side.Buy]: Processor[];
-        [Side.Sell]: Processor[];
-        bankAccountVerifications: Processor[];
-    };
     TVFXDataProvider?: {
         [key in Fiat]: TVFXDataProvider;
     };

package/build/types/rio-settings-update.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const side_1 = require("./side");

package/build/types/rio-settings.d.ts

@@ -4,7 +4,7 @@ import { DeferredPaymentType } from "./deferred-payment-type";
 import { Fiat } from "./fiat";
 import { FXProvider } from "./fx-provider";
 import { FXTradingPolicies } from "./fx-trading-policy";
-import { Processor } from "./processor";
+import { ProcessorRoutingConfig } from "./processor-routing";
 import { Side } from "./side";
 import { TVFXDataProvider } from "./TV-FX-data-provider";
 export interface RioSettings {
@@ -68,11 +68,7 @@ export interface RioSettings {
             [key in Side]?: number;
         };
     };
-    activeFiatPaymentProcessors: {
-        [Side.Buy]: Processor[];
-        [Side.Sell]: Processor[];
-        bankAccountVerifications: Processor[];
-    };
+    processorRouting?: ProcessorRoutingConfig;
     TVFXDataProvider: {
         [key in Fiat]?: TVFXDataProvider;
     };

package/build/types/rio-settings.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const side_1 = require("./side");

package/build/types/treasury-provider.d.ts

@@ -1,6 +1,7 @@
 export declare enum TreasuryProvider {
     Bitso = "bitso",
     STP = "STP",
+    Fintoc = "fintoc",
     Coinbase = "coinbase",
     Binance = "binance",
     Kraken = "kraken",

package/build/types/treasury-provider.js

@@ -5,6 +5,7 @@ var TreasuryProvider;
 (function (TreasuryProvider) {
     TreasuryProvider["Bitso"] = "bitso";
     TreasuryProvider["STP"] = "STP";
+    TreasuryProvider["Fintoc"] = "fintoc";
     TreasuryProvider["Coinbase"] = "coinbase";
     TreasuryProvider["Binance"] = "binance";
     TreasuryProvider["Kraken"] = "kraken";

package/build/types/user-attribute.d.ts

@@ -19,8 +19,6 @@ export declare enum UserAttribute {
     DisburseEveningSellOrdersWithoutCosigner = "disburseEveningSellOrdersWithoutCosigner",
     UseFireblocksOvernightAndWeekendVault = "useFireblocksOvernightAndWeekendVault",
     SkipPeriodicWalletComplianceCheck = "skipPeriodicWalletComplianceCheck",
-    UseSTPForMXNWithdrawals = "useSTPForMXNWithdrawals",
-    UseSTPForMXNDeposits = "useSTPForMXNDeposits",
     CanSpecifyQuotationTime = "canSpecifyQuotationTime",
     SendBuyOrderMXNAxes = "sendBuyOrderMXNAxes",
     SendSellOrderMXNAxes = "sendSellOrderMXNAxes",
@@ -43,9 +41,5 @@ export declare enum UserAttribute {
     SellOrderMaintenanceModeActive = "sellOrderMaintenanceModeActive",
     CanPlaceLongDatedForwards = "canPlaceLongDatedForwards",
     CanViewBalances = "canViewBalances",
-    UseAlfinForPENDeposits = "useAlfinForPENDeposits",
-    UseAlfinForPENWithdrawals = "useAlfinForPENWithdrawals",
-    UseAlfinForUSDDeposits = "useAlfinForUSDDeposits",
-    UseAlfinForUSDWithdrawals = "useAlfinForUSDWithdrawals",
     AllowOnboardingsViaAPI = "allowOnboardingsViaAPI"
 }

package/build/types/user-attribute.js

@@ -23,8 +23,6 @@ var UserAttribute;
     UserAttribute["DisburseEveningSellOrdersWithoutCosigner"] = "disburseEveningSellOrdersWithoutCosigner";
     UserAttribute["UseFireblocksOvernightAndWeekendVault"] = "useFireblocksOvernightAndWeekendVault";
     UserAttribute["SkipPeriodicWalletComplianceCheck"] = "skipPeriodicWalletComplianceCheck";
-    UserAttribute["UseSTPForMXNWithdrawals"] = "useSTPForMXNWithdrawals";
-    UserAttribute["UseSTPForMXNDeposits"] = "useSTPForMXNDeposits";
     UserAttribute["CanSpecifyQuotationTime"] = "canSpecifyQuotationTime";
     UserAttribute["SendBuyOrderMXNAxes"] = "sendBuyOrderMXNAxes";
     UserAttribute["SendSellOrderMXNAxes"] = "sendSellOrderMXNAxes";
@@ -47,10 +45,6 @@ var UserAttribute;
     UserAttribute["SellOrderMaintenanceModeActive"] = "sellOrderMaintenanceModeActive";
     UserAttribute["CanPlaceLongDatedForwards"] = "canPlaceLongDatedForwards";
     UserAttribute["CanViewBalances"] = "canViewBalances";
-    UserAttribute["UseAlfinForPENDeposits"] = "useAlfinForPENDeposits";
-    UserAttribute["UseAlfinForPENWithdrawals"] = "useAlfinForPENWithdrawals";
-    UserAttribute["UseAlfinForUSDDeposits"] = "useAlfinForUSDDeposits";
-    UserAttribute["UseAlfinForUSDWithdrawals"] = "useAlfinForUSDWithdrawals";
     // Lets a broker onboard its own sub-accounts over the API: uploading
     // documents and submitting additional information for users whose brokerId
     // is the caller. Almost every onboarding now goes through the register page

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common",
-  "version": "1.0.2694",
+  "version": "1.0.2698",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",