Order object structure
Last updated: 03-Sep-2025
| Parameters | Type/Description |
|---|---|
| RefNo | String |
| The unique, system-generated identifier of a partner order. | |
| Status | String |
| Order status. Possible values: CANCELED, REFUND, TEST, REJECTED, COMPLETE, SUSPECT, AWAITING_PAYMENT, PENDING_APPROVAL, DELIVERY_NEEDS_INFO. | |
| OrderLockReason | StringArray |
|
The reason why the order is blocked in a certain status.
For AWAITING_PAYMENT order status, the OrderLockReason can be: UNPAID_PROFORMA, NOT_ENOUGH_CREDIT
For order status DELIVERY_NEEDS_INFO, the OrderLockReason can be:
Can be NULL. |
|
| ProformaNumber | String |
| The unique number of the partner invoice associated with this order. Can be NULL. | |
| TotalAmount | double |
| The total value of the order, including tax, but excluding partner margins and discounts. | |
| Currency | String |
| The order currency ISO code. | |
| TotalSubbscriptionsNumber | Int |
| The total number of subscriptions generated for the products included in the order. Can be NULL, if subscriptions have yet to be generated for an order. |
Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.
We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.