Accounts

Fund a subaccount

Keymanagement
Throttleaccount
Cost1 /request
Answers<span class="st st-ok">202</span> <span class="st st-warn">400</span> <span class="st st-warn">401</span> <span class="st st-warn">403</span> <span class="st st-warn">404</span> <span class="st st-hold">423</span> <span class="st st-hold">429</span> <span class="st st-warn">451</span>
Idempotenttrue

Accepted, not settled. Read the verdict with Get a transfer. An applied transfer also appears in List transactions.

post/v3/account/subaccounts/{keyId}/transfer

Request

  • Base URL: https://api.paper.novig.com
  • URL: https://api.paper.novig.com/v3/account/subaccounts/{keyId}/transfer
  • Auth: API key in header Novig-Key-Id and API key in header Novig-Signature and API key in header Novig-Timestamp

Path parameters

keyIdstring uuid required

The subaccount's trading key.

Request body

amountstring required

Positive, at most five decimal places. Never rounded.

clientTransferIdstring

Your idempotency key. Unique per trader. Send one.

direction'fund' | 'defund' required

Named from the subaccount's point of view.

Example request

{
  "amount": "1234.50000"
}

Response

Accepted and outstanding.

actualBalancestring nullable required

The balance the exchange found. Set only on a rejection.

amountstring required

A decimal string with exactly five decimal places.

clientTransferIdstring nullable
createdAtstring date-time required
direction'fund' | 'defund' required

Named from the subaccount's point of view.

status'Requested' | 'Applied' | 'Rejected' required

The route writes only Requested. The exchange then moves it to exactly one terminal state.

transferIdstring uuid required
updatedAtstring date-time required

Example response

{
  "amount": "1234.50000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.