Status Codes for Financial Operations
Order status codes
| Order status code | Description of status code | Possible previous status codes | Possible next status codes |
|---|---|---|---|
| RECEIVED | The order request was passed through the API layer. | N/A | N/A |
| INVALID | The order request did not pass the API-level validation (e.g., the Requestor-ID references a natural person that is not in ACTIVE status). A webhook notification is sent for this status. Note: records with INVALID status are retained for 48 hours only. After that period, they are automatically purged and can no longer be retrieved via API. | N/A | N/A |
| PENDING | This status indicates that the order was received by the system and is now in the queue to be processed. At this stage, the order details are registered, but no trading actions have been taken yet. | N/A |
|
| CANCELED | The order has been canceled either by the user or the system. This means that the order will no longer be processed or executed. Cancellation can occur at any point before the order is filled. |
| N/A |
| REJECTED | This status indicates that the order has been rejected by the exchange. Rejection can occur due to various reasons such as insufficient funds, invalid order parameters, or system errors. A rejected order will not be processed or executed. A webhook notification is sent along with the rejection reason. |
| N/A |
| FILLED | The order has been successfully executed and the trade is complete. All the requested amount has been traded at the specified or better price. The order is now closed with this final status. |
|
|
| CORRECTED | This status indicates that there has been a correction on the order. This can happen due to post-trade processes where discrepancies are found and corrected to ensure the accuracy of trade records. |
|
|
| SETTLED | The order has been fully settled, meaning that all financial transactions related to the trade are complete. This status indicates that the trade has been finalized, and the funds or assets have been transferred accordingly. Now the funds can be withdrawn. |
| N/A |
Sequence diagram
sequenceDiagram participant Partner participant Platform Partner->>Platform: POST Create MARKET order (10 BTC) Platform -->> Partner: Order-id(Order status RECEIVED) Platform->>Platform: Order processing alt order executed Platform->>Platform: Balance and position updated Platform->>Partner: Order status FILLED Platform->>Platform: Settlement completed Platform->>Partner: Order status SETTLED end opt insufficient balance/position Platform->>Partner: Order status REJECTED end
Order Cancellation Behavior
When a cancel order request is submitted via DELETE /traditional/orders/{orderId}:
- Successful cancellation: The order status changes to
CANCELEDand a webhook notification is dispatched to the partner. - Failed cancellation: No webhook notification is sent. The order retains its previous status (e.g.,
PENDING). Partners should verify the order status via the Get Order endpoint if cancellation confirmation is not received.
Data Retention for INVALID Orders
Orders (and other records) with INVALID status are retained for 48 hours only. After this period, they are automatically purged from the system and will return a Not Found response when queried via the API. Partners should capture and log all webhook notifications for INVALID statuses immediately upon receipt.
Trade Document Generation
After a traditional order reaches FILLED status, the corresponding trade document (TRADE_INVOICE) is typically generated within a few seconds of the execution. The document can be retrieved via GET /traditional/orders/trade-invoice/{executionId}.
Warning
Test Environment Note: Trade documents can only be generated for assets that exist in the environment's asset universe. When testing in the sandbox environment, ensure you use only the ISINs provided in the supported asset list. Using ISINs outside the asset universe will result in missing trade documents even if the order itself was executed successfully.
Transfer status codes
| Transfer status code | Description of status code |
|---|---|
| RECEIVED | The transfer request was passed through the API layer. |
| INVALID | The transfer order request did not pass the validation. |
| PENDING | The transfer is created but not processed as some operations or checks are being performed. |
| REJECTED | The transfer was rejected. Please check the error codes for further details |
| PROCESSED | The transfer was successfully processed. |
Sequence diagram
sequenceDiagram participant Partner participant Platform participant SEPA Note over Partner,Platform: Incoming transfer SEPA->>Platform: Transfer notification Platform->>Platform: Balance updated Platform->>Partner: Transfer notification (status PROCESSED) Note over Partner,Platform: Outgoing transfer Partner->>Platform: Create Transfer Platform -->> Partner: Transfer created (transfer id, status RECEIVED) alt transfer processed Platform->>Platform: Balance updated Platform->>SEPA: Create Transfer SEPA-->>Platform: Platform->>Partner: Transfer notification (status PENDING) SEPA->>Platform: Transfer notification Platform->>Partner: Transfer notification (status PROCESSED) end opt insufficient balance Platform->>Partner: Transfer notification (status REJECTED) end
Transaction status codes
The list of Transaction status codes
| Transaction status code | Description of status codes |
|---|---|
| COMPLETED | This status means that the transaction has been fully processed or (for orders) executed successfully. All steps required to finalize the transaction have been carried out. |
| MODIFIED | This status signifies that the transaction details have been altered or updated after its initial completion. It reflects any changes made to the transaction parameters. |
Mapping of Transaction status codes
Order and Transaction status codes
| No. | Order status | Transaction status |
|---|---|---|
| 1 | RECEIVED | N/A |
| 2 | INVALID | N/A |
| 3 | PENDING | N/A |
| 4 | CANCELED | N/A |
| 5 | REJECTED | N/A |
| 6 | FILLED | COMPLETED |
| 7 | CORRECTED | MODIFIED |
| 8 | SETTLED | COMPLETED |
Transfer and Transaction status codes
| No. | Transfer status | Transaction status |
|---|---|---|
| 1 | RECEIVED | N/A |
| 2 | INVALID | N/A |
| 3 | PENDING | N/A |
| 4 | REJECTED | N/A |
| 5 | PROCESSED | COMPLETED |