Skip to main content
POST
/
trading
/
orders
TypeScript
const response: Promise<FireblocksResponse<OrderDetails>> = fireblocks.tradingBeta.createOrder(tradingBetaApiCreateOrderRequest);
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
​
via
object
required
Example:
{
  "type": "PROVIDER_ACCOUNT",
  "providerId": "bridge-provider-001",
  "accountId": "acc_9f4e2d8b1c6a5e73"
}
​
executionRequestDetails
object
required

Order execution details

Example:
{
  "side": "BUY",
  "baseAmount": "1000.00",
  "baseAssetId": "USD",
  "baseAssetRail": "BLOCKCHAIN",
  "quoteAssetId": "BTC",
  "quoteAssetRail": "BLOCKCHAIN",
  "type": "MARKET"
}
​
settlement
object
required

Settlement configuration for the order

Example:
{
  "type": "PREFUNDED",
  "destinationAccount": {
    "type": "VAULT_ACCOUNT",
    "accountId": "vault_acc_9f4e2d8b1c6a5e73"
  }
}
​
participantsIdentification
object

KYC/AML participant identification

Example:
{
  "originator": {
    "externalReferenceId": "user_123456",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "FirstParty",
    "fullName": { "firstName": "John", "lastName": "Smith" },
    "dateOfBirth": "1985-03-15",
    "email": "john.smith@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Main Street",
      "buildingNumber": "123",
      "postalCode": "10001",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  },
  "beneficiary": {
    "externalReferenceId": "user_789012",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "ThirdParty",
    "fullName": {
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "dateOfBirth": "1990-07-22",
    "email": "alice.johnson@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Broadway",
      "buildingNumber": "456",
      "postalCode": "10002",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  }
}
​
customerInternalReferenceId
string

Internal reference ID for the customer

​
note
string

Optional note for the order

Maximum string length: 512

Response

Order creation response

​
id
string
required
​
via
object
required
Example:
{
  "type": "PROVIDER_ACCOUNT",
  "providerId": "bridge-provider-001",
  "accountId": "acc_9f4e2d8b1c6a5e73"
}
​
status
enum<string>
required
Available options:
CREATED,
AWAITING_PAYMENT,
PENDING_USER_ACTION,
PROCESSING,
CANCELED,
COMPLETED,
FAILED
Example:

"PROCESSING"

​
createdAt
string<date-time>
required
​
executionSteps
object[]
required
​
executionResponseDetails
object
required
Example:
{
  "side": "BUY",
  "baseAmount": "1000.00",
  "baseAssetId": "USDC",
  "baseAssetRail": "BLOCKCHAIN",
  "quoteAssetId": "BTC",
  "quoteAssetRail": "BLOCKCHAIN",
  "type": "MARKET"
}
​
settlement
object
required

Settlement configuration for the order

Example:
{
  "type": "PREFUNDED",
  "destinationAccount": {
    "type": "VAULT_ACCOUNT",
    "accountId": "vault_acc_9f4e2d8b1c6a5e73"
  }
}
​
createdBy
string
required

The ID of the user who created the order

​
updatedAt
string<date-time>
​
receipt
object
Example:
{
  "type": "BLOCKCHAIN",
  "txHash": "0x1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b",
  "amount": "250.75"
}
​
generalFees
object[]
Example:
{ "amountType": "FIXED", "amount": "0.01" }
​
participantsIdentification
object

KYC/AML participant identification

Example:
{
  "originator": {
    "externalReferenceId": "user_123456",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "FirstParty",
    "fullName": { "firstName": "John", "lastName": "Smith" },
    "dateOfBirth": "1985-03-15",
    "email": "john.smith@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Main Street",
      "buildingNumber": "123",
      "postalCode": "10001",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  },
  "beneficiary": {
    "externalReferenceId": "user_789012",
    "entityType": "INDIVIDUAL",
    "participantRelationshipType": "ThirdParty",
    "fullName": {
      "firstName": "Alice",
      "lastName": "Johnson"
    },
    "dateOfBirth": "1990-07-22",
    "email": "alice.johnson@example.com",
    "phone": "+14155551234",
    "postalAddress": {
      "streetName": "Broadway",
      "buildingNumber": "456",
      "postalCode": "10002",
      "city": "New York",
      "subdivision": "NY",
      "district": "Manhattan",
      "country": "US"
    }
  }
}
​
paymentInstructions
object[]

Payment instructions for the order, the client can use one of these to pay the order.

Example:
{
  "type": "BLOCKCHAIN",
  "address": {
    "blockchainAddress": "0x1234567890123456789012345678901234567890",
    "tag": "1234567890"
  }
}
​
customerInternalReferenceId
string

Internal reference ID for the customer

​
note
string

Optional note for the Order

Maximum string length: 512
​
expiresAt
string<date-time>
​
failure
object