@fiatconnect/fiatconnect-types - npm Package Compare versions

Comparing version 13.0.2 to 13.1.0

dist/common.d.ts

@@ -73,1 +73,40 @@ import { z } from 'zod';
 export declare const EMAIL_REGEX: RegExp;
+export declare enum TransferInUserActionDetails {
+    PIXUserAction = "PIXUserAction",
+    IBANUserAction = "IBANUserAction",
+    PSEUserAction = "PSEUserAction"
+}
+export declare const transferInUserActionDetailsSchema: z.ZodNativeEnum<typeof TransferInUserActionDetails>;
+export declare const pixUserActionSchema: z.ZodObject<{
+    userActionType: z.ZodLiteral<TransferInUserActionDetails.PIXUserAction>;
+    pixString: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    userActionType: TransferInUserActionDetails.PIXUserAction;
+    pixString: string;
+}, {
+    userActionType: TransferInUserActionDetails.PIXUserAction;
+    pixString: string;
+}>;
+export declare const ibanUserActionSchema: z.ZodObject<{
+    userActionType: z.ZodLiteral<TransferInUserActionDetails.IBANUserAction>;
+    iban: z.ZodString;
+    bic: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    userActionType: TransferInUserActionDetails.IBANUserAction;
+    iban: string;
+    bic: string;
+}, {
+    userActionType: TransferInUserActionDetails.IBANUserAction;
+    iban: string;
+    bic: string;
+}>;
+export declare const pseUserActionSchema: z.ZodObject<{
+    userActionType: z.ZodLiteral<TransferInUserActionDetails.PSEUserAction>;
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    userActionType: TransferInUserActionDetails.PSEUserAction;
+    url: string;
+}, {
+    userActionType: TransferInUserActionDetails.PSEUserAction;
+    url: string;
+}>;

dist/common.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EMAIL_REGEX = exports.cryptoTypeSchema = exports.CryptoType = exports.fiatTypeSchema = exports.FiatType = exports.networkSchema = exports.Network = exports.fiatConnectErrorSchema = exports.FiatConnectError = void 0;
+exports.pseUserActionSchema = exports.ibanUserActionSchema = exports.pixUserActionSchema = exports.transferInUserActionDetailsSchema = exports.TransferInUserActionDetails = exports.EMAIL_REGEX = exports.cryptoTypeSchema = exports.CryptoType = exports.fiatTypeSchema = exports.FiatType = exports.networkSchema = exports.Network = exports.fiatConnectErrorSchema = exports.FiatConnectError = void 0;
 const zod_1 = require("zod");
@@ -31,3 +31,3 @@ // Errors returned by FiatConnect endpoints
     FiatConnectError["InvalidQuote"] = "InvalidQuote";
