Skip to main content
POST
Apply selected position transfers between books.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Signed 32-bit SourceBookId and DestBookId, plus TradableIds containing at least one non-blank identifier present in current aggregated positions for SourceBookId. No positive-ID or distinct-book validation is declared.

Source book, destination book, and tradables selected for a position transfer.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiTransferBookPositionsRequest, Derivitec.Web.Core
source_book_id
integer<int32>

Numeric Risk Portal identifier of the book that currently contains the selected positions.

Example:

1001

dest_book_id
integer<int32>

Numeric Risk Portal identifier of the book that will receive the selected positions.

Example:

1002

tradable_ids
string[] | null

Risk Portal tradable identifiers whose positions are selected for transfer; the collection defaults to empty.

Response

Returns transfer success or destination-permission, selection, validation, and transfer errors in the response envelope.

Outcome of transferring selected positions between books.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiTransferBookPositionsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.