@dfns/sdk 0.7.12-rc.1 → 0.7.13-rc.0

package/generated/exchanges/types.d.ts

@@ -1,14 +1,20 @@
 export type CreateDepositBody = {
     kind: "Native";
+    /** The amount of native tokens to transfer in minimum denomination. */
     amount: string;
+    /** The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. */
     priority?: ("Slow" | "Standard" | "Fast") | undefined;
+    /** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
     createDestinationAccount?: boolean | undefined;
-    /** Optional field for Canton, if true it will create a transfer offer */
+    /** Optional field for Canton, if true it will create a transfer offer. */
     offer?: boolean | undefined;
     /** Optional field for Canton, especially useful in the context of offers */
     expiresAt?: string | undefined;
+    /** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
     targetChain?: string | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -22,16 +28,21 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Erc20";
+    /** The ERC-20 contract address. */
     contract: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** The priority that determines the fees paid for the transfer. */
     priority?: ("Slow" | "Standard" | "Fast") | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -45,15 +56,19 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Trc10";
+    /** The token ID. */
     tokenId: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -67,15 +82,19 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Trc20";
+    /** The smart contract address. */
     contract: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -89,15 +108,19 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Asa";
+    /** The token asset id.  */
     assetId: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -111,16 +134,21 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Sep41";
+    /** The asset issuer address. */
     issuer: string;
+    /** The asset code. */
     assetCode: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -134,16 +162,21 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Spl" | "Spl2022";
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** The mint account address. */
     mint: string;
+    /** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
     createDestinationAccount?: boolean | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -157,15 +190,19 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Tep74";
+    /** The Jetton master contract address. */
     master: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -179,13 +216,15 @@ export type CreateDepositBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 };
 export type CreateDepositParams = {
+    /** The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx` */
     exchangeId: string;
+    /** Unique identifier for the account like "spot" */
     accountId: string;
 };
 export type CreateDepositResponse = {
@@ -202,15 +241,21 @@ export type CreateDepositResponse = {
     };
     requestBody: {
         kind: "Native";
+        /** The amount of native tokens to transfer in minimum denomination. */
         amount: string;
+        /** The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. */
         priority?: ("Slow" | "Standard" | "Fast") | undefined;
+        /** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
         createDestinationAccount?: boolean | undefined;
-        /** Optional field for Canton, if true it will create a transfer offer */
+        /** Optional field for Canton, if true it will create a transfer offer. */
         offer?: boolean | undefined;
         /** Optional field for Canton, especially useful in the context of offers */
         expiresAt?: string | undefined;
+        /** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
         targetChain?: string | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -224,16 +269,21 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Erc20";
+        /** The ERC-20 contract address. */
         contract: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** The priority that determines the fees paid for the transfer. */
         priority?: ("Slow" | "Standard" | "Fast") | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -247,15 +297,19 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Trc10";
+        /** The token ID. */
         tokenId: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -269,15 +323,19 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Trc20";
+        /** The smart contract address. */
         contract: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -291,15 +349,19 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Asa";
+        /** The token asset id.  */
         assetId: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -313,16 +375,21 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Sep41";
+        /** The asset issuer address. */
         issuer: string;
+        /** The asset code. */
         assetCode: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -336,16 +403,21 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Spl" | "Spl2022";
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** The mint account address. */
         mint: string;
+        /** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
         createDestinationAccount?: boolean | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -359,15 +431,19 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Tep74";
+        /** The Jetton master contract address. */
         master: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -381,7 +457,7 @@ export type CreateDepositResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
@@ -418,15 +494,21 @@ export type CreateExchangeRequest = {
 };
 export type CreateWithdrawalBody = {
     kind: "Native";
+    /** The amount of native tokens to transfer in minimum denomination. */
     amount: string;
+    /** The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. */
     priority?: ("Slow" | "Standard" | "Fast") | undefined;
+    /** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
     createDestinationAccount?: boolean | undefined;
-    /** Optional field for Canton, if true it will create a transfer offer */
+    /** Optional field for Canton, if true it will create a transfer offer. */
     offer?: boolean | undefined;
     /** Optional field for Canton, especially useful in the context of offers */
     expiresAt?: string | undefined;
+    /** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
     targetChain?: string | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -440,16 +522,21 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Erc20";
+    /** The ERC-20 contract address. */
     contract: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** The priority that determines the fees paid for the transfer. */
     priority?: ("Slow" | "Standard" | "Fast") | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -463,15 +550,19 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Trc10";
+    /** The token ID. */
     tokenId: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -485,15 +576,19 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Trc20";
+    /** The smart contract address. */
     contract: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -507,15 +602,19 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Asa";
+    /** The token asset id.  */
     assetId: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -529,16 +628,21 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Sep41";
+    /** The asset issuer address. */
     issuer: string;
+    /** The asset code. */
     assetCode: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -552,16 +656,21 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Spl" | "Spl2022";
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** The mint account address. */
     mint: string;
+    /** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
     createDestinationAccount?: boolean | undefined;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -575,15 +684,19 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 } | {
     kind: "Tep74";
+    /** The Jetton master contract address. */
     master: string;
+    /** The amount of tokens to transfer in minimum denomination. */
     amount: string;
+    /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
     externalId?: string | undefined;
+    /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
     travelRule?: ({
         kind: "Notabene";
         beneficiaryVASPdid?: string | undefined;
@@ -597,13 +710,15 @@ export type CreateWithdrawalBody = {
             [x: string]: any;
         };
     }) | undefined;
-    /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+    /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
     feeSponsorId?: string | undefined;
     walletId: string;
     otp?: string | undefined;
 };
 export type CreateWithdrawalParams = {
+    /** The exchange id obtained from the Create Exchange endpoint. Ex: `ex-1f04s-lqc9q-xxxxxxxxxxxxxxxx` */
     exchangeId: string;
+    /** Unique identifier for the account like "spot" */
     accountId: string;
 };
 export type CreateWithdrawalResponse = {
@@ -620,15 +735,21 @@ export type CreateWithdrawalResponse = {
     };
     requestBody: {
         kind: "Native";
+        /** The amount of native tokens to transfer in minimum denomination. */
         amount: string;
+        /** The priority that determines the fees paid for the transfer. All EVM compatible networks and Bitcoin support `priority`. Not supported for other networks. It uses the [estimate fees](https://docs.dfns.co/api-reference/networks/estimate-fees) API to calculate the transfer fees. When not specified, defaults to `Standard` priority. */
         priority?: ("Slow" | "Standard" | "Fast") | undefined;
+        /** Whether to create the destination account on chains that require account creation (e.g., Stellar, Kadena). Only valid for chains that require the receiver account to exist before transfer. */
         createDestinationAccount?: boolean | undefined;
-        /** Optional field for Canton, if true it will create a transfer offer */
+        /** Optional field for Canton, if true it will create a transfer offer. */
         offer?: boolean | undefined;
         /** Optional field for Canton, especially useful in the context of offers */
         expiresAt?: string | undefined;
+        /** For multi-chain networks (e.g., Kadena), specify the destination chain for cross-chain transfers. */
         targetChain?: string | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -642,16 +763,21 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Erc20";
+        /** The ERC-20 contract address. */
         contract: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** The priority that determines the fees paid for the transfer. */
         priority?: ("Slow" | "Standard" | "Fast") | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -665,15 +791,19 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Trc10";
+        /** The token ID. */
         tokenId: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -687,15 +817,19 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Trc20";
+        /** The smart contract address. */
         contract: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -709,15 +843,19 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Asa";
+        /** The token asset id.  */
         assetId: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -731,16 +869,21 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Sep41";
+        /** The asset issuer address. */
         issuer: string;
+        /** The asset code. */
         assetCode: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -754,16 +897,21 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Spl" | "Spl2022";
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** The mint account address. */
         mint: string;
+        /** If `true`, pay to create the associated token account for the recipient if it doesn't exist. Defaults to `false`. */
         createDestinationAccount?: boolean | undefined;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -777,15 +925,19 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;
     } | {
         kind: "Tep74";
+        /** The Jetton master contract address. */
         master: string;
+        /** The amount of tokens to transfer in minimum denomination. */
         amount: string;
+        /** A unique ID from your system. It can be leveraged to be used as an idempotency key. (read more [here](https://docs.dfns.co/api-reference/idempotency)) */
         externalId?: string | undefined;
+        /** A travel rule payload to associate with the transfer. (read more [here](https://docs.dfns.co/features/travel-rule)) */
         travelRule?: ({
             kind: "Notabene";
             beneficiaryVASPdid?: string | undefined;
@@ -799,7 +951,7 @@ export type CreateWithdrawalResponse = {
                 [x: string]: any;
             };
         }) | undefined;
-        /** Id of the fee sponsor that will be used to pay for your transfer fee, it might not be available for all blockchains */
+        /** Id of the fee sponsor that will be used to pay for your transfer fees, it might not be available for all blockchains. (read more [here](https://docs.dfns.co/features/fee-sponsors)) */
         feeSponsorId?: string | undefined;
         walletId: string;
         otp?: string | undefined;