Trading

Get order details

Retrieve detailed information about a specific order by its ID.

Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

For detailed information about error codes and troubleshooting, please refer to our API Error Codes documentation.

get/trading/orders/{orderId}

Request

Path parameters

orderIdstring required

The ID of the order to fetch.

Response

Order response

idstring required
status'CREATED' | 'AWAITING_PAYMENT' | 'AWAITING_INFORMATION' | 'PENDING_USER_ACTION' | 'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'FAILED' required
createdAtstring date-time required
updatedAtstring date-time
createdBystring required

The ID of the user who created the order

customerInternalReferenceIdstring

Internal reference ID for the customer

notestring

Optional note for the Order

expiresAtstring date-time

Example response

{
  "id": "order_9f4e2d8b1c6a5e73",
  "via": {
    "type": "PROVIDER_ACCOUNT",
    "providerId": "bridge-provider-001",
    "accountId": "acc_9f4e2d8b1c6a5e73"
  },
  "status": "PROCESSING",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:30.000Z",
  "receipt": {
    "type": "BLOCKCHAIN",
    "txHash": "0x1234567890abcdef",
    "amount": "0.02458"
  },
  "generalFees": [
    {
      "feeType": "ORDER",
      "assetId": "USDC",
      "amountType": "FIXED",
      "amount": "5.00"
    }
  ],
  "executionSteps": [
    {
      "type": "EXECUTE",
      "status": "PROCESSING",
      "fee": {
        "feeType": "NETWORK",
        "assetId": "ETH",
        "amountType": "FIXED",
        "amount": "0.01"
      },
      "txId": "tx_abc123def456"
    }
  ],
  "executionResponseDetails": {
    "type": "MARKET",
    "side": "BUY",
    "baseAmount": "1000.00",
    "baseAssetId": "USDC",
    "quoteAssetId": "BTC"
  },
  "settlement": {
    "type": "PREFUNDED",
    "destinationAccount": {
      "type": "VAULT_ACCOUNT",
      "accountId": "vault_acc_9f4e2d8b1c6a5e73"
    }
  },
  "createdBy": "user_123abc456def789",
  "customerInternalReferenceId": "order_ref_2024_001",
  "note": "Monthly investment order"
}

Changes

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