Binance Connector JS
    Preparing search index...

    TravelRuleApi - interface TravelRuleApi

    interface TravelRuleApiInterface {
        brokerWithdraw(
            requestParameters: BrokerWithdrawRequest,
        ): Promise<RestApiResponse<BrokerWithdrawResponse>>;
        depositHistoryTravelRule(
            requestParameters?: DepositHistoryTravelRuleRequest,
        ): Promise<RestApiResponse<DepositHistoryTravelRuleResponse>>;
        fetchAddressVerificationList(): Promise<
            RestApiResponse<FetchAddressVerificationListResponse>,
        >;
        onboardedVaspList(): Promise<RestApiResponse<OnboardedVaspListResponse>>;
        submitDepositQuestionnaire(
            requestParameters: SubmitDepositQuestionnaireRequest,
        ): Promise<RestApiResponse<SubmitDepositQuestionnaireResponse>>;
        submitDepositQuestionnaireTravelRule(
            requestParameters: SubmitDepositQuestionnaireTravelRuleRequest,
        ): Promise<RestApiResponse<SubmitDepositQuestionnaireTravelRuleResponse>>;
        withdrawHistoryV1(
            requestParameters?: WithdrawHistoryV1Request,
        ): Promise<RestApiResponse<WithdrawHistoryV1Response>>;
        withdrawHistoryV2(
            requestParameters?: WithdrawHistoryV2Request,
        ): Promise<RestApiResponse<WithdrawHistoryV2Response>>;
        withdrawTravelRule(
            requestParameters: WithdrawTravelRuleRequest,
        ): Promise<RestApiResponse<WithdrawTravelRuleResponse>>;
    }

    Implemented by

    Index

    Methods

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

      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 Questionnaire is different for each local entity, please refer to If getting error like Questionnaire format not valid. or Questionnaire must not be blank,

      Weight: 600

      Parameters

      Returns Promise<RestApiResponse<BrokerWithdrawResponse>>

      TravelRuleApiInterface

    • Fetch the onboarded VASP list for local entities that required travel rule.

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Returns Promise<RestApiResponse<OnboardedVaspListResponse>>

      TravelRuleApiInterface

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

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate network may not be in the response for old withdraw. Please notice the default startTime and endTime to make sure that time interval is within If both startTime and endTimeare sent, time between startTimeand endTimemust be less

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryV1Response>>

      TravelRuleApiInterface

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

      This endpoint specifically uses per second IP rate limit, user's total second level IP rate 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 If both startTime and endTimeare sent, time between startTimeand endTimemust be less 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.

      Weight: 18000 Request limit: 10 requests per second

      • This endpoint specifically uses per second IP rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-IP-WEIGHT-1S, which defines weight used by the current IP.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryV2Response>>

      TravelRuleApiInterface

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

      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 Questionnaire is different for each local entity, please refer to If getting error like Questionnaire format not valid. or Questionnaire must not be blank,

      Weight: 600

      Parameters

      Returns Promise<RestApiResponse<WithdrawTravelRuleResponse>>

      TravelRuleApiInterface