POST/api/v2/order/info

Query Order Information

Query order information by Cregis order ID.

Rate limit: 1000 requests/minute

Request

Request Body

required

application/json

noncestringrequired
6-character random string.
pidinteger<int64>required
Project ID.
signstringrequired
Signature.
timestampinteger<int64>required
Timestamp.
cregis_idstringrequired
Cregis order ID.

Responses

200Success

application/json

codestring
Response code.
msgstring
Response message.
dataobject
- cregis_idstring
  Cregis order ID.
- order_idstring
  Merchant Order Id
- order_amountstring
  Order Amount
- order_currencystring
  Order currency.
- created_timeinteger<int64>
  Order creation time in 13-digit Unix timestamp format
  
  e.g. 1750407942433, i.e. 2024-07-09 14:57:49 092
- cancel_timeinteger<int64>
  Order cancellation time in 13-digit Unix timestamp format
  
  e.g. 1750407942433, i.e. 2024-07-09 14:57:49 092
- transact_timeinteger<int64>
  Order completion time in 13-digit Unix timestamp format
  
  e.g. 1750407942433, i.e. 2024-07-09 14:57:49 092
- valid_timeinteger<int32>
  Unit: minutes.
  
  Order validity period. After the validity period expires, the order can no longer be paid.
- statusstring
  enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
  Order status
  
  newpending payment
  
  paidpaid
  
  expiredorder exceeded the validity period
  
  paid_overpayment exceeds the order amount
  
  paid_partialpayment is less than the order amount
  
  canceledorder canceled, such as when refund is completed
- refund_requestedstring
  enum: "yes", "no"
  Whether the order has a refund
  
  nono refund record
  
  yesrefund record exists
- payer_idstring
  Payer information.
- payer_namestring
  Payer name.
- payer_emailstring
  Payer email.
- remarkstring
  Order remark information.
- payment_detailarray<object>
  Payment records.
  Array items · object
  payment_addressstring
  Deposit address.
  from_addressstring
  Payer address.
  receive_amountstring
  Order amount after exchange-rate conversion.
  receive_currencystring
  Order currency after exchange-rate conversion.
  pay_amountstring
  Actual received amount.
  pay_currencystring
  Received currency.
  exchange_ratestring
  Exchange rate.
  tx_idstring
  Transaction hash.
  blockchainstring
  Currency network.
  token_namestring
  Network-specific token display name. Identifies the token variant on the specified blockchain, such as USDT-TRC20 or USDT-ERC20.
- payment_infoarray<object>
  Requested payment information.
  Array items · object
  payment_addressstring
  Deposit address.
  token_symbolstring
  Payment token symbol. The asset code of the cryptocurrency, such as USDT, BTC, or ETH. It does not include the blockchain network.
  blockchainstring
  Currency network.
  token_namestring
  Network-specific token display name. Identifies the token variant on the specified blockchain, such as USDT-TRC20 or USDT-ERC20.
  logo_urlstring
  Currency logo URL.
  token_decimalsinteger
  Token decimals.
  receive_amountstring
  Order amount after exchange-rate conversion.
  receive_currencystring
  Order currency code after exchange-rate conversion.
  exchange_ratestring
  Exchange rate.
  asset_logostring
  Token asset logo.
- refund_dataobject
  Refund order information.
  refund_statusinteger
  enum: 0, 1, 2
  Refund status
  
  0refund processing
  
  1refund successful
  
  2refund failed
  
  refund_idstring
  Cregis refund order ID.
  cregis_idstring
  Unique Cregis payment order ID.
  reference_idstring
  Original merchant order ID.
  recipient_idstring
  Merchant internal customer ID.
  recipient_namestring
  Refund recipient name.
  recipient_emailstring
  Refund recipient email.
  recipient_addressstring
  Refund recipient on-chain address.
  tokenstring
  For the refund order token, pass the crypto token_name, such as USDT-BEP20 or USDT-TRC20.
  networkstring
  Refund order blockchain network.
  refund_amountstring
  Refund amount.
  refund_feestring
  Gas fee required for the refund.
  refund_tx_idstring
  Refund transaction hash.
  refund_created_timeinteger<int64>
  Refund order creation time in 13-digit Unix timestamp format
  
  e.g. 1720508269092, i.e. 2024-07-09 14:57:49 092
  refund_transact_timeinteger<int64>
  Refund order last update time in 13-digit Unix timestamp format
  
  e.g. 1720508269092, i.e. 2024-07-09 14:57:49 092
  actual_refund_amountstring
  Actual refund amount after miner fees are deducted.
  typeinteger
  enum: 1, 2
  Refund type
  
  1partial refund
  
  2full refund
