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": "2575000",
        "outcome": "100",
        "currency": "vnd",
        "rate": "25750",
        "original_rate": "25500",
        "token_address": "0x55d398326f99059ff775485246999027b3197955",
        "chain_id": 56,
        "recipient": "0xUSER_WALLET_ADDRESS",
        "reference_no": "DEPOSIT-001",
        "external_id": "ext-001",
        "partner_id": "partner-xyz",
        "user_id": "user-abc",
        "provider": 1,
        "processing_time": 12400,
        "client_ip": "127.0.0.1",
        "callback": "https://yourapp.com/api/webhooks/payment",
        "fees": { "service_fee": 5000, "min_fee": 2000 },
        "total_fee_vnd": 5000,
        "pay_data": {
          "bank_account_name": "CONG TY HOLDSTATION",
          "bank_account_number": "9876543210",
          "bank_bin_code": "970423",
          "bank_name": "Tien Phong Bank",
          "bank_short_code": "TPBank",
          "payment_link": "https://dl.vietqr.io/pay?...",
          "qr_code": "00020101021238...",
          "qr_image": "data:image/png;base64,...",
          "external_id": "hpay-ext-001"
        },
        "payment_info": null,
        "reference": {
          "hs_rate": 25000,
          "usdt_rate": 25500,
          "token_rate": 1.0,
          "partner_rate": 25750,
          "spread": 0.02,
          "buffer_rate": 0.005,
          "buffered_rate_usdt": 25628,
          "buffered_rate_partner": 25750,
          "addition_share_rate": 0,
          "partner_override_revenue": 0,
          "sim_webhook_id": ""
        },
        "body": {},
        "error": null,
        "created_at": { "seconds": 1700000000, "nanos": 0 },
        "updated_at": { "seconds": 1700012400, "nanos": 0 },
        "expired_at": { "seconds": 1700003600, "nanos": 0 }
      }
    ],
    "total_count": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://pay-docs.holdstation.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Partners can query a list of their payment orders with optional filtering by state, type, and date range.
​
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. Deposit: 10–16. Withdrawal: 20–25. See table below.
​
page
integer
Page number for pagination.
​
page_size
integer
Number of results per page.
​
sort_by
string
Sort field. Available values: created_at, expired_at, amount.
​
sort_desc
boolean
If true, sort in descending order.
​
created_at_from
integer
Filter orders created after this Unix timestamp (seconds).
​
created_at_to
integer
Filter orders created before this Unix timestamp (seconds).
​
expired_at_from
integer
Filter orders expiring after this Unix timestamp (seconds).
​
expired_at_to
integer
Filter orders expiring before this Unix timestamp (seconds).
​
recipient
string
Filter by token recipient wallet address.
​
reference_nos
string[]
Filter by a list of partner reference numbers.

​
Processing State Values

ValueNameDescription
10DepositFiatPendingWaiting for user to deposit fiat
11DepositFiatConfirmedFiat deposit confirmed
12DepositFiatFailedFiat deposit failed
13DepositCryptoPendingWaiting for USDT transfer on-chain
14DepositCryptoConfirmedUSDT transfer confirmed
15DepositCryptoFailedUSDT transfer failed
16DepositFiatWaitingForApprovalFiat payment pending manual approval
20WithdrawCryptoPendingWaiting for user to transfer USDT
21WithdrawCryptoConfirmedUSDT transfer confirmed on-chain
22WithdrawCryptoFailedUSDT transfer failed
23WithdrawFiatPendingWaiting for VND bank transfer
24WithdrawFiatConfirmedVND bank transfer confirmed
25WithdrawFiatFailedVND bank transfer failed
{
  "message": "success",
  "data": {
    "orders": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "code": 100001,
        "order_type": 1,
        "state": 3,
        "processing_state": 14,
        "amount": "2575000",
        "outcome": "100",
        "currency": "vnd",
        "rate": "25750",
        "original_rate": "25500",
        "token_address": "0x55d398326f99059ff775485246999027b3197955",
        "chain_id": 56,
        "recipient": "0xUSER_WALLET_ADDRESS",
        "reference_no": "DEPOSIT-001",
        "external_id": "ext-001",
        "partner_id": "partner-xyz",
        "user_id": "user-abc",
        "provider": 1,
        "processing_time": 12400,
        "client_ip": "127.0.0.1",
        "callback": "https://yourapp.com/api/webhooks/payment",
        "fees": { "service_fee": 5000, "min_fee": 2000 },
        "total_fee_vnd": 5000,
        "pay_data": {
          "bank_account_name": "CONG TY HOLDSTATION",
          "bank_account_number": "9876543210",
          "bank_bin_code": "970423",
          "bank_name": "Tien Phong Bank",
          "bank_short_code": "TPBank",
          "payment_link": "https://dl.vietqr.io/pay?...",
          "qr_code": "00020101021238...",
          "qr_image": "data:image/png;base64,...",
          "external_id": "hpay-ext-001"
        },
        "payment_info": null,
        "reference": {
          "hs_rate": 25000,
          "usdt_rate": 25500,
          "token_rate": 1.0,
          "partner_rate": 25750,
          "spread": 0.02,
          "buffer_rate": 0.005,
          "buffered_rate_usdt": 25628,
          "buffered_rate_partner": 25750,
          "addition_share_rate": 0,
          "partner_override_revenue": 0,
          "sim_webhook_id": ""
        },
        "body": {},
        "error": null,
        "created_at": { "seconds": 1700000000, "nanos": 0 },
        "updated_at": { "seconds": 1700012400, "nanos": 0 },
        "expired_at": { "seconds": 1700003600, "nanos": 0 }
      }
    ],
    "total_count": 1
  }
}