Type Alias ListTransfersResponse

Type Declaration

• OptionalapprovalId?: string

  The id of the approval request if this transfer triggered a policy.

• OptionaldateBroadcasted?: string

• OptionaldateConfirmed?: string

• OptionaldatePolicyResolved?: string

• dateRequested: string

• OptionaldebugTrace?: unknown

  Raw blockchain node diagnostics, when available. Omitted when the diagnostic or response size limit is exceeded.

• Optionaldetails?: { [x: string]: unknown }

  Structured representation of the data used to construct the signature (e.g. nonce, gas parameters). Shape is blockchain specific.

• OptionalexternalId?: string

  The external id provided at transfer creation time.

• Optionalfee?: string

  The fee paid for this transfer in minimum denomination.

• OptionalfeeSponsorId?: string

  The fee sponsor id used to pay for the transfer fees.

• id: string

  Transfer id.

• metadata: {
      asset: {
          decimals?: number;
          quotes?: { [x: string]: number };
          symbol?: string;
          verified?: boolean;
      };
  }

  Additional metadata about the transfered asset.

  • asset: {
        decimals?: number;
        quotes?: { [x: string]: number };
        symbol?: string;
        verified?: boolean;
    }

    • Optionaldecimals?: number

      Number of decimals used by the asset, see this guide for more details.

    • Optionalquotes?: { [x: string]: number }

      Corresponding asset price in USD at the time of transfer.

    • Optionalsymbol?: string

    • Optionalverified?: boolean

      Whether the asset is verified by DFNS as legitimate.

• network: string

  The blockchain network this transfer is on.

• Optionalreason?: string

  The reason for a failed transfer.

• OptionalreplacementId?: string

  The id of the replacement transaction (cancel or speed-up) issued for this transfer.

• requestBody:
      | {
          amount: string;
          createDestinationAccount?: boolean;
          expiresAt?: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Native";
          memo?: string
          | "";
          offer?: boolean;
          priority?: "Slow" | "Standard" | "Fast";
          structured?: { [x: string]: any };
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
          useDurableNonce?: boolean;
      }
      | {
          amount: string;
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Erc20";
          priority?: "Slow"
          | "Standard"
          | "Fast";
          structured?: { [x: string]: any };
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Aip21";
          metadata: string;
          to: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          assetId: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Asa";
          memo?: string
          | "";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          assetId: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Asset";
          to: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          instrumentAdmin: string;
          instrumentId: string;
          kind: "Cip56";
          memo?: string
          | "";
          offer?: boolean;
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Cis2";
          to: string;
          tokenAddress: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Cis7";
          memo?: string
          | "";
          to: string;
          tokenId: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          coin: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Coin";
          to: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Erc721";
          priority?: "Slow"
          | "Standard"
          | "Fast";
          to: string;
          tokenId: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Erc7984";
          priority?: "Slow"
          | "Standard"
          | "Fast";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          externalId?: string;
          feeSponsorId?: string;
          kind: "Hip17";
          memo?: string
          | "";
          serialNumber: string;
          to: string;
          tokenId: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Hts";
          memo?: string
          | "";
          to: string;
          tokenId: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          currency: string;
          externalId?: string;
          feeSponsorId?: string;
          issuer: string;
          kind: "Iou";
          memo?: string
          | "";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          assetCode: string;
          externalId?: string;
          feeSponsorId?: string;
          issuer: string;
          kind: "Sep41";
          memo?: string
          | "";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Snip2";
          to: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Snip3";
          to: string;
          tokenId: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          createDestinationAccount?: boolean;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Spl"
          | "Spl2022";
          memo?: string | "";
          mint: string;
          structured?: { [x: string]: any };
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
          useDurableNonce?: boolean;
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Tep74";
          master: string;
          memo?: string
          | "";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Trc10";
          to: string;
          tokenId: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Trc20";
          to: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          contract: string;
          externalId?: string;
          feeSponsorId?: string;
          kind: "Trc721";
          to: string;
          tokenId: string;
          travelRule?: | {
              beneficiary: { [x: string]: any };
              beneficiaryProof?: { [x: ...]: ... };
              beneficiaryVASPdid?: string;
              kind: "Notabene";
              originator: { [x: string]: any };
          }
          | {
              beneficiaryVaspId?: string;
              beneficiaryWalletType?: "unhosted";
              ivms101: { data: string; filledFields: (...)[]; version: "IVMS101.2023" };
              kind: "Sumsub";
          };
      }
      | {
          amount: string;
          externalId?: string;
          feeSponsorId?: string;
          issuanceId: string;
          kind: "Xls33";
          memo?: string
          | "";
          to: string;
          travelRule?:
              | {
                  beneficiary: { [x: string]: any };
                  beneficiaryProof?: { [x: ...]: ... };
                  beneficiaryVASPdid?: string;
                  kind: "Notabene";
                  originator: { [x: string]: any };
              }
              | {
                  beneficiaryVaspId?: string;
                  beneficiaryWalletType?: "unhosted";
                  ivms101: {
                      data: string;
                      filledFields: (...)[];
                      version: "IVMS101.2023";
                  };
                  kind: "Sumsub";
              };
      }

• requester: { tokenId?: string; userId: string }

  The user who initiated the request.

  • OptionaltokenId?: string

    Token id.

  • userId: string

    User id.

• status: "Pending" | "Executing" | "Broadcasted" | "Confirmed" | "Failed" | "Rejected"

  Transfer status.

  Status	Definition
  Pending	The request is pending approval due to a policy applied to the wallet.
  Executing	The request is approved and is in the process of being executed. note this status is only set for a short time between pending and broadcasted.
  Broadcasted	The transaction has been successfully written to the mempool.
  Confirmed	The transaction has been confirmed on-chain by our indexing pipeline.
  Failed	Indicates either system failure to complete the request or the transaction failed on chain.
  Rejected	The request has been rejected by a policy approval action.

• OptionaltxHash?: string

  The blockchain transaction hash for this transfer.

• walletId: string

  The source wallet for this tranfer.