Interface TransferApiInterface

TransferApi - interface TransferApi

interface TransferApiInterface {
    createInboundTransfer(
        requestParameters: CreateInboundTransferRequest,
    ): Promise<RestApiResponse<CreateInboundTransferResponse>>;
    createOutboundTransfer(
        requestParameters: CreateOutboundTransferRequest,
    ): Promise<RestApiResponse<CreateOutboundTransferResponse>>;
    queryTransferList(
        requestParameters: QueryTransferListRequest,
    ): Promise<RestApiResponse<QueryTransferListResponse>>;
    queryTransferStatus(
        requestParameters: QueryTransferStatusRequest,
    ): Promise<RestApiResponse<QueryTransferStatusResponse>>;
}

Implemented by

W3WPredictionRestAPI.TransferApi

Index

Methods

createInboundTransfer createOutboundTransfer queryTransferList queryTransferStatus

Methods

createInboundTransfer

createInboundTransfer(
requestParameters: CreateInboundTransferRequest,
): Promise<RestApiResponse<CreateInboundTransferResponse>>
Transfer funds from the prediction wallet back to the user's CEX account (SPOT or FUNDING). Requires SAS authorization.

⚠️ SAS Authorization Required: This endpoint enforces SAS (Self-Authorization Service) authorization. If SAS is not enabled for the wallet, the request will be rejected with -31003 SAS authorization required. Enable SAS for your wallet before calling this endpoint.

Weight(IP): 200

Security Type: TRADE
Parameters
- requestParameters: CreateInboundTransferRequest
  Request parameters.
Returns Promise<RestApiResponse<CreateInboundTransferResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/transfer-api.ts:335

createOutboundTransfer

createOutboundTransfer(
requestParameters: CreateOutboundTransferRequest,
): Promise<RestApiResponse<CreateOutboundTransferResponse>>
Transfer funds from the user's CEX account (SPOT or FUNDING) into the prediction wallet. Requires SAS authorization.

Weight(IP): 200

Security Type: TRADE
Parameters
- requestParameters: CreateOutboundTransferRequest
  Request parameters.
Returns Promise<RestApiResponse<CreateOutboundTransferResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/transfer-api.ts:351

queryTransferList

queryTransferList(
requestParameters: QueryTransferListRequest,
): Promise<RestApiResponse<QueryTransferListResponse>>
Get the authenticated user's prediction wallet transfer history within a date range.

Weight(IP): 200

Security Type: USER_DATA
Parameters
- requestParameters: QueryTransferListRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryTransferListResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/transfer-api.ts:367

queryTransferStatus

queryTransferStatus(
requestParameters: QueryTransferStatusRequest,
): Promise<RestApiResponse<QueryTransferStatusResponse>>
Query the current status of a prediction wallet transfer by transfer ID.

status values:* Terminal states are COMPLETED and FAILED. Intermediate states are PROCESSING and PENDING. Do not poll for SUCCESS — it is not a valid terminal state.

Weight(IP): 200

Security Type: USER_DATA
Parameters
- requestParameters: QueryTransferStatusRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryTransferStatusResponse>>
Throws
Memberof
TransferApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/transfer-api.ts:385