Skip to main content
GET
/
partners
/
orders
List Orders
curl --request GET \
  --url https://pay-api.holdstation.com/partners/orders
{
  "message": "success",
  "data": {
    "orders": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "code": 100001,
        "order_type": 1,
        "state": 3,
        "processing_state": 14,
        "amount": "1000000",
        "rate": "25850",
        "reference_no": "ORDER-001"
      }
    ],
    "total_count": 1
  }
}

​
Overview

Partners can query a list of their payment orders with optional filtering by state. The results are paginated using page_size and page parameters.
​
type
integer[]
Filter by order type. 1 = Deposit, 2 = Withdrawal.
​
state
integer[]
Filter by order state. 1 = New, 2 = Processing, 3 = Completed, 4 = Failed, 5 = Closed.
​
processing_state
integer[]
Filter by processing state. See Order Flow for all values.
​
page
integer
Page number.
​
page_size
integer
Number of results per page.
​
sort_by
string
Sort field. Available values: created_at, expired_at, amount.
​
sort_desc
boolean
Sort in descending order.
​
created_at_from
integer
Filter orders created after this Unix timestamp.
​
created_at_to
integer
Filter orders created before this Unix timestamp.
​
expired_at_from
integer
Filter orders expiring after this Unix timestamp.
​
expired_at_to
integer
Filter orders expiring before this Unix timestamp.
​
recipient
string
Filter by token recipient hex address.
​
reference_nos
string[]
Filter by a list of reference numbers.
{
  "message": "success",
  "data": {
    "orders": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "code": 100001,
        "order_type": 1,
        "state": 3,
        "processing_state": 14,
        "amount": "1000000",
        "rate": "25850",
        "reference_no": "ORDER-001"
      }
    ],
    "total_count": 1
  }
}