Skip to main content
POST

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Account whose spot and futures balances you want to move funds between. The owner needs an eligible futures balance. Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42

Body

application/json

Derivatives transfer request.

asset
string
required

Currency you want to move. It must be supported by the account's futures balance.

Required string length: 1 - 16
amount
string
required

Amount to move. You can transfer funds that are available after any holds and collateral requirements.

Required string length: 1 - 64
Pattern: ^(0*[1-9][0-9]*(\.[0-9]+)?|0+\.(0?[1-9][0-9]*))$
from
enum<string>
required

Balance the funds move from. Choose a different balance from to.

Available options:
spot,
futures
to
enum<string>
required

Balance the funds move to. Both balances must belong to the same account owner.

Available options:
spot,
futures

Response

Your transfer has been accepted for processing.

Derivatives transfer response.

data
object
required

Transfer result.