Binance Connector JS
    Preparing search index...

    Interface TravelRuleApiInterface

    TravelRuleApi - interface TravelRuleApi

    interface TravelRuleApiInterface {
        brokerWithdraw(
            requestParameters: BrokerWithdrawRequest,
        ): Promise<RestApiResponse<BrokerWithdrawResponse>>;
        checkQuestionnaireRequirements(
            requestParameters?: CheckQuestionnaireRequirementsRequest,
        ): Promise<RestApiResponse<CheckQuestionnaireRequirementsResponse>>;
        depositHistoryTravelRule(
            requestParameters?: DepositHistoryTravelRuleRequest,
        ): Promise<RestApiResponse<DepositHistoryTravelRuleResponse>>;
        depositHistoryV2(
            requestParameters?: DepositHistoryV2Request,
        ): Promise<RestApiResponse<DepositHistoryV2Response>>;
        fetchAddressVerificationList(
            requestParameters?: FetchAddressVerificationListRequest,
        ): Promise<RestApiResponse<FetchAddressVerificationListResponse>>;
        getCountryList(
            requestParameters?: GetCountryListRequest,
        ): Promise<RestApiResponse<GetCountryListResponse>>;
        getRegionList(
            requestParameters: GetRegionListRequest,
        ): Promise<RestApiResponse<GetRegionListResponse>>;
        submitDepositQuestionnaire(
            requestParameters: SubmitDepositQuestionnaireRequest,
        ): Promise<RestApiResponse<SubmitDepositQuestionnaireResponse>>;
        submitDepositQuestionnaireTravelRule(
            requestParameters: SubmitDepositQuestionnaireTravelRuleRequest,
        ): Promise<RestApiResponse<SubmitDepositQuestionnaireTravelRuleResponse>>;
        submitDepositQuestionnaireV2(
            requestParameters: SubmitDepositQuestionnaireV2Request,
        ): Promise<RestApiResponse<SubmitDepositQuestionnaireV2Response>>;
        vaspList(
            requestParameters?: VaspListRequest,
        ): Promise<RestApiResponse<VaspListResponse>>;
        withdrawHistoryV1(
            requestParameters?: WithdrawHistoryV1Request,
        ): Promise<RestApiResponse<WithdrawHistoryV1Response>>;
        withdrawHistoryV2(
            requestParameters?: WithdrawHistoryV2Request,
        ): Promise<RestApiResponse<WithdrawHistoryV2Response>>;
        withdrawTravelRule(
            requestParameters: WithdrawTravelRuleRequest,
        ): Promise<RestApiResponse<WithdrawTravelRuleResponse>>;
    }

    Implemented by

    Index

    Methods

    brokerWithdraw checkQuestionnaireRequirements depositHistoryTravelRule depositHistoryV2 fetchAddressVerificationList getCountryList getRegionList submitDepositQuestionnaire submitDepositQuestionnaireTravelRule submitDepositQuestionnaireV2 vaspList withdrawHistoryV1 withdrawHistoryV2 withdrawTravelRule

    Methods

    • Submit a withdrawal request for brokers of local entities that required travel rule.

      Weight(UID): 600

      Security Type: USER_DATA

      Notes:

      • If network not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected.
      • You can get network in networkList of a coin in the response of Get /sapi/v1/capital/config/getall (HMAC SHA256).
      • Questionnaire is different for each local entity, please refer to the Withdraw Questionnaire Contents page.
      • If getting error like Questionnaire format not valid. or Questionnaire must not be blank, please try to verify the format of the questionnaire and use URL-encoded format.

      Parameters

      Returns Promise<RestApiResponse<BrokerWithdrawResponse>>

      TravelRuleApiInterface

    • Fetch deposit history for local entities that with required travel rule information.

      Weight(IP): 1

      Security Type: USER_DATA

      Notes:

      • Please notice the default startTime and endTime to make sure that time interval is within 0-90 days.
      • If both startTime and endTime are sent, time between startTime and endTime must be less than 90 days.
      • Please, note that due to network-specific characteristics, the returned source address may be inaccurate. If multiple source addresses are found, only the first one will be returned.

      Parameters

      Returns Promise<RestApiResponse<DepositHistoryV2Response>>

      TravelRuleApiInterface

    • Fetch withdraw history for local entities that required travel rule.

      Weight(IP): 1

      Security Type: USER_DATA

      Notes:

      • network may not be in the response for old withdraw.
      • Withdrawal made through /sapi/v1/capital/withdraw/apply may not be in the response.
      • Please notice the default startTime and endTime to make sure that time interval is within 0-90 days.
      • If both startTime and endTimeare sent, time between startTimeand endTimemust be less than 90 days.
      • If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days.
      • If withdrawOrderId is sent, startTime and endTime are not sent, will return last 7 days records by default.
      • Maximum support trId,txId number is 45.
      • WithdrawOrderId only support 1.
      • If responsible does not include withdrawalStatus, please input trId or txId retrieve the data.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryV2Response>>

      TravelRuleApiInterface

    • Submit a withdrawal request for local entities that required travel rule.

      Weight(UID): 600

      Security Type: USER_DATA

      Notes:

      • If network not send, return with default network of the coin, but if the address could not match default network, the withdraw will be rejected.
      • You can get network and isDefault in networkList of a coin in the response of Get /sapi/v1/capital/config/getall (HMAC SHA256).
      • Questionnaire is different for each local entity, please refer to the Withdraw Questionnaire Contents page.
      • If getting error like Questionnaire format not valid. or Questionnaire must not be blank, please try to verify the format of the questionnaire and use URL-encoded format.

      Parameters

      Returns Promise<RestApiResponse<WithdrawTravelRuleResponse>>

      TravelRuleApiInterface

    Settings

    Member Visibility

    On This Page

    Methods