Status
This API will return the Ghosty order status to check the progress of transaction.
Gets Ghosty order status information
GET /status
Request Params
order_id*
string
Ghosty order ID
Response
The responses contain crucial information for the user:
"order_id" - A unique identifier for each order, essential for conducting status checks and for identification purposes should support be required. This identifier is critical for tracking and managing transactions within the system.
"creation_time" - The timestamp marking the initiation of the order. This information is crucial for tracking the order's lifecycle and for record-keeping purposes.
"address_from" - This is a one-time use address generated by the exchange partner, into which the user must deposit their funds for the transaction to proceed. Users have the option to connect this address to a wallet connect for convenience, though it is not mandatory. Direct transfers from the user's wallet to this address are fully supported.
"address_to" - The address specified by the user where the funds are intended to be received. This is a critical component of the transaction, directing where the processed funds should be sent.
currency_from" - This indicates the type of currency or token the user is required to send for the transaction. It is a critical identifier that ensures the transaction is processed using the correct source currency, according to the user’s initial transaction request. The "symbol_from" attribute aids in accurately defining the exchange parameters, including the conversion rate and applicable fees, based on the currency being sent. This ensures that both the user and the exchange partner have a clear understanding of the transaction's currency components, facilitating a smooth and transparent exchange process.
"currency_to" - The amount of funds the user is expected to receive in the target currency or token, denoted as "symbol_to". This figure is calculated based on the current exchange rate and any applicable fees at the time of the transaction's initiation. It provides the user with an estimate of the transaction's outcome, facilitating transparency and informed decision-making.
"amount_from" - The specified amount of tokens (denoted as "symbol_from") that the user is required to send. This amount is crucial for ensuring the transaction is processed correctly and efficiently, based on the terms of the exchange.
"amount_to" - Represents the target currency or token type into which the user's funds will be converted. This identifier is crucial for ensuring that the transaction is processed with the correct currency, aligning with the user's intentions and the specifics of the exchange agreement.
"sender_memo_tag" - A one-time use tag or memo that the user must specify when sending their transaction, required by certain chains for processing. This tag or memo is generated by the exchange partner and is essential for the transaction's identification and processing.
"receiver_memo_tag" - The tag or memo designated by the user for receiving the funds. This element is crucial for ensuring the funds are correctly attributed upon completion of the transaction.
"status" - Represents the current phase of the transaction process. Each status provides insight into the progress and state of the order, guiding users and support staff through the transaction lifecycle.
"is_anonym" - The flag for anonymous swap.
"fixed" - The flag for fixed rate or float rate. If the transaction is created based on Fixed rate, its value is True, and if the transaction is created on Float rate, its value is False.
Status Meaning
0: Waiting - User funds have not been received by the specified deposit address (identified as "address_from"). Action may be required from the user to ensure funds are correctly sent to the designated address.
1: Received – The exchange has acknowledged receipt of the user's funds at the deposit address (referred to as "address_to"). The transaction is currently being processed. This status indicates successful transfer initiation.
2: Anonymizing – The transaction is advancing to the next phase, which involves enhancing privacy measures before finalizing the transfer. This step ensures the anonymity of the transaction parties is maintained.
3: Sending– The transaction is progressing to its final stage. Funds are being sent to the intended recipient. This status indicates that the transaction is in the process of being completed.
4: Complete – The funds should have reached the recipient. The transaction is considered complete at this stage.
5: Expired - The transaction has not been completed within the designated timeframe and has therefore expired. Further action may be required to re-initiate the transaction or resolve the issue.
6: Failed - The transaction has failed to complete successfully. This could be due to various reasons including, but not limited to, network issues, insufficient funds, or incorrect transaction details. Further investigation and corrective action are required.
7: Refund - A refund process has been initiated for the transaction. This status indicates that the funds are being returned to the user. Details and timelines of the refund process should be communicated accordingly.
Last updated