-})(FiatConnectError = exports.FiatConnectError || (exports.FiatConnectError = {}));
+})(FiatConnectError || (exports.FiatConnectError = FiatConnectError = {}));
 exports.fiatConnectErrorSchema = zod_1.z.nativeEnum(FiatConnectError, {
@@ -40,3 +40,3 @@ description: 'fiatConnectErrorSchema',
     Network["Mainnet"] = "Mainnet";
-})(Network = exports.Network || (exports.Network = {}));
+})(Network || (exports.Network = Network = {}));
 exports.networkSchema = zod_1.z.nativeEnum(Network, {
@@ -84,3 +84,3 @@ description: 'networkSchema',
     FiatType["PAB"] = "PAB";
-})(FiatType = exports.FiatType || (exports.FiatType = {}));
+})(FiatType || (exports.FiatType = FiatType = {}));
 exports.fiatTypeSchema = zod_1.z.nativeEnum(FiatType, {
@@ -95,3 +95,3 @@ description: 'fiatTypeSchema',
     CryptoType["CELO"] = "CELO";
-})(CryptoType = exports.CryptoType || (exports.CryptoType = {}));
+})(CryptoType || (exports.CryptoType = CryptoType = {}));
 exports.cryptoTypeSchema = zod_1.z.nativeEnum(CryptoType, {
@@ -103,2 +103,24 @@ description: 'cryptoTypeSchema',
 /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/; // credit to http://emailregex.com/
+var TransferInUserActionDetails;
+(function (TransferInUserActionDetails) {
+    TransferInUserActionDetails["PIXUserAction"] = "PIXUserAction";
+    TransferInUserActionDetails["IBANUserAction"] = "IBANUserAction";
+    TransferInUserActionDetails["PSEUserAction"] = "PSEUserAction";
+})(TransferInUserActionDetails || (exports.TransferInUserActionDetails = TransferInUserActionDetails = {}));
+exports.transferInUserActionDetailsSchema = zod_1.z.nativeEnum(TransferInUserActionDetails, {
+    description: 'transferInUserActionDetailsSchema',
+});
+exports.pixUserActionSchema = zod_1.z.object({
+    userActionType: zod_1.z.literal(TransferInUserActionDetails.PIXUserAction),
+    pixString: zod_1.z.string(),
+}, { description: 'pixUserActionSchema' });
+exports.ibanUserActionSchema = zod_1.z.object({
+    userActionType: zod_1.z.literal(TransferInUserActionDetails.IBANUserAction),
+    iban: zod_1.z.string(),
+    bic: zod_1.z.string(),
+}, { description: 'ibanUserActionSchema' });
+exports.pseUserActionSchema = zod_1.z.object({
+    userActionType: zod_1.z.literal(TransferInUserActionDetails.PSEUserAction),
+    url: zod_1.z.string(),
+}, { description: 'pseUserActionSchema' });
 //# sourceMappingURL=common.js.map

dist/fiat-account.d.ts

@@ -177,9 +177,9 @@ import { z } from 'zod';
 }, "strip", z.ZodTypeAny, {
+    iban: string;
     fiatAccountType: FiatAccountType.BankAccount;
     country: string;
+}, {
     iban: string;
-}, {
     fiatAccountType: FiatAccountType.BankAccount;
     country: string;
-    iban: string;
 }>>;
@@ -309,9 +309,9 @@ export type IBANNumber = z.infer<typeof iBANNumberSchema>;
     }, "strip", z.ZodTypeAny, {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
+    }, {
         iban: string;
-    }, {
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     }>>;
@@ -434,5 +434,5 @@ IFSCAccount: z.ZodIntersection<z.ZodObject<{
     } & {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     };
@@ -519,5 +519,5 @@ IFSCAccount: {
     } & {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     };
@@ -761,9 +761,9 @@ IFSCAccount: {
     }, "strip", z.ZodTypeAny, {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
+    }, {
         iban: string;
-    }, {
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     }>>;
@@ -776,5 +776,5 @@ }, "strip", z.ZodTypeAny, {
     } & {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     };
@@ -788,5 +788,5 @@ fiatAccountSchema: FiatAccountSchema.IBANNumber;
     } & {
+        iban: string;
         fiatAccountType: FiatAccountType.BankAccount;
         country: string;
-        iban: string;
     };
@@ -793,0 +793,0 @@ fiatAccountSchema: FiatAccountSchema.IBANNumber;

dist/fiat-account.js

@@ -23,3 +23,3 @@ "use strict";
     FiatAccountSchema["PIXAccount"] = "PIXAccount";
-})(FiatAccountSchema = exports.FiatAccountSchema || (exports.FiatAccountSchema = {}));
+})(FiatAccountSchema || (exports.FiatAccountSchema = FiatAccountSchema = {}));
 exports.fiatAccountSchemaSchema = zod_1.z.nativeEnum(FiatAccountSchema, {
@@ -33,3 +33,3 @@ description: 'fiatAccountSchemaSchema',
     FiatAccountType["DuniaWallet"] = "DuniaWallet";
-})(FiatAccountType = exports.FiatAccountType || (exports.FiatAccountType = {}));
+})(FiatAccountType || (exports.FiatAccountType = FiatAccountType = {}));
 exports.fiatAccountTypeSchema = zod_1.z.nativeEnum(FiatAccountType, {
@@ -44,3 +44,3 @@ description: 'fiatAccountTypeSchema',
     PIXKeyTypeEnum["RANDOM"] = "RANDOM";
-})(PIXKeyTypeEnum = exports.PIXKeyTypeEnum || (exports.PIXKeyTypeEnum = {}));
+})(PIXKeyTypeEnum || (exports.PIXKeyTypeEnum = PIXKeyTypeEnum = {}));
 exports.pixKeyTypeEnumSchema = zod_1.z.nativeEnum(PIXKeyTypeEnum, {
@@ -47,0 +47,0 @@ description: 'pixKeyTypeEnumSchema',

dist/kyc.js

@@ -13,3 +13,3 @@ "use strict";
     KycStatus["KycExpired"] = "KycExpired";
-})(KycStatus = exports.KycStatus || (exports.KycStatus = {}));
+})(KycStatus || (exports.KycStatus = KycStatus = {}));
 exports.kycStatusSchema = zod_1.z.nativeEnum(KycStatus, {
@@ -31,3 +31,3 @@ description: 'kycStatusSchema',
     KycSchema["PersonalDataAndDocumentsDetailed"] = "PersonalDataAndDocumentsDetailed";
-})(KycSchema = exports.KycSchema || (exports.KycSchema = {}));
+})(KycSchema || (exports.KycSchema = KycSchema = {}));
 exports.kycSchemaSchema = zod_1.z.nativeEnum(KycSchema, {
@@ -41,3 +41,3 @@ description: 'kycSchemaSchema',
     IdentificationDocumentType["DL"] = "DL";
-})(IdentificationDocumentType = exports.IdentificationDocumentType || (exports.IdentificationDocumentType = {}));
+})(IdentificationDocumentType || (exports.IdentificationDocumentType = IdentificationDocumentType = {}));
 // need nonempty array types to get zod enums to compile
