> ## Documentation Index > Fetch the complete documentation index at: https://kraken-sandbox.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get transaction by id > Get transaction by id ## OpenAPI ````yaml /openapi/custody-rest.yaml post /0/private/GetCustodyTransaction openapi: 3.0.0 info: title: REST API version: 1.1.0 description: '' servers: - url: https://api.kraken.com description: Production Server security: - API-Key: [] API-Sign: [] tags: - name: Portfolios - name: Transfers - name: Tasks paths: /0/private/GetCustodyTransaction: post: tags: - Portfolios summary: Get transaction by id description: Get transaction by id operationId: getCustodyTransaction parameters: - $ref: '#/components/parameters/transactionId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/getCustodyTransaction' responses: '200': description: Transaction retrieved. content: application/json: schema: $ref: '#/components/schemas/getCustodyTransaction-2' components: parameters: transactionId: in: query name: id required: true deprecated: false schema: description: Transaction ID type: string style: form allowEmptyValue: false description: Transaction ID schemas: getCustodyTransaction: type: object required: - nonce - vault_id properties: nonce: $ref: '#/components/schemas/nonce' vault_id: description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 with_long_timeout: nullable: true description: With long timeout default: null type: boolean quote: nullable: true description: Quote asset default: null type: object properties: asset: description: All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class getCustodyTransaction-2: type: object required: - error properties: error: $ref: '#/components/schemas/KWebErrors' result: nullable: true example: transaction: id: TXURLTG-FFGYT-X7F73S time: '2024-01-03T15:07:15.400Z' type: trade category: trade area: spot_margin status: successful ref_id: TSGOQO3-RE57R-6QY57X ref_id2: TPIGLM-T664Y-JZSNTW custody_extended: custody_type: pledge_collateral ref_id_2: 0 approval_id: null internal_transaction_id: null transaction_hash: null loan_id: L_123 result_type: complete type: object properties: transaction: description: Transaction type: object properties: details: nullable: true description: Transaction details oneOf: - title: simple_order description: 'Details for ptl like transactions ex: `Ptl`' type: object properties: type: type: string enum: - simple_order description: 'Details for ptl like transactions ex: `Ptl`' core: description: SimpleOrder-like transaction details type: object properties: quote_id: description: Simple order quote id type: string trade_type: description: >- What type the trade is from the user's perspective (no actual trades here) type: string enum: - unspecified - buy - sell - convert parent_transaction: nullable: true description: Parent transaction id type: string funding_fee: nullable: true description: Funding fee type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_funding_fee: nullable: true description: Quoted funding fee type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class xstock_inventory_counterparty: nullable: true description: >- Payward entity (PDLS or PEDSL-CY) counterparty of the quote. type: string enum: - unspecified - pdsl - pedsl_cy required: - quote_id - trade_type extended: nullable: true description: Simple order-like transaction extended details type: object properties: quote_ref_id: nullable: true description: Quote ref id type: string funding_type: nullable: true description: Funding type type: string enum: - wallet - ach - ach_plaid - fps_plaid - ivy - cc - apple_pay - google_pay - paypal - other channel: nullable: true description: Channel type: string enum: - other - web - mobile fee: description: Trade fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class funding_fee: nullable: true description: Funding fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class total_fee: nullable: true description: Total fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class price: description: Price type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class action_id: nullable: true description: >- For transactions created by the consumer scheduler type: string trigger_type: nullable: true description: Scheduled trigger type type: string enum: - other - time - price price_trigger: nullable: true description: >- Scheduled price trigger if it's a price based scheduled trade type: object properties: base_asset: description: >- The base asset of the pair to check the price in. type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class quote_asset: description: >- The quote asset of the pair to check the price in. type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class target_price: description: >- The price denominated in the `base_asset`/`quote_asset` rate type: string condition: description: >- The condition associated with the target price. Greater than or equal to (gte) or less than or equal to (lte). type: string enum: - less_than_or_equal - greater_than_or_equal required: - base_asset - condition - quote_asset - target_price recurrence_interval: nullable: true description: Recurrence interval for recurring transactions type: string enum: - day - week - two_weeks - month - other parent_transaction: nullable: true description: >- Parent transaction, either the Parent transaction of the current top level transaction, or None, if the child is Nested in it's parent child_transactions: nullable: true description: >- Child transactions, if applicable, otherwise empty array, its also empty, if the transaction is nested in a child type: array items: {} child_relationships: nullable: true description: Child transaction relationships type: object additionalProperties: description: Simple order child transaction relationship type: object properties: child_type: description: Child relationship type type: string enum: - other - unknown - take_profit - stop_loss required: - child_type required: - fee - price required: - core - type - title: simple_order_failed description: >- Details for ptl failed like transactions ex: `PtlInstantFailed` type: object properties: type: type: string enum: - simple_order_failed description: >- Details for ptl failed like transactions ex: `PtlInstantFailed` core: description: Failed Simple Order-like transaction details type: object properties: receive_asset: description: Receive asset type: object properties: asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class spend_asset: description: Spend asset type: object properties: asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class trade_type: description: >- What type the trade is from the user's perspective (no actual trades here) type: string enum: - unspecified - buy - sell - convert failure_reason: description: Failure reason type: string enum: - other - insufficient_funds - card_issue - user_account_issue required: - failure_reason - receive_asset - spend_asset - trade_type required: - core - type - title: simple_order_deposit_action description: >- Details for a deposit action for a simple order like transaction type: object properties: type: type: string enum: - simple_order_deposit_action description: >- Details for a deposit action for a simple order like transaction core: description: Simple ordre deposit action type: object properties: simple_order_transaction: description: Transaction reference type: string funding_reference: description: Funding reference type: string required: - funding_reference - simple_order_transaction required: - core - type - title: dust_sweep description: Details for dust-sweep transactions type: object properties: type: type: string enum: - dust_sweep description: Details for dust-sweep transactions core: description: Sweep-like transaction details type: object properties: quote_id: description: Simple order quote id type: string spend_asset_count: description: How many spend assets were used type: integer format: uint64 minimum: 0 required: - quote_id - spend_asset_count extended: nullable: true type: object properties: quote_ref_id: nullable: true description: Quote reference id type: string required: - core - type - title: boost description: Details for boost transactions type: object properties: type: type: string enum: - boost description: Details for boost transactions core: description: Sweep-like transaction details type: object properties: quote_id: description: Simple order quote id type: string spend_asset_count: description: How many spend assets were used type: integer format: uint64 minimum: 0 required: - quote_id - spend_asset_count extended: nullable: true type: object properties: quote_ref_id: nullable: true description: Quote reference id type: string required: - core - type - title: funding description: 'Details for funding like transactions ex: `Deposit`' type: object properties: type: type: string enum: - funding description: 'Details for funding like transactions ex: `Deposit`' core: description: Funding-like transaction details type: object properties: funding_reference: description: Funding reference type: string state: description: State oneOf: - type: object properties: deposit: description: A state of a deposit type: object properties: status: description: Status type: string enum: - unspecified - settled - success - failure - returned status_details: description: Status details type: string enum: - unspecified - held - returned required: - status - status_details required: - deposit - type: object properties: withdrawal: type: string enum: - unspecified - initial - pending - success - failure required: - withdrawal hold_status: nullable: true description: Holding type: string enum: - held - not_held received_time: nullable: true description: Received time type: string crypto_transaction_id: nullable: true description: Crypto (On-chain) transaction id type: string address_verification_status: nullable: true description: Address verification status type: string enum: - unspecified - verified - not_verified address_verification_eligibility_id: nullable: true description: Address verification eligibility id type: string custody: nullable: true description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id pre_auto_convert_asset: nullable: true description: Pre-auto convert asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class required: - funding_reference - state extended: nullable: true description: Funding-like transaction extended details type: object properties: tag: nullable: true description: Tag type: string memo: nullable: true description: Memo type: string method: description: Method type: string address_description: nullable: true description: Optional address description type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Network type: string explorer: description: Explorer type: string confirmations: description: Confirmations type: string confirmation_time: description: Confirmation time type: string contract_address: nullable: true description: Contract address type: string required: - confirmation_time - confirmations - explorer - network required: - method required: - core - type - title: funding_action description: >- Details for funding action like transactions ex: `DepositAction` type: object properties: type: type: string enum: - funding_action description: >- Details for funding action like transactions ex: `DepositAction` core: description: Funding action-like transaction details type: object properties: funding_transaction: description: Funding transaction reference type: string funding_reference: description: Funding reference type: string required: - funding_reference - funding_transaction extended: nullable: true description: Funding action-like transaction extended details type: object properties: funding_transaction: description: Funding transaction required: - funding_transaction required: - core - type - title: transfer description: 'Details for transfer like transactions ex: `Transfer`' type: object properties: type: type: string enum: - transfer description: >- Details for transfer like transactions ex: `Transfer` core: description: Transfer-like transaction details type: object properties: subtype: nullable: true description: Subtype type: string enum: - unspecified - domain - spot_from_futures - spot_to_futures - vault_to_spot - spot_to_vault - vault_to_vault - vault_to_trading - trading_to_vault custody: nullable: true description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - core - type - title: kard description: 'Details for kard transactions ex: `Kard`' type: object properties: type: type: string enum: - krak_card core: description: Kard transaction details type: object properties: status: description: Status type: string enum: - unspecified - authorized - rejected - success - reversed - refunded - partially_refunded - expired - disputed - dispute_won_refund - dispute_won_partial_refund - dispute_lost metadata: description: Metadata type: object properties: logo_url: nullable: true description: Url for logo of a merchant type: string merchant: nullable: true description: Merchant name type: string category: nullable: true description: >- Category of a transaction (subscription, etc) type: string transaction_source: nullable: true description: Transaction source type: string mcc: nullable: true description: Merchant category code type: string city: nullable: true description: City where the transaction took place type: string state: nullable: true description: State where the transaction took place type: string country_code: nullable: true description: Country where the transaction took place type: string last_4_digits: nullable: true description: Last 4 numbers of PAN type: string transaction_id: nullable: true description: Monavate transaction id type: string liquidated_assets: nullable: true description: Present if assets were liquidated via PTL type: array items: oneOf: - type: string required: - metadata - status required: - core - type - title: trade description: 'Details for trade like transactions ex: `Trade`' type: object properties: type: type: string enum: - trade description: 'Details for trade like transactions ex: `Trade`' core: nullable: true description: Trade details type: object properties: side: description: Side/direction of the trade type: string enum: - unspecified - buy - sell uses_margin: description: >- Uses margin Note: Only denotes if the SMV2 shorts wallet is used in the trade, so it is only relevant for smv2 type: boolean required: - side - uses_margin extended: nullable: true description: Trade extended type: object properties: trade: description: Trade associated with the transaction type: object properties: order_transaction_id: description: >- The ID of the order transaction responsible for execution of the trade type: string position_status: nullable: true description: Status of the associated position type: string time: description: >- Unix timestamp (including microseconds) when the entry was created type: string type: description: Type of trade type: string order_type: nullable: true description: Type of order type: string price: description: >- Average price the order was executed at (quote currency) type: string cost: description: The total cost of the order (quote currency) type: string fee: description: >- The total fee charged for this transaction (quote currency) type: string volume: description: The total volume (base currency) type: string margin: description: The initial margin (quote currency) type: string leverage: description: Leverage type: string misc: description: List of miscellaneous info type: array items: oneOf: - type: string required: - cost - fee - leverage - margin - misc - order_transaction_id - price - time - type - volume pair: description: >- Pair trade was done on (in the preferred asset name) type: string class: nullable: true description: Asset class type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - pair - trade required: - type - title: legacy_staking description: >- Details for legacy staking like transactions ex: `LegacyStakingAllocation` type: object properties: type: type: string enum: - legacy_staking description: >- Details for legacy staking like transactions ex: `LegacyStakingAllocation` core: description: Legacy staking transaction details type: object properties: side: description: Side type: string enum: - unspecified - spot - staking required: - side required: - core - type - title: earn_allocation description: Details for earn allocation transactions type: object properties: type: type: string enum: - earn_allocation description: Details for earn allocation transactions core: description: Earn allocation transaction details type: object properties: strategy_id: description: Strategy id type: string request_id: description: Request id type: string status: nullable: true description: Status of bonding type: string enum: - unspecified - in_progress - done lock_type: description: Lock type type: string enum: - unspecified - flex - bonded - timed - instant - custody - hybrid bonding_seconds: nullable: true description: Bonding seconds type: integer format: uint32 minimum: 0 required: - lock_type - request_id - strategy_id extended: nullable: true description: >- Earn alloc/dealloc/auto -like transaction extended details type: object properties: strategy: description: Strategy info type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset required: - strategy required: - core - type - title: earn_deallocation description: Details for earn deallocation transactions type: object properties: type: type: string enum: - earn_deallocation description: Details for earn deallocation transactions core: description: Earn de-allocation transaction details type: object properties: strategy_id: description: Strategy id type: string request_id: description: Request id type: string status: nullable: true description: Status of unbonding type: string enum: - unspecified - in_progress - done lock_type: description: Lock type type: string enum: - unspecified - flex - bonded - timed - instant - custody - hybrid unbonding_seconds: nullable: true description: Unbonding seconds type: integer format: uint32 minimum: 0 required: - lock_type - request_id - strategy_id extended: nullable: true description: >- Earn alloc/dealloc/auto -like transaction extended details type: object properties: strategy: description: Strategy info type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset required: - strategy required: - core - type - title: earn_reward description: Details for earn reward transactions type: object properties: type: type: string enum: - earn_reward description: Details for earn reward transactions core: description: Earn reward transaction details type: object properties: strategy_id: description: Strategy id type: string reward_id: description: Reward id type: string reward_info: description: Reward info type: string enum: - unspecified - airdrop - flex - bonded - timed - instant required: - reward_id - reward_info - strategy_id extended: nullable: true description: Earn reward-like transaction extended details type: object properties: strategy: nullable: true description: Strategy info type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset allocation: nullable: true description: Allocation info type: object properties: total_rewarded: description: Total rewards (native) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class auto_allocate_enabled: description: >- Whether auto-allocate is currently enabled for this account+asset type: boolean payout_info: nullable: true description: Payout info type: object properties: period_start: description: Period start type: string period_end: description: Period start type: string accumulated_reward: description: >- Reward accumulated in the payout period until now type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class estimated_reward: description: >- Estimated reward from now until the payout type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class required: - accumulated_reward - estimated_reward - period_end - period_start required: - auto_allocate_enabled - total_rewarded required: - core - type - title: earn_auto_allocation description: Details for earn auto allocation transactions type: object properties: type: type: string enum: - earn_auto_allocation description: Details for earn auto allocation transactions core: description: Earn auto allocation transaction details type: object properties: strategy_id: description: Strategy id type: string required: - strategy_id extended: nullable: true description: >- Earn alloc/dealloc/auto -like transaction extended details type: object properties: strategy: description: Strategy info type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset required: - strategy required: - core - type - title: custody_staking description: Details for custody staking type: object properties: type: type: string enum: - custody_staking description: Details for custody staking core: description: Custody un/staking transaction details type: object properties: strategy_id: description: Strategy id type: string request_id: description: Request id type: string status: nullable: true description: Status of un/bonding oneOf: - type: string enum: - unspecified - in_progress - done - type: object properties: failed: type: object properties: reason: type: string required: - reason required: - failed custody: description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - custody - request_id - strategy_id extended: nullable: true description: >- Custody un/staking/reward transaction extended details type: object properties: strategy: description: Strategy info. type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset on_chain_transaction: nullable: true description: On-Chain transaction. type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - hash on_chain_validators: nullable: true description: On-Chain validators list. type: object properties: addresses: description: Validator addresses type: array items: oneOf: - type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - addresses staking_provider: description: Staking validator provider. type: string enum: - staked - kiln required: - staking_provider - strategy required: - core - type - title: custody_unstaking description: Details for custody unstaking type: object properties: type: type: string enum: - custody_unstaking description: Details for custody unstaking core: description: Custody un/staking transaction details type: object properties: strategy_id: description: Strategy id type: string request_id: description: Request id type: string status: nullable: true description: Status of un/bonding oneOf: - type: string enum: - unspecified - in_progress - done - type: object properties: failed: type: object properties: reason: type: string required: - reason required: - failed custody: description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - custody - request_id - strategy_id extended: nullable: true description: >- Custody un/staking/reward transaction extended details type: object properties: strategy: description: Strategy info. type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset on_chain_transaction: nullable: true description: On-Chain transaction. type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - hash on_chain_validators: nullable: true description: On-Chain validators list. type: object properties: addresses: description: Validator addresses type: array items: oneOf: - type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - addresses staking_provider: description: Staking validator provider. type: string enum: - staked - kiln required: - staking_provider - strategy required: - core - type - title: custody_staking_reward description: Details for custody staking reward type: object properties: type: type: string enum: - custody_staking_reward description: Details for custody staking reward core: description: Earn reward transaction details type: object properties: strategy_id: description: Strategy id type: string reward_id: description: Reward id type: string custody: description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - custody - reward_id - strategy_id extended: nullable: true description: >- Custody un/staking/reward transaction extended details type: object properties: strategy: description: Strategy info. type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset on_chain_transaction: nullable: true description: On-Chain transaction. type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - hash on_chain_validators: nullable: true description: On-Chain validators list. type: object properties: addresses: description: Validator addresses type: array items: oneOf: - type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - addresses staking_provider: description: Staking validator provider. type: string enum: - staked - kiln required: - staking_provider - strategy required: - core - type - title: custody_staking_reward_aggregated description: Details for custody staking reward aggregated type: object properties: type: type: string enum: - custody_staking_reward_aggregated description: Details for custody staking reward aggregated core: description: Earn reward transaction details type: object properties: strategy_id: description: Strategy id type: string reward_id: description: Reward id type: string custody: description: Custody details type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - custody - reward_id - strategy_id extended: nullable: true description: >- Custody un/staking/reward transaction extended details type: object properties: strategy: description: Strategy info. type: object properties: allocated_asset: description: Allocated asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class reward_asset: description: Reward asset type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class fixed_apr: nullable: true description: Fixed APR (percentage) type: string apr_estimate: nullable: true description: APR high and low estimates type: object properties: low: description: Low estimate (percentage) type: string high: description: High estimate (percentage) type: string required: - high - low required: - allocated_asset - reward_asset on_chain_transaction: nullable: true description: On-Chain transaction. type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - hash on_chain_validators: nullable: true description: On-Chain validators list. type: object properties: addresses: description: Validator addresses type: array items: oneOf: - type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Blockchain network name type: string explorer: description: Blockchain explorer url type: string required: - explorer - network required: - addresses staking_provider: description: Staking validator provider. type: string enum: - staked - kiln required: - staking_provider - strategy required: - core - type - title: custody_transfer description: Details for custody transfer type: object properties: type: type: string enum: - custody_transfer description: Details for custody transfer core: type: object properties: side: description: Side type: string enum: - unspecified - sent - received flow: description: Flow type: string enum: - unspecified - vault_to_spot - spot_to_vault status: description: Status type: string enum: - unspecified - initial - pending - success - failed source: nullable: true description: Source iban type: string minLength: 14 maxLength: 42 destination: nullable: true description: Destination iban type: string minLength: 14 maxLength: 42 crypto_transaction_id: nullable: true description: Crypto transaction id type: string max_on_chain_fee: nullable: true description: Max on chain fee (for crypto transfers) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_max_on_chain_fee: nullable: true description: Quoted max on chain fee (for crypto transfers) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class custody: nullable: true description: Custody meta data type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string task: nullable: true description: Details about a custody task type: object properties: approval_id: description: >- Underlying approval ID of the custody task type: string task_id: nullable: true example: TN2F7NJJWKJHI2 description: >- Custody task ID. The task ID is deprecated in favor of the approval ID. type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 initiator: nullable: true description: Details about the task's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - approval_id required: - flow - side - status extended: nullable: true description: Custody transfer transaction extended details type: object properties: on_chain_transaction: nullable: true description: On-chain transaction details type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Network type: string explorer: description: Explorer type: string confirmations: description: Confirmations type: string confirmation_time: description: Confirmation time type: string contract_address: nullable: true description: Contract address type: string required: - confirmation_time - confirmations - explorer - network required: - hash required: - core - type - title: bridge_simple_order description: Details for bridge simple order transaction type: object properties: type: type: string enum: - bridge_simple_order description: Details for bridge simple order transaction core: description: BridgeSimpleOrder-like transaction details type: object properties: quote_id: description: Simple order quote id type: string funding_transaction: description: Bridge funding transaction id type: string trade_type: description: >- What type the trade is from the user's perspective (no actual trades here) type: string enum: - unspecified - buy - sell - convert required: - funding_transaction - quote_id - trade_type extended: nullable: true description: Simple order-like transaction extended details type: object properties: quote_ref_id: nullable: true description: Quote ref id type: string funding_type: nullable: true description: Funding type type: string enum: - wallet - ach - ach_plaid - fps_plaid - ivy - cc - apple_pay - google_pay - paypal - other channel: nullable: true description: Channel type: string enum: - other - web - mobile fee: description: Trade fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class funding_fee: nullable: true description: Funding fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class total_fee: nullable: true description: Total fee type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class price: description: Price type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class action_id: nullable: true description: >- For transactions created by the consumer scheduler type: string trigger_type: nullable: true description: Scheduled trigger type type: string enum: - other - time - price price_trigger: nullable: true description: >- Scheduled price trigger if it's a price based scheduled trade type: object properties: base_asset: description: >- The base asset of the pair to check the price in. type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class quote_asset: description: >- The quote asset of the pair to check the price in. type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class target_price: description: >- The price denominated in the `base_asset`/`quote_asset` rate type: string condition: description: >- The condition associated with the target price. Greater than or equal to (gte) or less than or equal to (lte). type: string enum: - less_than_or_equal - greater_than_or_equal required: - base_asset - condition - quote_asset - target_price recurrence_interval: nullable: true description: Recurrence interval for recurring transactions type: string enum: - day - week - two_weeks - month - other parent_transaction: nullable: true description: >- Parent transaction, either the Parent transaction of the current top level transaction, or None, if the child is Nested in it's parent child_transactions: nullable: true description: >- Child transactions, if applicable, otherwise empty array, its also empty, if the transaction is nested in a child type: array items: {} child_relationships: nullable: true description: Child transaction relationships type: object additionalProperties: description: Simple order child transaction relationship type: object properties: child_type: description: Child relationship type type: string enum: - other - unknown - take_profit - stop_loss required: - child_type required: - fee - price required: - core - type - title: transfer_peer_to_peer description: Details for peer to peer transfer type: object properties: type: type: string enum: - transfer_peer_to_peer description: Details for peer to peer transfer core: description: TransferPeerToPeer-like transaction details type: object properties: side: description: Side type: string enum: - unspecified - sent - received is_cancellable: description: Is cancellable type: boolean status: description: Status type: string enum: - unspecified - in_progress - pending_email_verification - success - failed - cancelled - expired metadata: description: Metadata type: object properties: note: nullable: true description: Note type: string sender: nullable: true description: Sender type: object properties: iiban: nullable: true description: Iiban type: string name: nullable: true description: Friendly name type: string recipient: nullable: true description: Recipient type: object properties: iiban: nullable: true description: Iiban type: string name: nullable: true description: Friendly name type: string required: - is_cancellable - metadata - side - status required: - core - type - title: otc_trade description: Details for an OTC trade type: object properties: type: type: string enum: - otc_trade description: Details for an OTC trade core: type: object properties: quote_id: description: Unique OTC trade identifier type: string trade_id: nullable: true description: Trade ID associated with the settled OTC trade type: string time: description: Initiation time of the OTC trade type: string max_on_chain_fee: nullable: true description: Max on chain fee (for crypto transfers) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_max_on_chain_fee: nullable: true description: Quoted max on chain fee (for crypto transfers) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class price: description: >- OTC trade exchange rate represented in terms of the quote asset type: string base: description: The base asset of the OTC transaction type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class quote: description: The quote asset of the OTC transaction type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class vault_to_trading_ref_id: nullable: true description: Vault to trading ref id type: string trading_to_vault_ref_id: nullable: true description: Trading to vault ref id type: string custody: nullable: true description: Custody meta data type: object properties: last_updated: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string initiator: nullable: true description: Details about the transactions's initiator type: object properties: iiban: description: The user's identifying IIBAN type: string minLength: 14 maxLength: 42 name: nullable: true description: The user full name type: string role: description: >- Role that the custody user holds in the organization. type: string required: - iiban - role required: - base - price - quote - quote_id - time extended: nullable: true description: OTC transaction extended details type: object properties: base_on_chain_transaction: nullable: true description: Base asset transaction on the blockchain type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Network type: string explorer: description: Explorer type: string confirmations: description: Confirmations type: string confirmation_time: description: Confirmation time type: string contract_address: nullable: true description: Contract address type: string required: - confirmation_time - confirmations - explorer - network required: - hash quote_on_chain_transaction: nullable: true description: Quote asset transaction on the blockchain type: object properties: hash: description: Transaction hash type: string network_info: nullable: true description: Optional network info type: object properties: network: description: Network type: string explorer: description: Explorer type: string confirmations: description: Confirmations type: string confirmation_time: description: Confirmation time type: string contract_address: nullable: true description: Contract address type: string required: - confirmation_time - confirmations - explorer - network required: - hash required: - core - type - title: bundle_trade description: Details for a Bundle trade type: object properties: type: type: string enum: - bundle_trade description: Details for a Bundle trade core: description: Bundle trade-like transaction details type: object properties: side: description: Side/operation of the trade type: string enum: - unknown - buy - sell - rebalance - dissolve - recurring_buy quote_id: description: Simple order bulk quote id type: string bundle: description: Bundle details type: object properties: id: description: Id type: string name: nullable: true description: Name type: string required: - id required: - bundle - quote_id - side extended: nullable: true description: Bundle trade extended details type: object properties: quote_ref_id: nullable: true description: Simple order quote reference id type: string funding_type: nullable: true description: Funding type type: string enum: - wallet - ach - ach_plaid - fps_plaid - ivy - cc - apple_pay - google_pay - paypal - other auxiliary_ledger_info: description: Auxiliary ledger information type: object additionalProperties: type: object properties: price: nullable: true description: Price (in primary) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_primary_amount: nullable: true description: Amount quoted in primary type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_primary_fee: nullable: true description: Fee quoted in primary (if non zero) type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class required: - auxiliary_ledger_info required: - core - type - title: user_account_transfer description: Details for a User account transfer type: object properties: type: type: string enum: - user_account_transfer description: Details for a User account transfer core: description: Details for a user account transfer type: object properties: side: description: Side type: string enum: - unspecified - sent - received metadata: description: Metadata type: object properties: counterparty: title: PublicAccountId description: Counterparty type: string minLength: 16 maxLength: 19 required: - counterparty required: - metadata - side required: - core - type - title: cash_dividend description: Details for a dividend type: object properties: type: type: string enum: - cash_dividend description: Details for a dividend core: type: object properties: trigger_asset: nullable: true type: object properties: asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - asset - class per_share_amount: nullable: true type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class net_amount: nullable: true type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class required: - core - type - title: earn_restaking description: Details for a earn restaking transaction type: object properties: type: type: string enum: - earn_restaking description: Details for a earn restaking transaction core: type: object properties: strategy_id: type: string request_id: type: string lock_type: description: Lock type of earn transaction type: string enum: - unspecified - flex - bonded - timed - instant - custody - hybrid bonding_seconds: nullable: true type: integer format: uint32 minimum: 0 required: - lock_type - request_id - strategy_id required: - core - type - title: equity_fee description: Details for a equity fee type: object properties: type: type: string enum: - equity_fee description: Details for a equity fee core: type: object properties: fee_type: type: string enum: - unspecified - regulatory - trading_activity - consolidated_audit_trail - american_depositary_receipts - margin_interest - voluntary_corporate_action_fee - acats origin_timestamp: nullable: true description: >- RFC 3339 date time format. Some examples of this format: 1985-04-12T23:20:50.52Z 1996-12-19T16:39:57-08:00 type: string net_amount: nullable: true type: object properties: amount: description: >- To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class required: - fee_type required: - core - type - title: conversion description: Details for a conversion transaction type: object properties: type: type: string enum: - conversion description: Details for a conversion transaction core: type: object properties: reason: nullable: true type: string enum: - unspecified - delisting required: - core - type - title: corporate_action description: Details for a corporate action type: object properties: type: type: string enum: - corporate_action description: Details for a corporate action core: type: object properties: action_type: type: string enum: - split - merger - name_change - spinoff - worthless_removal - unspecified split_direction: nullable: true type: string enum: - forward - reverse - unspecified activity_status: nullable: true type: string enum: - executed - canceled - correct - unspecified merger_type: nullable: true type: string enum: - cash - stock - stock_cash merger_acquirer_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class merger_target_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class merger_cash_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class name_change_type: nullable: true type: string enum: - cusip - symbol_and_cusip - unspecified spinoff_old_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class spinoff_new_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class worthless_removal_amount: nullable: true description: An amount in the denoted asset type: object properties: amount: example: '1.23' description: Amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset name in one set naming scheme type: string class: description: Asset class of the asset type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class required: - action_type required: - core - type - description: Details for a equity journal type: object properties: type: type: string enum: - equity_journal core: type: object properties: journal_type: type: string enum: - unspecified - jit_settlement - rounding_issue required: - journal_type required: - core - type - title: unknown description: Unknown type: object properties: type: type: string enum: - unknown description: Unknown required: - type auxiliary_ledger: nullable: true description: Auxiliary ledger type: array items: type: object properties: ledger_id: description: Ledger Id type: string time: nullable: true description: Time type: string type: description: Subtype type: string amount: description: Amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_amount: nullable: true description: Quoted amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class fee: description: Fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_fee: nullable: true description: Quoted fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class balance: description: Balance type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class wallet: description: Wallet information oneOf: - title: spot description: Spot. type: object properties: type: type: string enum: - spot description: Spot. id: type: string enum: - main - shorts - unknown required: - id - type - title: earn description: Earn. type: object properties: type: type: string enum: - earn description: Earn. id: type: string enum: - flexible - liquid - bonded - locked - closed - unknown required: - id - type - title: legal_entities description: Legal entities. type: object properties: type: type: string enum: - legal_entities description: Legal entities. id: type: string enum: - unknown required: - id - type - title: bundles description: Bundles. type: object properties: type: type: string enum: - bundles description: Bundles. id: type: string required: - id - type - title: custody_otc_trading description: Custody OTC trading. type: object properties: type: type: string enum: - custody_otc_trading description: Custody OTC trading. id: type: string required: - id - type - title: derivatives_multi_collateral description: Derivatives multi-collateral. type: object properties: type: type: string enum: - derivatives_multi_collateral description: Derivatives multi-collateral. id: type: string enum: - main - unknown required: - id - type - title: derivatives_single_collateral description: Derivatives single-collateral. type: object properties: type: type: string enum: - derivatives_single_collateral description: Derivatives single-collateral. id: type: string required: - id - type - title: derivatives_holding description: Derivatives holding. type: object properties: type: type: string enum: - derivatives_holding description: Derivatives holding. id: type: string enum: - main - unknown required: - id - type - title: peer_to_peer_lending description: Peer To Peer Lending. type: object properties: type: type: string enum: - peer_to_peer_lending description: Peer To Peer Lending. id: type: string enum: - lending - loans - unknown required: - id - type - title: custody_pledged_collateral description: Custody pledged collateral. type: object properties: type: type: string enum: - custody_pledged_collateral description: Custody pledged collateral. id: type: string enum: - otc_trading - unknown required: - id - type - title: fcm description: FCM (Futures Commission Merchant) type: object properties: type: type: string enum: - fcm description: FCM (Futures Commission Merchant) id: type: string enum: - main - unknown required: - id - type - title: unknown description: Unknown type: object properties: type: type: string enum: - unknown description: Unknown required: - type required: - amount - balance - fee - ledger_id - type - wallet custody_extended: nullable: true description: Transaction extension output enum (for retrieval operations) oneOf: - description: >- Base fields for transaction extension output (includes `ref_id_2`, used for retrieval) type: object properties: custody_type: type: string enum: - pledge_collateral loan_id: type: string ref_id_2: type: integer format: int64 approval_id: nullable: true type: string internal_transaction_id: nullable: true type: string transaction_hash: nullable: true type: string required: - custody_type - loan_id - ref_id_2 - description: >- Base fields for transaction extension output (includes `ref_id_2`, used for retrieval) type: object properties: custody_type: type: string enum: - reward_withdrawal ref_id_2: type: integer format: int64 approval_id: nullable: true type: string internal_transaction_id: nullable: true type: string transaction_hash: nullable: true type: string required: - custody_type - ref_id_2 - description: >- Base fields for transaction extension output (includes `ref_id_2`, used for retrieval) type: object properties: custody_type: type: string enum: - reward_deposit ref_id_2: type: integer format: int64 approval_id: nullable: true type: string internal_transaction_id: nullable: true type: string transaction_hash: nullable: true type: string required: - custody_type - ref_id_2 - description: >- Base fields for transaction extension output (includes `ref_id_2`, used for retrieval) type: object properties: custody_type: type: string enum: - post_trade_settlement batch_id: type: string ref_id_2: type: integer format: int64 approval_id: nullable: true type: string internal_transaction_id: nullable: true type: string transaction_hash: nullable: true type: string required: - batch_id - custody_type - ref_id_2 id: description: Id type: string time: description: Time type: string type: description: Type type: string enum: - unspecified - deposit - withdrawal - trade - margin - adjustment - rollover - interest - credit - transfer - transfer_peer_to_peer - settle - dividend - nft_trade - reward - nft_creator_fee - nft_rebate - nft_airdrop - simple_order - simple_order_with_deposit - simple_order_failed - custom_simple_order - custom_simple_order_with_deposit - custom_simple_order_failed - recurring_simple_order - recurring_simple_order_with_deposit - recurring_simple_order_failed - simple_order_opposite_side - reserved_fee - fee_sweep - ic_settlement - fee_sweep_dlt - reward_sweep - reward_sweep_old - interest_sweep - conversion - dust_sweep - futures_transfer - custody_transfer - deposit_action - withdrawal_action - legacy_staking_allocation - legacy_staking_deallocation - legacy_staking_reward - earn_legacy_migration - block_trade - equity_trade - equity_acats - earn_staking_allocation - earn_staking_deallocation - earn_staking_reward - earn_staking_auto_allocation - earn_oir_allocation - earn_oir_deallocation - earn_oir_reward - earn_oir_auto_allocation - earn_base_reward - earn_base_auto_allocation - earn_base_auto_deallocation - custody_staking - custody_unstaking - custody_staking_reward - custody_staking_reward_aggregated - credit_rollover - airdrop - earn_oir_auto_deallocation - earn_staking_auto_deallocation - bridge_deposit - bridge_simple_order - simple_order_deposit_action - otc_buy - otc_sell - bundle_trade - equity_fee - equity_journal - corporate_action - user_account_transfer - earn_restaking - subscription - custody_otc_loan_pledge - custody_otc_collateral_liquidation - paytag_transfer - paylink_transfer - paytag_request_transfer - paylink_request_transfer - kard_transfer - krak_card - custody_otc_loan_release - fpsl_reward - fcm_trade - boost - fcm_misc category: description: Category type: string enum: - unspecified - deposit - withdrawal - transfer - krak_card - trade - margin_trade - margin_rollover - margin_settle - earn - earn_rewards - simple_trading - nft - block_trade - credit - equity_trade - equity_acats - equity_dividend - reward_bonus - conversion - reward - custody - legacy_staking - legacy_staking_rewards - equity_fee - equity_journal - corporate_action - fpsl_reward - subscription - other area: description: Area type: string enum: - unspecified - funding - transfer - krak_card - spot_margin - equity - earn - simple_trading - custody - staking - nft - other status: nullable: true description: Status type: string enum: - unspecified - in_progress - successful - failed ref_id: description: Reference id 1 type: string ref_id2: nullable: true description: Reference id 2 type: string spend: nullable: true description: Spend side type: object properties: ledger_id: nullable: true description: Ledger Id type: string time: nullable: true description: Time type: string subtype: nullable: true description: Subtype type: string enum: - unspecified - domain - invite_bonus - welcome_bonus - equity_fpsl - bonus amount: description: Amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_amount: nullable: true description: Quoted Amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class fee: nullable: true description: Fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_fee: nullable: true description: Quoted Fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class total: nullable: true description: >- Total (total debit, or credit, including fees), only optional for backwards compatibility reasons type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_total: nullable: true description: Quoted Total type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class balance: nullable: true description: Balance type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class wallet: nullable: true description: Wallet information oneOf: - title: spot description: Spot. type: object properties: type: type: string enum: - spot description: Spot. id: type: string enum: - main - shorts - unknown required: - id - type - title: earn description: Earn. type: object properties: type: type: string enum: - earn description: Earn. id: type: string enum: - flexible - liquid - bonded - locked - closed - unknown required: - id - type - title: legal_entities description: Legal entities. type: object properties: type: type: string enum: - legal_entities description: Legal entities. id: type: string enum: - unknown required: - id - type - title: bundles description: Bundles. type: object properties: type: type: string enum: - bundles description: Bundles. id: type: string required: - id - type - title: custody_otc_trading description: Custody OTC trading. type: object properties: type: type: string enum: - custody_otc_trading description: Custody OTC trading. id: type: string required: - id - type - title: derivatives_multi_collateral description: Derivatives multi-collateral. type: object properties: type: type: string enum: - derivatives_multi_collateral description: Derivatives multi-collateral. id: type: string enum: - main - unknown required: - id - type - title: derivatives_single_collateral description: Derivatives single-collateral. type: object properties: type: type: string enum: - derivatives_single_collateral description: Derivatives single-collateral. id: type: string required: - id - type - title: derivatives_holding description: Derivatives holding. type: object properties: type: type: string enum: - derivatives_holding description: Derivatives holding. id: type: string enum: - main - unknown required: - id - type - title: peer_to_peer_lending description: Peer To Peer Lending. type: object properties: type: type: string enum: - peer_to_peer_lending description: Peer To Peer Lending. id: type: string enum: - lending - loans - unknown required: - id - type - title: custody_pledged_collateral description: Custody pledged collateral. type: object properties: type: type: string enum: - custody_pledged_collateral description: Custody pledged collateral. id: type: string enum: - otc_trading - unknown required: - id - type - title: fcm description: FCM (Futures Commission Merchant) type: object properties: type: type: string enum: - fcm description: FCM (Futures Commission Merchant) id: type: string enum: - main - unknown required: - id - type - title: unknown description: Unknown type: object properties: type: type: string enum: - unknown description: Unknown required: - type required: - amount receive: nullable: true description: Receive side type: object properties: ledger_id: nullable: true description: Ledger Id type: string time: nullable: true description: Time type: string subtype: nullable: true description: Subtype type: string enum: - unspecified - domain - invite_bonus - welcome_bonus - equity_fpsl - bonus amount: description: Amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_amount: nullable: true description: Quoted Amount type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class fee: nullable: true description: Fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_fee: nullable: true description: Quoted Fee type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class total: nullable: true description: >- Total (total debit, or credit, including fees), only optional for backwards compatibility reasons type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class quoted_total: nullable: true description: Quoted Total type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class balance: nullable: true description: Balance type: object properties: amount: description: To be used as response value for Decimal amounts. type: string asset: description: >- All result amounts will be expressed in units of this asset. type: string class: type: string enum: - currency - forex - equity - equity_pair - nft - derivatives - tokenized_asset - futures_contract required: - amount - asset - class wallet: nullable: true description: Wallet information oneOf: - title: spot description: Spot. type: object properties: type: type: string enum: - spot description: Spot. id: type: string enum: - main - shorts - unknown required: - id - type - title: earn description: Earn. type: object properties: type: type: string enum: - earn description: Earn. id: type: string enum: - flexible - liquid - bonded - locked - closed - unknown required: - id - type - title: legal_entities description: Legal entities. type: object properties: type: type: string enum: - legal_entities description: Legal entities. id: type: string enum: - unknown required: - id - type - title: bundles description: Bundles. type: object properties: type: type: string enum: - bundles description: Bundles. id: type: string required: - id - type - title: custody_otc_trading description: Custody OTC trading. type: object properties: type: type: string enum: - custody_otc_trading description: Custody OTC trading. id: type: string required: - id - type - title: derivatives_multi_collateral description: Derivatives multi-collateral. type: object properties: type: type: string enum: - derivatives_multi_collateral description: Derivatives multi-collateral. id: type: string enum: - main - unknown required: - id - type - title: derivatives_single_collateral description: Derivatives single-collateral. type: object properties: type: type: string enum: - derivatives_single_collateral description: Derivatives single-collateral. id: type: string required: - id - type - title: derivatives_holding description: Derivatives holding. type: object properties: type: type: string enum: - derivatives_holding description: Derivatives holding. id: type: string enum: - main - unknown required: - id - type - title: peer_to_peer_lending description: Peer To Peer Lending. type: object properties: type: type: string enum: - peer_to_peer_lending description: Peer To Peer Lending. id: type: string enum: - lending - loans - unknown required: - id - type - title: custody_pledged_collateral description: Custody pledged collateral. type: object properties: type: type: string enum: - custody_pledged_collateral description: Custody pledged collateral. id: type: string enum: - otc_trading - unknown required: - id - type - title: fcm description: FCM (Futures Commission Merchant) type: object properties: type: type: string enum: - fcm description: FCM (Futures Commission Merchant) id: type: string enum: - main - unknown required: - id - type - title: unknown description: Unknown type: object properties: type: type: string enum: - unknown description: Unknown required: - type required: - amount required: - area - category - id - ref_id - time - type result_type: description: Whether the `Transaction`'s `extended` data was fully retrieved type: string enum: - complete - incomplete_requires_long_timeout - incomplete required: - result_type - transaction nonce: description: Nonce used in construction of `API-Sign` header type: integer format: int64 KWebErrors: type: array items: description: General API error. type: object properties: severity: description: API error severity. type: string enum: - E - W errorClass: type: string type: type: string errorMessage: nullable: true type: string required: - errorClass - severity - type securitySchemes: API-Key: type: apiKey description: The "API-Key" header should contain your API key. name: API-Key in: header API-Sign: type: apiKey description: >- Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path. name: API-Sign in: header ````