Ctrl+K

Get stablecoin order by ID

get/api/stablecoin/v1/enterprise/{enterpriseId}/orders/{orderId}

Retrieves a order by its ID for a specific enterprise.

Path Parameters

  • enterpriseIdstringRequired
    Enterprise id
    Example: 67bc4ae090e8af8f9b412d3d67e85252
    Min length: >= 1 characters
  • orderIdstringRequired
    Order identifier
    Example: ec84b11f-491b-465f-a118-403a3485452b

200 Response

fromAssetId string <uuid>required
Source asset identifier
Example: 08c1271e-b15d-4af8-8929-f75383903da4
fromAmount string required
Amount to be transferred from source asset, specified in its lowest denomination.
Min length: >= 1 characters
Example: 500
toAssetId string <uuid>required
Destination asset identifier
Example: 49ff49ea-3355-4717-bbb0-5e8f5cae2202
toAmount string required
Amount to be received in destination asset
Min length: >= 1 characters
Example: 5000000
destinationType string required
Type of destination for the order
Allowed values: go_account address wallet
Example: go_account
sourceWalletId string
Source wallet identifier for the order
Min length: >= 1 characters
Example: 67bc4b038f5408faefbfc8edcf6e6577
Match pattern: ^[0-9a-f]{32}$
destinationWalletId string
Destination wallet identifier for go_account type
Example: 67bc4b038f5408faefbfc8edcf6e6577
Match pattern: ^[0-9a-f]{32}$
destinationAddress string
Destination blockchain address
Min length: >= 1 characters
Example: default_address
userId string
User identifier who initiated the order
Min length: >= 1 characters
Example: 677cfdceca8396cf5f7534ddeb8d11e3
Match pattern: ^[0-9a-f]{32}$
clientDepositTxHash string
Transaction hash of the client deposit
Min length: >= 1 characters
Example: 512f64d10b5f358f6dbf3303f90013cfa46006b02a03282456d6bd6432cc5daf
orderHistories array[object]
Array of order status changes with timestamps
status string required
Status of the order
Allowed values: created confirmed_fiat_deposit confirmed_token_deposit initiated_burn_token_transfer completed_burn_token_transfer approved_mint triggering_mint triggering_burn completed_burn approved_client_disbursal initiated_client_disbursal fulfilled failed_mint_initiation failed_mint_transaction failed_burn_transaction failed_burn_token_transfer failed_to_mint failed_to_burn failed_to_initiate_disbursal failed_to_complete_disbursal
Example: created
timestamp string <date-time>required
Timestamp when the status was updated
Example: 2025-04-04T09:25:48.216Z
transactions array[object]
List of transactions associated with the order
txId string required
Transaction identifier
Min length: >= 1 characters
Example: 512f64d10b5f358f6dbf3303f90013cfa46006b02a03282456d6bd6432cc5daf
orderId string <uuid>required
Associated order identifier
Example: 95bdbd9c-9cdc-41a4-ae70-165387b7aa51
assetId string <uuid>required
Asset identifier involved in transaction
Example: 08c1271e-b15d-4af8-8929-f75383903da4
type string required
Type of transaction
Allowed values: clientDeposit mint burn burnTokenTransfer clientDisbursement
Example: clientDeposit
sender string required
Sender identifier
Min length: >= 1 characters
Example: client
senderType string required
Type of sender
Allowed values: go_account address wallet
Example: go_account
senderId string required
Unique identifier of sender
Min length: >= 1 characters
Example: 67bc4b038f5408faefbfc8edcf6e6577
Match pattern: ^[0-9a-f]{32}$
sendAmount string required
Amount sent in transaction
Min length: >= 1 characters
Example: 500
receiver string required
Receiver identifier
Min length: >= 1 characters
Example: trust
receiverType string required
Type of receiver
Allowed values: go_account address
Example: go_account
receiverId string required
Unique identifier of receiver
Min length: >= 1 characters
Example: 6698e670115059e2efe672436a3aea3b
Match pattern: ^[0-9a-f]{32}$
receiveAmount string required
Amount received in transaction
Min length: >= 1 characters
Example: 500
status string required
Current status of transaction
Allowed values: initiated signed unconfirmed confirmed rejected failed
Example: confirmed
createdAt string required
Timestamp when transaction was created
Example: 2025-04-04T09:26:21.600Z
updatedAt string required
Timestamp when transaction was last updated
Example: 2025-04-04T09:26:21.600Z
pendingApprovalId string required
Pending approval id
Min length: >= 1 characters
metadata string
Additional metadata about the order
Min length: >= 1 characters
createdAt string <date-time>
Timestamp when the order was created
Example: 2025-04-04T09:25:48.216Z
updatedAt string <date-time>
Timestamp when the order was last updated
Example: 2025-04-04T09:55:09.136Z
id string <uuid>required
Unique identifier for the order
Example: 95bdbd9c-9cdc-41a4-ae70-165387b7aa51
type string required
Type of order operation
Allowed values: mint burn reward
Example: mint
status string required
Current status of the order
Allowed values: created confirmed_fiat_deposit confirmed_token_deposit initiated_burn_token_transfer completed_burn_token_transfer approved_mint triggering_mint triggering_burn completed_burn approved_client_disbursal initiated_client_disbursal fulfilled failed_mint_initiation failed_mint_transaction failed_burn_transaction failed_burn_token_transfer failed_to_mint failed_to_burn failed_to_initiate_disbursal failed_to_complete_disbursal
Example: fulfilled
enterpriseId string required
The Enterprise ID
Min length: >= 1 characters
Example: 67bc4ae090e8af8f9b412d3d67e85252
Match pattern: ^[0-9a-f]{32}$

400 Response

404 Response

500 Response