@@ -44,0 +44,0 @@ const documentsWithBack = [IdentificationDocumentType.IDC, IdentificationDocumentType.DL];

dist/quote.d.ts

@@ -75,8 +75,11 @@ import { z } from 'zod';
     allowedValues: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "atleastone">>;
+    userActionType: z.ZodOptional<z.ZodNativeEnum<typeof import("./common").TransferInUserActionDetails>>;
 }, "strip", z.ZodTypeAny, {
     fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
     allowedValues: Record<string, [string, ...string[]]>;
+    userActionType?: import("./common").TransferInUserActionDetails | undefined;
 }, {
     fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
     allowedValues: Record<string, [string, ...string[]]>;
+    userActionType?: import("./common").TransferInUserActionDetails | undefined;
 }>;
@@ -88,8 +91,11 @@ export type QuoteResponseFiatAccountSchema = z.infer<typeof quoteResponseFiatAccountSchemaSchema>;
         allowedValues: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "atleastone">>;
+        userActionType: z.ZodOptional<z.ZodNativeEnum<typeof import("./common").TransferInUserActionDetails>>;
     }, "strip", z.ZodTypeAny, {
         fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
         allowedValues: Record<string, [string, ...string[]]>;
+        userActionType?: import("./common").TransferInUserActionDetails | undefined;
     }, {
         fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
         allowedValues: Record<string, [string, ...string[]]>;
+        userActionType?: import("./common").TransferInUserActionDetails | undefined;
     }>, "many">;
@@ -102,2 +108,3 @@ settlementTimeLowerBound: z.ZodOptional<z.ZodString>;
         allowedValues: Record<string, [string, ...string[]]>;
+        userActionType?: import("./common").TransferInUserActionDetails | undefined;
     }[];
@@ -110,2 +117,3 @@ settlementTimeLowerBound?: string | undefined;
         allowedValues: Record<string, [string, ...string[]]>;
+        userActionType?: import("./common").TransferInUserActionDetails | undefined;
     }[];
@@ -183,8 +191,11 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "atleastone">>;
+            userActionType: z.ZodOptional<z.ZodNativeEnum<typeof import("./common").TransferInUserActionDetails>>;
         }, "strip", z.ZodTypeAny, {
             fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }, {
             fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }>, "many">;
@@ -197,2 +208,3 @@ settlementTimeLowerBound: z.ZodOptional<z.ZodString>;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -205,2 +217,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -235,2 +248,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -265,2 +279,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -333,8 +348,11 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "atleastone">>;
+            userActionType: z.ZodOptional<z.ZodNativeEnum<typeof import("./common").TransferInUserActionDetails>>;
         }, "strip", z.ZodTypeAny, {
             fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }, {
             fiatAccountSchema: import("./fiat-account").FiatAccountSchema;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }>, "many">;
@@ -347,2 +365,3 @@ settlementTimeLowerBound: z.ZodOptional<z.ZodString>;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -355,2 +374,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -383,2 +403,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -411,2 +432,3 @@ settlementTimeLowerBound?: string | undefined;
             allowedValues: Record<string, [string, ...string[]]>;
+            userActionType?: import("./common").TransferInUserActionDetails | undefined;
         }[];
@@ -413,0 +435,0 @@ settlementTimeLowerBound?: string | undefined;

dist/quote.js

@@ -13,3 +13,3 @@ "use strict";
     FeeType["PlatformFee"] = "PlatformFee";
