跳至主要内容

查詢收款單

查詢收款訂單詳情接口。

請求資訊​

  • 請求 URL： /gateway/api/v1/payments
  • 請求方式： GET
  • Content-Type： application/x-www-form-urlencoded; charset=utf-8

請求頭 (Headers)​

參數名類型說明
AuthorizationString{authorization} 系統分配給平台之授權識別

請求參數​

參數名必選類型說明
offset否Integer(10)查詢偏移量，預設 0
limit否Integer(10)訂單返回數量，預設 25，最高 500
payment_id否String(10)系統訂單號
payment_cl_id否String(32)商戶訂單號
create_time__gte否Integer(10)創建時間起（秒）
carete_time__lte否Integer(10)創建時間迄（秒）

返回示例​

成功返回​

{
  "error_code": "0000",
  "data": [
    {
      "amount": 30000,
      "real_amount": 0,
      "fee": 0,
      "payment_id": "PM00000145",
      "payment_cl_id": "xinxin_1596380261_10",
      "payment_cl_name": "testname",
      "platform_id": "PF0060",
      "platform_channel_id": "PFC00000142",
      "status": 3,
      "memo": "",
      "create_time": 1596425140,
      "update_time": 1596425770,
      "sign": "459408960e8e7173f6eae20c2bb8339f"
    },
    {
      "amount": 30000,
      "real_amount": 0,
      "fee": 0,
      "payment_id": "PM00000144",
      "payment_cl_id": "xinxin_1596380261_11",
      "payment_cl_name": "testname",
      "platform_id": "PF0060",
      "platform_channel_id": "PFC00000142",
      "status": 3,
      "memo": "",
      "create_time": 1596424960,
      "update_time": 1596425590,
      "sign": "151ed70de39dc222f3444bc84947975a"
    }
  ],
  "total": 2
}

錯誤返回示例​

{
  "error_code": "0006",
  "error_msg": "无效的Authorization!"
}

返回參數說明​

參數名類型說明
error_codeString錯誤碼
error_msgString錯誤訊息（error_code 不為 "0000" 時返回）
statusInteger訂單狀態（參考 訂單狀態列表）
payment_cl_nameString存款人姓名
signString訂單簽名，參考 簽名規則

備註​

  • 所有查詢條件以 key=value 形式以 & 串接成 QueryString 帶在網址後
  • authorization 為系統分配給平台之授權識別，如尚未取得請聯繫系統人員
  • 返回的每筆訂單皆有簽名 (sign)，所有欄位皆參與簽名
  • 訂單將由創建時間降序排序，後進先出
  • 創建時間起迄必須同時填入才有效，皆填入 Unix timestamp