curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/order/53fe3d55-85ff-4804-b6f0-a25a32aa082f' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
{
"transfer_quantity": null,
"order_id": "53fe3d55-85ff-4804-b6f0-a25a32aa082f",
"quote_id": "0576b03b-56dd-48b1-ba24-058ce90d0f53",
"client_reference": "stocks-docs-20260921-buy-01",
"asset_id": "7453f146-b267-11f1-b4f4-0abd773ba497",
"symbol": "AAPLx",
"side": "BUY",
"status": "SUCCESS",
"network": "Ethereum",
"funding_currency": "USDC",
"quoted_quantity": "0.00297066689243735",
"executed_quantity": "0.00297066689243735",
"executed_price": "336.624750000000055741",
"cash_amount": "1",
"fees": [
{
"type": "TRADING",
"amount": "0.0005",
"currency": "USDC"
}
],
"total_amount": "1.0005",
"transaction_hash": "0x7e7b7f06c0a4adce2ec2bc01b455fd4e014b9f298e7e2598b02c93dffa86a96f",
"failure_code": null,
"failure_message": null,
"created_at": "2026-09-21T01:33:08.629Z",
"updated_at": "2026-09-21T01:50:53.855Z",
"completed_at": "2026-09-21T01:50:53.561Z",
"failed_at": null
}
Retrieve an order
Retrieve the current state of an order. A successful HTTP response does not itself mean settlement is complete.
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/order/53fe3d55-85ff-4804-b6f0-a25a32aa082f' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
{
"transfer_quantity": null,
"order_id": "53fe3d55-85ff-4804-b6f0-a25a32aa082f",
"quote_id": "0576b03b-56dd-48b1-ba24-058ce90d0f53",
"client_reference": "stocks-docs-20260921-buy-01",
"asset_id": "7453f146-b267-11f1-b4f4-0abd773ba497",
"symbol": "AAPLx",
"side": "BUY",
"status": "SUCCESS",
"network": "Ethereum",
"funding_currency": "USDC",
"quoted_quantity": "0.00297066689243735",
"executed_quantity": "0.00297066689243735",
"executed_price": "336.624750000000055741",
"cash_amount": "1",
"fees": [
{
"type": "TRADING",
"amount": "0.0005",
"currency": "USDC"
}
],
"total_amount": "1.0005",
"transaction_hash": "0x7e7b7f06c0a4adce2ec2bc01b455fd4e014b9f298e7e2598b02c93dffa86a96f",
"failure_code": null,
"failure_message": null,
"created_at": "2026-09-21T01:33:08.629Z",
"updated_at": "2026-09-21T01:50:53.855Z",
"completed_at": "2026-09-21T01:50:53.561Z",
"failed_at": null
}
curl --request GET \
--url 'https://api-sandbox.uqpaytech.com/api/v1/stocks/order/53fe3d55-85ff-4804-b6f0-a25a32aa082f' \
--header "Content-Type: application/json" \
--header "x-auth-token: Bearer ${SANDBOX_TOKEN}"
{
"transfer_quantity": null,
"order_id": "53fe3d55-85ff-4804-b6f0-a25a32aa082f",
"quote_id": "0576b03b-56dd-48b1-ba24-058ce90d0f53",
"client_reference": "stocks-docs-20260921-buy-01",
"asset_id": "7453f146-b267-11f1-b4f4-0abd773ba497",
"symbol": "AAPLx",
"side": "BUY",
"status": "SUCCESS",
"network": "Ethereum",
"funding_currency": "USDC",
"quoted_quantity": "0.00297066689243735",
"executed_quantity": "0.00297066689243735",
"executed_price": "336.624750000000055741",
"cash_amount": "1",
"fees": [
{
"type": "TRADING",
"amount": "0.0005",
"currency": "USDC"
}
],
"total_amount": "1.0005",
"transaction_hash": "0x7e7b7f06c0a4adce2ec2bc01b455fd4e014b9f298e7e2598b02c93dffa86a96f",
"failure_code": null,
"failure_message": null,
"created_at": "2026-09-21T01:33:08.629Z",
"updated_at": "2026-09-21T01:50:53.855Z",
"completed_at": "2026-09-21T01:50:53.561Z",
"failed_at": null
}
Authorizations
The API token for login provided by UQPAY.
Path Parameters
Order identifier returned when creating or listing orders.
Response
Success
Order identifier used to retrieve an order.
"53fe3d55-85ff-4804-b6f0-a25a32aa082f"
Quote used for a trade order. Null for deposit and withdrawal records.
"0576b03b-56dd-48b1-ba24-058ce90d0f53"
Your reference for querying orders. It does not replace the idempotency key.
"stocks-docs-20260921-buy-01"
Asset identifier used across asset, quote, order, and position requests.
"7453f146-b267-11f1-b4f4-0abd773ba497"
Asset symbol.
"AAPLx"
Order activity. Trade orders originate from quotes; deposit and withdrawal records describe asset transfers.
BUY, SELL, DEPOSIT, WITHDRAWAL "BUY"
Order processing state. Reconcile settled values only after completion.
PENDING, SUCCESS, FAILED "SUCCESS"
Network associated with execution or transfer, when available.
"Ethereum"
Currency used to fund a trade. Null for asset-transfer records.
"USDC"
Quantity from the accepted quote; null when the quote did not fix a quantity or the record is an asset transfer.
^-?[0-9]+(\.[0-9]+)?$"0.00297066689243735"
Settled quantity for a completed trade; null before settlement.
^-?[0-9]+(\.[0-9]+)?$"0.00297066689243735"
Settled trade price per unit in funding_currency. Not an asset-transfer cost basis.
^-?[0-9]+(\.[0-9]+)?$"336.624750000000055741"
Settled trade amount before fees in funding_currency. Null before settlement and for asset-transfer records.
^-?[0-9]+(\.[0-9]+)?$"1"
Fees recorded on the completed order. Null means no settled fee information is available.
Show child attributes
Show child attributes
[
{
"type": "TRADING",
"amount": "0.0005",
"currency": "USDC"
}
]
Settled buy outlay including fees or sell proceeds after fees, in funding_currency. Null before settlement and for asset transfers.
^-?[0-9]+(\.[0-9]+)?$"1.0005"
Public transaction hash when available. Null does not by itself indicate that the order failed.
"0x7e7b7f06c0a4adce2ec2bc01b455fd4e014b9f298e7e2598b02c93dffa86a96f"
Business failure identifier on a failed order. This is separate from an HTTP error code.
Human-readable explanation of an order failure; null when no failure is reported.
Time the order was created.
"2026-09-21T01:33:08.629Z"
Time the order was last updated.
"2026-09-21T01:50:53.855Z"
Settlement completion time; null until the order completes.
"2026-09-21T01:50:53.561Z"
Time of terminal failure; null when the order has not failed.
Asset quantity for a deposit or withdrawal. Null for buy and sell orders.
^-?[0-9]+(\.[0-9]+)?$