-})(FeeType = exports.FeeType || (exports.FeeType = {}));
+})(FeeType || (exports.FeeType = FeeType = {}));
 exports.feeTypeSchema = zod_1.z.nativeEnum(FeeType, {
@@ -22,3 +22,3 @@ description: 'feeTypeSchema',
     FeeFrequency["Recurring"] = "Recurring";
-})(FeeFrequency = exports.FeeFrequency || (exports.FeeFrequency = {}));
+})(FeeFrequency || (exports.FeeFrequency = FeeFrequency = {}));
 exports.feeFrequencySchema = zod_1.z.nativeEnum(FeeFrequency, {
@@ -56,2 +56,3 @@ description: 'feeFrequencySchema',
     allowedValues: zod_1.z.record(zod_1.z.array(zod_1.z.string()).nonempty()),
+    userActionType: common_1.transferInUserActionDetailsSchema.optional(),
 }, { description: 'quoteResponseFiatAccountSchemaSchema' });
@@ -58,0 +59,0 @@ // Helper type

dist/transfer.d.ts

@@ -9,2 +9,3 @@ import { z } from 'zod';
     TransferStarted = "TransferStarted",
+    TransferWaitingForUserAction = "TransferWaitingForUserAction",
     TransferFiatFundsDebited = "TransferFiatFundsDebited",
@@ -20,3 +21,3 @@ TransferReceivedFiatFunds = "TransferReceivedFiatFunds",
 export declare const transferStatusSchema: z.ZodNativeEnum<typeof TransferStatus>;
-export declare const transferInStatusPreTxSchema: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
+export declare const transferInStatusPreTxSchema: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferWaitingForUserAction, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
 export declare const transferInStatusPostTxSchema: z.ZodEnum<[TransferStatus.TransferSendingCryptoFunds, TransferStatus.TransferComplete]>;
@@ -35,3 +36,3 @@ export declare const transferOutStatusSchema: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferAmlFailed, TransferStatus.TransferReadyForUserToSendCryptoFunds, TransferStatus.TransferReceivedCryptoFunds, TransferStatus.TransferComplete, TransferStatus.TransferFailed]>;
 export type TransferRequestBody = z.infer<typeof transferRequestBodySchema>;
-export declare const transferResponseSchema: z.ZodObject<{
+export declare const transferOutResponseSchema: z.ZodObject<{
     transferId: z.ZodString;
@@ -49,2 +50,148 @@ transferStatus: z.ZodNativeEnum<typeof TransferStatus>;
 }>;
+export type TransferOutResponse = z.infer<typeof transferOutResponseSchema>;
+export declare const transferInResponseSchema: z.ZodObject<{
+    transferId: z.ZodString;
+    transferStatus: z.ZodNativeEnum<typeof TransferStatus>;
+    transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
+}, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
+}>;
+export type TransferInResponse = z.infer<typeof transferInResponseSchema>;
+export declare const transferResponseSchema: z.ZodUnion<[z.ZodObject<{
+    transferId: z.ZodString;
+    transferStatus: z.ZodNativeEnum<typeof TransferStatus>;
+    transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
+}, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
+}>, z.ZodObject<{
+    transferId: z.ZodString;
+    transferStatus: z.ZodNativeEnum<typeof TransferStatus>;
+    transferAddress: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+}, {
+    transferId: string;
+    transferStatus: TransferStatus;
+    transferAddress: string;
+}>]>;
 export type TransferResponse = z.infer<typeof transferResponseSchema>;
@@ -60,3 +207,3 @@ export declare const transferStatusRequestParamsSchema: z.ZodObject<{
 export declare const transferInStatusResponseSchema: z.ZodUnion<[z.ZodObject<{
-    status: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
+    status: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferWaitingForUserAction, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
     transferType: z.ZodLiteral<TransferType.TransferIn>;
@@ -71,4 +218,35 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
 }, "strip", z.ZodTypeAny, {
-    status: TransferStatus.TransferStarted | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
+    status: TransferStatus.TransferStarted | TransferStatus.TransferWaitingForUserAction | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
     fiatAccountId: string;
@@ -83,4 +261,15 @@ transferId: string;
     fee?: string | undefined;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
 }, {
-    status: TransferStatus.TransferStarted | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
+    status: TransferStatus.TransferStarted | TransferStatus.TransferWaitingForUserAction | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
     fiatAccountId: string;
@@ -95,2 +284,13 @@ transferId: string;
     fee?: string | undefined;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
 }>, z.ZodObject<{
@@ -100,2 +300,33 @@ fiatAccountId: z.ZodString;
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
     transferType: z.ZodLiteral<TransferType.TransferIn>;
@@ -120,2 +351,13 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
     txHash: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -133,2 +375,13 @@ }, {
     txHash: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -140,2 +393,33 @@ }>]>;
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
     fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
@@ -158,2 +442,13 @@ cryptoType: z.ZodNativeEnum<typeof import("./common").CryptoType>;
     amountReceived: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -170,6 +465,17 @@ }, {
     amountReceived: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
 }>;
 export declare const transferStatusResponseSchema: z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
