REST API›Mint

POST

Create an exchange order

Submits a new mint or burn order for the enterprise

Path Params

  • enterpriseId string required
    Enterprise ID submitting the order

    at least 1 characters

Body Params

object

Request body for creating a new exchange order.
  • idempotencyKey string
    Idempotency key to prevent duplicate order creation. Scoped per enterprise — the same key can be reused across different enterprises. Leading/trailing whitespace is stripped on decode; an all-whitespace value is rejected.

    at least 1 characters

  • memo string
    Optional free-text annotation for internal reference (max 500 characters). Stored on the order and returned in all read responses.

    1 to 500 characters

  • source object required
    Source details for an exchange order.
    source object
    • asset string required
      Source asset

      at least 1 characters

    • amount string required
      Source amount in base units. Must be a positive integer string.

      matches ^[1-9][0-9]*$

    • walletId string required
      Source wallet ID (GoAccount ID or wallet ID)

      at least 1 characters

    • type string enum required
      Source type — only GO_ACCOUNT is supported.
      GO_ACCOUNT
  • destination object required
    Destination details for an exchange order. Exactly one of address or walletId must be provided, consistent with type.
    destination object
    • asset string required
      Destination asset

      at least 1 characters

    • type string required
      Destination type — where funds are going. Use BLOCKCHAIN_ADDRESS for any raw on-chain address. Use GO_ACCOUNT or WALLET with walletId for wallet-based destinations.

      ONE OF

      string enum

    • address string
      Destination address (blockchain address). Required when type is BLOCKCHAIN_ADDRESS.

      at least 1 characters

    • walletId string
      Destination wallet ID. Required when type is GO_ACCOUNT or WALLET.

      at least 1 characters

Responses

201
Created

Response Body

object

Response type for POST /enterprise/:enterpriseId/orders Returns the created exchange order details.
  • id string required
    Unique identifier for the exchange order @example "95bdbd9c-9cdc-41a4-ae70-165387b7aa51"

    at least 1 characters

  • userId string required
    User identifier @example "6437d9f07d6a87000613e6c06e4218d3"

    at least 1 characters

  • type string enum required
    Order direction — MINT or BURN (derived from the execution plan)
    MINTBURN
  • status string enum required
    Current status of the exchange order @example "CREATED"
    CREATEDCONFIRMED_DEPOSITPROCESSINGFULFILLEDFAILED
  • enterpriseId string required
    Enterprise identifier @example "67bc4ae090e8af8f9b412d3d67e85252"

    at least 1 characters

  • source object required
    Source asset and amount details
    source object
    • asset string required
      Source asset @example "sol:usd1"

      at least 1 characters

    • amount string required
      Source amount in base units @example "1000500000"

      matches ^[0-9]+$

    • type string enum required
      Source type @example "GO_ACCOUNT"
      GO_ACCOUNTBLOCKCHAIN_ADDRESSWALLET
    • walletId string
      Source wallet ID (e.g., GoAccount ID or wallet ID) @example "67bc4b038f5408faefbfc8edcf6e6577"

      at least 1 characters

  • destination object required
    Destination asset and amount details
    destination object
    • asset string required
      Destination asset @example "fiatusd"

      at least 1 characters

    • type string enum required
      Destination type @example "BLOCKCHAIN_ADDRESS"
      GO_ACCOUNTBLOCKCHAIN_ADDRESSWALLET
    • amount string
      Destination amount in base units (after fees) @example "99900000"

      matches ^[0-9]+$

    • address string
      On-chain destination address. Present when type is BLOCKCHAIN_ADDRESS, or when a receive address has been resolved for a GO_ACCOUNT or WALLET destination.

      at least 1 characters

    • walletId string
      Destination wallet ID. Present when type is GO_ACCOUNT or WALLET.

      at least 1 characters

    • transferId string
      Settlement transfer ID — populated once settlement completes.

      at least 1 characters

    • transactionHash string
      Settlement transaction hash — populated once settlement completes.

      at least 1 characters

  • fee object required
    Fee applied to this order
    fee object
    • basisPoints string required
      Fee rate in basis points (1 bps = 0.01%)

      matches ^[0-9]+$

  • createdAt string date-time required
    ISO8601 creation timestamp @example "2025-04-04T09:25:48.216Z"
  • updatedAt string date-time required
    ISO8601 last-updated timestamp @example "2025-04-04T09:25:48.216Z"
  • idempotencyKey string
    Idempotency key — present only when the order was created with one

    at least 1 characters

  • depositInstructions object
    Deposit instructions describing where source funds should be sent

    ONE OF

    • type string enum required
      Indicates how to interpret the deposit identifier (GO_ACCOUNT, BLOCKCHAIN_ADDRESS, WALLET)
      GO_ACCOUNTBLOCKCHAIN_ADDRESSWALLET
    • asset string required
      The asset to deposit @example "tpolygon:usdc"

      at least 1 characters

    • sequenceId string required
      Sequence ID to use when initiating the source funds transfer

      at least 1 characters

    • address string required
      On-chain address where source funds should be deposited. Present when type is BLOCKCHAIN_ADDRESS.

      at least 1 characters

  • orderMethod string enum
    Present only for issuer-direct orders. Absent means standard deposit flow.
    ISSUER_DIRECT
  • memo string
    Free-text annotation provided at order creation @example "Q2 rebalance batch 3"

    1 to 500 characters