- order_details
  shopping_costnumber
  Order shipping cost.
  tax_costnumber
  Order tax cost.
  itemsarray
  Details of the items purchased in the order.
  Array items
  item_idstring
  Unique item ID.
  item_namestring
  Item name.
  item_pricenumber
  Item price.
  price_currencystring
  Item currency.
  item_quantityinteger<int64>
  Item quantity.
- settlement_statusstring
  enum: "unsettled", "settling", "settled"
  Settlement status:
  
  unsettledsettlement not processed yet
  
  settlingsettlement processing
  
  settledsettlement completed
- settlement_typestring
  enum: "system", "manual"
  Settlement type
  
  systemautomatic settlement
  
  manualmanual settlement
- sub_merchant
  sub_merchant_idstring
  Unique sub-merchant ID.
  sub_merchant_namestring
  Sub-merchant name.

Try it

This endpoint is signed server-side; no key needed here.

Request body (JSON)

Request example

application/json

{
  "nonce": "m8jisx",
  "pid": 1382528827416576,
  "sign": "cebd2bfd56766f1143dc40d078b64dac",
  "timestamp": 1687848653294,
  "cregis_id": "po1420761885130752"
}

Response example

200 · application/json

{
  "code": "00000",
  "msg": "ok",
  "data": {
    "cregis_id": "po1420761885130752",
    "order_id": "merchant_order_id_123",
    "order_amount": "5.00",
    "order_currency": "HKD",
    "created_time": 1687848653294,
    "cancel_time": 1687850453294,
    "transact_time": 1687849000000,
    "valid_time": 30,
    "status": "paid",
    "refund_requested": "no",
    "payer_id": "user_001",
    "payer_name": "John Doe",
    "payer_email": "[email protected]",
    "remark": "Product purchase",
    "payment_detail": [
      {
        "payment_address": "TUX9zGoPFVXd6RC7pg18nfVLATeN9vgBeX",
        "from_address": "sender_wallet_address",
        "receive_amount": "5.123456",
        "receive_currency": "USDT",
        "pay_amount": "5.00",
        "pay_currency": "USDT",
        "exchange_rate": "0.9775",
        "tx_id": "abc123def456...",
        "blockchain": "TRON",
        "token_name": "USDT-TRC20"
      }
    ],
    "payment_info": [
      {
        "payment_address": "TMainWalletAddressXXXXXXXXXXXXXXXXXX",
        "token_symbol": "USDT",
        "blockchain": "TRON",
        "token_name": "USDT-TRC20",
        "logo_url": "https://static.cregis.io/pic/coin/USDT-TRX.png",
        "token_decimals": 6,
        "receive_amount": "5.123456",
        "receive_currency": "USDT",
        "exchange_rate": "0.9775",
        "asset_logo": "https://cdn.cregis.com/tokens/usdt.png"
      }
    ],
    "refund_data": {
      "refund_status": 1,
      "refund_id": "rf1420761885130752",
      "cregis_id": "po1420761885130752",
      "reference_id": "ref_merchant_order_123",
      "recipient_id": "recipient_001",
      "recipient_name": "Refund User",
      "recipient_email": "[email protected]",
      "recipient_address": "TRefundAddressXXXXXXXXXXXXXXXXXX",
      "token": "USDT-TRC20",
      "network": "TRON",
      "refund_amount": "5.00",
      "refund_fee": "0.05",
      "refund_tx_id": "refund_abc123...",
      "refund_created_time": 1719994183015,
      "refund_transact_time": 1719994383015,
      "actual_refund_amount": "4.95",
      "type": 2
    },
    "order_details": {
      "shopping_cost": 10.88,
      "tax_cost": 10,
      "items": [
        {
          "item_id": "10001",
          "item_name": "Product1",
          "item_price": 123,
          "price_currency": "USD",
          "item_quantity": 1
        }
      ]
    },
    "settlement_status": "unsettled",
    "settlement_type": "system",
    "sub_merchant": {
      "sub_merchant_id": "submerchant10001",
      "sub_merchant_name": "Merchant1"
    }
  }
}