-    status: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
+    status: z.ZodEnum<[TransferStatus.TransferStarted, TransferStatus.TransferWaitingForUserAction, TransferStatus.TransferFiatFundsDebited, TransferStatus.TransferReceivedFiatFunds, TransferStatus.TransferFailed]>;
     transferType: z.ZodLiteral<TransferType.TransferIn>;
@@ -184,4 +490,35 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
 }, "strip", z.ZodTypeAny, {
-    status: TransferStatus.TransferStarted | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
+    status: TransferStatus.TransferStarted | TransferStatus.TransferWaitingForUserAction | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
     fiatAccountId: string;
@@ -196,4 +533,15 @@ transferId: string;
     fee?: string | undefined;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
 }, {
-    status: TransferStatus.TransferStarted | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
+    status: TransferStatus.TransferStarted | TransferStatus.TransferWaitingForUserAction | TransferStatus.TransferFiatFundsDebited | TransferStatus.TransferReceivedFiatFunds | TransferStatus.TransferFailed;
     fiatAccountId: string;
@@ -208,2 +556,13 @@ transferId: string;
     fee?: string | undefined;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
 }>, z.ZodObject<{
@@ -213,2 +572,33 @@ fiatAccountId: z.ZodString;
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
     transferType: z.ZodLiteral<TransferType.TransferIn>;
@@ -233,2 +623,13 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
     txHash: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -246,2 +647,13 @@ }, {
     txHash: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -252,2 +664,33 @@ }>]>, z.ZodObject<{
     transferAddress: z.ZodString;
+    userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+        pixString: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+        iban: z.ZodString;
+        bic: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    }>, z.ZodObject<{
+        userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }, {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    }>]>>;
     fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
@@ -270,2 +713,13 @@ cryptoType: z.ZodNativeEnum<typeof import("./common").CryptoType>;
     amountReceived: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
@@ -282,4 +736,15 @@ }, {
     amountReceived: string;
+    userActionDetails?: {
+        userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+        pixString: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+        iban: string;
+        bic: string;
+    } | {
+        userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+        url: string;
+    } | undefined;
     fee?: string | undefined;
 }>]>;
 export type TransferStatusResponse = z.infer<typeof transferStatusResponseSchema>;

dist/transfer.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transferStatusResponseSchema = exports.transferOutStatusResponseSchema = exports.transferInStatusResponseSchema = exports.transferStatusRequestParamsSchema = exports.transferResponseSchema = exports.transferRequestBodySchema = exports.transferOutStatusSchema = exports.transferInStatusPostTxSchema = exports.transferInStatusPreTxSchema = exports.transferStatusSchema = exports.TransferStatus = exports.transferTypeSchema = exports.TransferType = void 0;
+exports.transferStatusResponseSchema = exports.transferOutStatusResponseSchema = exports.transferInStatusResponseSchema = exports.transferStatusRequestParamsSchema = exports.transferResponseSchema = exports.transferInResponseSchema = exports.transferOutResponseSchema = exports.transferRequestBodySchema = exports.transferOutStatusSchema = exports.transferInStatusPostTxSchema = exports.transferInStatusPreTxSchema = exports.transferStatusSchema = exports.TransferStatus = exports.transferTypeSchema = exports.TransferType = void 0;
 const zod_1 = require("zod");
+const common_1 = require("./common");
 const fiat_account_1 = require("./fiat-account");
-const common_1 = require("./common");
 var TransferType;
@@ -11,3 +11,3 @@ (function (TransferType) {
     TransferType["TransferOut"] = "TransferOut";
-})(TransferType = exports.TransferType || (exports.TransferType = {}));
+})(TransferType || (exports.TransferType = TransferType = {}));
 exports.transferTypeSchema = zod_1.z.nativeEnum(TransferType, {
@@ -19,2 +19,3 @@ description: 'transferTypeSchema',
     TransferStatus["TransferStarted"] = "TransferStarted";
+    TransferStatus["TransferWaitingForUserAction"] = "TransferWaitingForUserAction";
     TransferStatus["TransferFiatFundsDebited"] = "TransferFiatFundsDebited";
@@ -28,3 +29,3 @@ TransferStatus["TransferReceivedFiatFunds"] = "TransferReceivedFiatFunds";
     TransferStatus["TransferFailed"] = "TransferFailed";
-})(TransferStatus = exports.TransferStatus || (exports.TransferStatus = {}));
+})(TransferStatus || (exports.TransferStatus = TransferStatus = {}));
 exports.transferStatusSchema = zod_1.z.nativeEnum(TransferStatus, {
@@ -41,2 +42,3 @@ description: 'transferStatusSchema',
     TransferStatus.TransferStarted,
+    TransferStatus.TransferWaitingForUserAction,
     TransferStatus.TransferFiatFundsDebited,
@@ -61,2 +63,8 @@ TransferStatus.TransferReceivedFiatFunds,
 });
