InformationThe order status reflects the current state of the exchange. The statusNote field provides additional context and is included only when it is necessary to clarify the reason for a delay, error, refund, or action required from the user.
Information about status
Use thestatus field as the primary source of information about the order state. It is this value that determines the current processing stage.Parameter definitions
Value
Description
AWAITING_DEPOSITOrder created and awaiting deposit
CONFIRMING_DEPOSITDeposit received and awaiting confirmation
EXCHANGINGAsset exchange in progress
SENDINGFunds are being sent to the receiving address
HOLDOrder processing temporarily paused
COMPLETEOrder successfully completed
REFUNDOrder refunded
FAILEDOrder processing failed
ACTION_REQUESTAdditional action required to continue
Information about statusNote
The
statusNote field complements status and helps to more accurately determine the reason for the current order state. It does not replace the status and should not be used separately from it.Use statusNote when a single status value is not enough to understand the situation.Parameter definitions
Value
Description
PROCESSING_DELAYEDOrder processing is taking longer than usual
PROCESSING_DELAYED_NETWORKProcessing is delayed due to network conditions
RECEIVE_ADDRESS_HIGH_RISKReceiving address is marked as high risk
REFUND_ADDRESS_HIGH_RISKRefund address is marked as high risk
RECEIVE_ADDRESS_REJECTEDReceiving address rejected
REFUND_ADDRESS_REJECTEDRefund address rejected
RECEIVE_ADDRESS_INVALIDInvalid receiving address specified
REFUND_ADDRESS_INVALIDInvalid refund address specified
RECEIVE_TAG_REQUIREDTag or memo is required for the receiving address
REFUND_TAG_REQUIREDTag or memo is required for the refund address
DEPOSIT_NETWORK_MAINTENANCEDeposit network is temporarily unavailable
RECEIVE_NETWORK_MAINTENANCEReceiving network is temporarily unavailable
REFUND_NETWORK_MAINTENANCERefund network is temporarily unavailable
WITHDRAWAL_FAILEDFailed to send funds to the receiving address
ORDER_EXPIREDOrder has expired
How to handle status and statusNote
Always processstatus as the primary state field. If statusNote is present in the response, use it as additional context for the interface, integration logic, or displaying the reason for an error.Enum examples
Enum values must exactly match the values returned by the API. This prevents errors when comparing statuses in code.
status
export const OrderStatus = {
AWAITING_DEPOSIT: "AWAITING_DEPOSIT",
CONFIRMING_DEPOSIT: "CONFIRMING_DEPOSIT",
EXCHANGING: "EXCHANGING",
SENDING: "SENDING",
HOLD: "HOLD",
COMPLETE: "COMPLETE",
REFUND: "REFUND",
FAILED: "FAILED",
ACTION_REQUEST: "ACTION_REQUEST",
};statusNote
export const OrderStatusNoteEnum = {
PROCESSING_DELAYED: "PROCESSING_DELAYED",
PROCESSING_DELAYED_NETWORK: "PROCESSING_DELAYED_NETWORK",
RECEIVE_ADDRESS_HIGH_RISK: "RECEIVE_ADDRESS_HIGH_RISK",
REFUND_ADDRESS_HIGH_RISK: "REFUND_ADDRESS_HIGH_RISK",
REFUND_ADDRESS_REJECTED: "REFUND_ADDRESS_REJECTED",
RECEIVE_ADDRESS_REJECTED: "RECEIVE_ADDRESS_REJECTED",
RECEIVE_ADDRESS_INVALID: "RECEIVE_ADDRESS_INVALID",
REFUND_ADDRESS_INVALID: "REFUND_ADDRESS_INVALID",
RECEIVE_TAG_REQUIRED: "RECEIVE_TAG_REQUIRED",
REFUND_TAG_REQUIRED: "REFUND_TAG_REQUIRED",
DEPOSIT_NETWORK_MAINTENANCE: "DEPOSIT_NETWORK_MAINTENANCE",
RECEIVE_NETWORK_MAINTENANCE: "RECEIVE_NETWORK_MAINTENANCE",
REFUND_NETWORK_MAINTENANCE: "REFUND_NETWORK_MAINTENANCE",
WITHDRAWAL_FAILED: "WITHDRAWAL_FAILED",
ORDER_EXPIRED: "ORDER_EXPIRED",
};