REST API›Trade›Margin

GET

List collateral withdrawal requests

List all collateral withdrawal requests for an account.

Path Params

  • accountId string required
    The ID of the account

Query Params

  • offset integer
    Pagination offset

    Defaults to 0

  • limit integer
    Number of items per page

    <= 100

    Defaults to 50

Responses

200
List of collateral withdrawal requests

Response Body

object

  • data array of objects required
    data object
    • id string uuid required
      Unique identifier for the withdrawal request
    • accountId string required
      Account ID associated with the withdrawal request
    • enterpriseId string required
      Enterprise ID associated with the withdrawal request
    • currency string required
      Currency symbol for the withdrawal
    • quantity string decimal required
      Amount requested for withdrawal
    • status string enum required
      Current status of the withdrawal request
      pendingapprovedrejectedcompletedcancelled
    • createdBy string required
      User who created the withdrawal request
    • canceledBy string nullable
      User who canceled the withdrawal request, if applicable
    • creationDate string date-time required
      Timestamp when the request was created
    • modifiedDate string date-time required
      Timestamp when the request was last modified
400
Bad request - Invalid query parameters

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
401
Unauthorized - Invalid or missing authentication

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
403
Forbidden - Insufficient permissions

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.