+// Helper type
+const userActionDetailsSchema = zod_1.z.union([
+    common_1.pixUserActionSchema,
+    common_1.ibanUserActionSchema,
+    common_1.pseUserActionSchema,
+]);
 /*
@@ -69,7 +77,14 @@ / Transfer Endpoint Types
 }, { description: 'transferRequestBodySchema' });
-exports.transferResponseSchema = zod_1.z.object({
+exports.transferOutResponseSchema = zod_1.z.object({
     transferId: zod_1.z.string(),
     transferStatus: exports.transferStatusSchema,
     transferAddress: zod_1.z.string(),
-}, { description: 'transferResponseSchema' });
+}, { description: 'transferOutResponseSchema' });
+exports.transferInResponseSchema = zod_1.z.object({
+    transferId: zod_1.z.string(),
+    transferStatus: exports.transferStatusSchema,
+    transferAddress: zod_1.z.string(),
+    userActionDetails: userActionDetailsSchema.optional(),
+}, { description: 'transferInResponseSchema' });
+exports.transferResponseSchema = exports.transferInResponseSchema.or(exports.transferOutResponseSchema);
 exports.transferStatusRequestParamsSchema = zod_1.z.object({
@@ -89,2 +104,3 @@ transferId: zod_1.z.string(),
     transferAddress: zod_1.z.string(),
+    userActionDetails: userActionDetailsSchema.optional(),
 }, { description: 'transferInStatusPreTxResponseSchema' });
@@ -91,0 +107,0 @@ const transferInStatusPostTxResponseSchema = zod_1.z.object(transferInStatusPreTxResponseSchema.extend({

dist/webhook.d.ts

@@ -26,3 +26,3 @@ import { z } from 'zod';
     payload: z.ZodUnion<[z.ZodObject<{
-        status: z.ZodEnum<[import("./transfer").TransferStatus.TransferStarted, import("./transfer").TransferStatus.TransferFiatFundsDebited, import("./transfer").TransferStatus.TransferReceivedFiatFunds, import("./transfer").TransferStatus.TransferFailed]>;
+        status: z.ZodEnum<[import("./transfer").TransferStatus.TransferStarted, import("./transfer").TransferStatus.TransferWaitingForUserAction, import("./transfer").TransferStatus.TransferFiatFundsDebited, import("./transfer").TransferStatus.TransferReceivedFiatFunds, import("./transfer").TransferStatus.TransferFailed]>;
         transferType: z.ZodLiteral<import("./transfer").TransferType.TransferIn>;
@@ -37,4 +37,35 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
     }, "strip", z.ZodTypeAny, {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -49,4 +80,15 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     }, {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -61,2 +103,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     }>, z.ZodObject<{
@@ -66,2 +119,33 @@ fiatAccountId: z.ZodString;
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
         transferType: z.ZodLiteral<import("./transfer").TransferType.TransferIn>;
@@ -86,2 +170,13 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -99,2 +194,13 @@ }, {
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -105,3 +211,3 @@ }>]>;
     payload: {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -116,2 +222,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     } | {
@@ -128,2 +245,13 @@ status: import("./transfer").TransferStatus.TransferSendingCryptoFunds | import("./transfer").TransferStatus.TransferComplete;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -134,3 +262,3 @@ };
     payload: {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -145,2 +273,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     } | {
@@ -157,2 +296,13 @@ status: import("./transfer").TransferStatus.TransferSendingCryptoFunds | import("./transfer").TransferStatus.TransferComplete;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -183,2 +333,33 @@ };
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
         fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
@@ -201,2 +382,13 @@ cryptoType: z.ZodNativeEnum<typeof import("./common").CryptoType>;
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -213,2 +405,13 @@ }, {
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -228,2 +431,13 @@ }>;
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -243,2 +457,13 @@ };
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -307,3 +532,3 @@ };
     payload: z.ZodUnion<[z.ZodObject<{
-        status: z.ZodEnum<[import("./transfer").TransferStatus.TransferStarted, import("./transfer").TransferStatus.TransferFiatFundsDebited, import("./transfer").TransferStatus.TransferReceivedFiatFunds, import("./transfer").TransferStatus.TransferFailed]>;
+        status: z.ZodEnum<[import("./transfer").TransferStatus.TransferStarted, import("./transfer").TransferStatus.TransferWaitingForUserAction, import("./transfer").TransferStatus.TransferFiatFundsDebited, import("./transfer").TransferStatus.TransferReceivedFiatFunds, import("./transfer").TransferStatus.TransferFailed]>;
         transferType: z.ZodLiteral<import("./transfer").TransferType.TransferIn>;
@@ -318,4 +543,35 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
     }, "strip", z.ZodTypeAny, {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -330,4 +586,15 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     }, {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -342,2 +609,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     }>, z.ZodObject<{
@@ -347,2 +625,33 @@ fiatAccountId: z.ZodString;
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
         transferType: z.ZodLiteral<import("./transfer").TransferType.TransferIn>;
@@ -367,2 +676,13 @@ fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -380,2 +700,13 @@ }, {
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -386,3 +717,3 @@ }>]>;
     payload: {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -397,2 +728,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     } | {
@@ -409,2 +751,13 @@ status: import("./transfer").TransferStatus.TransferSendingCryptoFunds | import("./transfer").TransferStatus.TransferComplete;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -415,3 +768,3 @@ };
     payload: {
-        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
+        status: import("./transfer").TransferStatus.TransferStarted | import("./transfer").TransferStatus.TransferWaitingForUserAction | import("./transfer").TransferStatus.TransferFiatFundsDebited | import("./transfer").TransferStatus.TransferReceivedFiatFunds | import("./transfer").TransferStatus.TransferFailed;
         fiatAccountId: string;
@@ -426,2 +779,13 @@ transferId: string;
         fee?: string | undefined;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
     } | {
@@ -438,2 +802,13 @@ status: import("./transfer").TransferStatus.TransferSendingCryptoFunds | import("./transfer").TransferStatus.TransferComplete;
         txHash: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -462,2 +837,33 @@ };
         transferAddress: z.ZodString;
+        userActionDetails: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PIXUserAction>;
+            pixString: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.IBANUserAction>;
+            iban: z.ZodString;
+            bic: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        }>, z.ZodObject<{
+            userActionType: z.ZodLiteral<import("./common").TransferInUserActionDetails.PSEUserAction>;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }, {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        }>]>>;
         fiatType: z.ZodNativeEnum<typeof import("./common").FiatType>;
@@ -480,2 +886,13 @@ cryptoType: z.ZodNativeEnum<typeof import("./common").CryptoType>;
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -492,2 +909,13 @@ }, {
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -507,2 +935,13 @@ }>;
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -522,2 +961,13 @@ };
         amountReceived: string;
+        userActionDetails?: {
+            userActionType: import("./common").TransferInUserActionDetails.PIXUserAction;
+            pixString: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.IBANUserAction;
+            iban: string;
+            bic: string;
+        } | {
+            userActionType: import("./common").TransferInUserActionDetails.PSEUserAction;
+            url: string;
+        } | undefined;
         fee?: string | undefined;
@@ -524,0 +974,0 @@ };

dist/webhook.js

@@ -12,3 +12,3 @@ "use strict";
     WebhookEventType["TransferOutStatusEvent"] = "WebhookTransferOutStatusEvent";
-})(WebhookEventType = exports.WebhookEventType || (exports.WebhookEventType = {}));
+})(WebhookEventType || (exports.WebhookEventType = WebhookEventType = {}));
 exports.webhookEventTypeSchema = zod_1.z.nativeEnum(WebhookEventType, {
@@ -15,0 +15,0 @@ description: 'webhookEventTypeSchema',

package.json

 {
   "name": "@fiatconnect/fiatconnect-types",
-  "version": "13.0.2",
+  "version": "13.1.0",
   "description": "Types used in the FiatConnect specification. Offered as standalone module for payment providers and wallets to both use for FiatConnect APIs and integrations.",
@@ -30,16 +30,16 @@ "scripts": {
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
     "@valora/eslint-config-typescript": "^1.0.1",
     "@valora/prettier-config": "^0.0.1",
     "conventional-changelog-conventionalcommits": "^5.0.0",
-    "eslint": "^8.35.0",
+    "eslint": "^8.43.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-native": "^4.0.0",
-    "jest": "^29.4.3",
-    "prettier": "^2.8.4",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
     "semantic-release": "^19.0.5",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.3"
   },
@@ -46,0 +46,0 @@ "prettier": "@valora/prettier-config",

src/common.ts

@@ -97,1 +97,36 @@ import { z } from 'zod'
   /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/ // credit to http://emailregex.com/
+
+export enum TransferInUserActionDetails {
+  PIXUserAction = 'PIXUserAction',
+  IBANUserAction = 'IBANUserAction',
+  PSEUserAction = 'PSEUserAction',
+}
+export const transferInUserActionDetailsSchema = z.nativeEnum(
+  TransferInUserActionDetails,
+  {
+    description: 'transferInUserActionDetailsSchema',
+  },
+)
+
+export const pixUserActionSchema = z.object(
+  {
+    userActionType: z.literal(TransferInUserActionDetails.PIXUserAction),
+    pixString: z.string(),
+  },
+  { description: 'pixUserActionSchema' },
+)
+export const ibanUserActionSchema = z.object(
+  {
+    userActionType: z.literal(TransferInUserActionDetails.IBANUserAction),
+    iban: z.string(),
+    bic: z.string(),
+  },
+  { description: 'ibanUserActionSchema' },
+)
+export const pseUserActionSchema = z.object(
+  {
+    userActionType: z.literal(TransferInUserActionDetails.PSEUserAction),
+    url: z.string(),
+  },
+  { description: 'pseUserActionSchema' },
+)

src/quote.ts

@@ -6,2 +6,3 @@ import { z } from 'zod'
   fiatTypeSchema,
+  transferInUserActionDetailsSchema,
 } from './common'
@@ -76,2 +77,3 @@ import { fiatAccountSchemaSchema, fiatAccountTypeSchema } from './fiat-account'
     allowedValues: z.record(z.array(z.string()).nonempty()),
+    userActionType: transferInUserActionDetailsSchema.optional(),
   },
@@ -78,0 +80,0 @@ { description: 'quoteResponseFiatAccountSchemaSchema' },

src/transfer.ts

 import { z } from 'zod'
+import {
+  cryptoTypeSchema,
+  fiatTypeSchema,
+  pixUserActionSchema,
+  ibanUserActionSchema,
+  pseUserActionSchema,
+} from './common'
 import { fiatAccountIdSchema } from './fiat-account'
-import { fiatTypeSchema, cryptoTypeSchema } from './common'
 
@@ -16,2 +22,3 @@ export enum TransferType {
   TransferStarted = 'TransferStarted',
+  TransferWaitingForUserAction = 'TransferWaitingForUserAction',
   TransferFiatFundsDebited = 'TransferFiatFundsDebited',
@@ -41,2 +48,3 @@ TransferReceivedFiatFunds = 'TransferReceivedFiatFunds',
     TransferStatus.TransferStarted,
+    TransferStatus.TransferWaitingForUserAction,
     TransferStatus.TransferFiatFundsDebited,
@@ -72,2 +80,9 @@ TransferStatus.TransferReceivedFiatFunds,
 
+// Helper type
+const userActionDetailsSchema = z.union([
+  pixUserActionSchema,
+  ibanUserActionSchema,
+  pseUserActionSchema,
+])
+
 /*
@@ -86,3 +101,3 @@ / Transfer Endpoint Types
 
-export const transferResponseSchema = z.object(
+export const transferOutResponseSchema = z.object(
   {
@@ -93,4 +108,20 @@ transferId: z.string(),
   },
-  { description: 'transferResponseSchema' },
+  { description: 'transferOutResponseSchema' },
 )
+export type TransferOutResponse = z.infer<typeof transferOutResponseSchema>
+
+export const transferInResponseSchema = z.object(
+  {
+    transferId: z.string(),
+    transferStatus: transferStatusSchema,
+    transferAddress: z.string(),
+    userActionDetails: userActionDetailsSchema.optional(),
+  },
+  { description: 'transferInResponseSchema' },
+)
+export type TransferInResponse = z.infer<typeof transferInResponseSchema>
+
+export const transferResponseSchema = transferInResponseSchema.or(
+  transferOutResponseSchema,
+)
 export type TransferResponse = z.infer<typeof transferResponseSchema>
@@ -120,2 +151,3 @@
     transferAddress: z.string(),
+    userActionDetails: userActionDetailsSchema.optional(),
   },
@@ -122,0 +154,0 @@ { description: 'transferInStatusPreTxResponseSchema' },

No alert changes

Improved metrics

Total package byte prevSize

245126

increased by24.58%

Lines of code

5450

increased by25%

No dependency changes