Skip to main content

Create Deposit Order

Create一個新的Deposit (Deposit)Order.

Request Information

ItemValue
MethodPOST
Path/gateway/api/v1/payments
Content-Typeapplication/json

Request Parameters

ParameterTypeRequiredDescription
platform_idstring平台Merchant ID
service_idstring服務Type, Refer to Service ID List
merchant_order_idstringMerchantOrder號, 須唯一
amountnumberOrderAmount
notify_urlstringCallback Notification URL
return_urlstring支付完成後Redirect URL
extra_infostring額外資訊, 回調時原樣Return
signstringSignature, Refer to Signature規範

Request Example

{
"platform_id": "10001",
"service_id": "CN_BANK_DEPOSIT",
"merchant_order_id": "ORDER_20231218_001",
"amount": 100000,
"notify_url": "https://your-domain.com/api/callback",
"return_url": "https://your-domain.com/payment/result",
"sign": "a1b2c3d4e5f6..."
}

Response Parameters

ParameterTypeDescription
codenumberStatus碼, 0 表示成功
messagestringStatus訊息
data.order_idstringSystemOrder号
data.payment_urlstring支付頁面 URL
data.expire_timestringOrder過期時間

Response Example

{
"code": 0,
"message": "success",
"data": {
"order_id": "DP20231218123456789",
"payment_url": "https://pay.your-domain.com/checkout/DP20231218123456789",
"expire_time": "2023-12-18T15:30:00+08:00"
}
}

Error Codes

Error CodesDescription
1001參數錯誤
1002Signature驗證失敗
1003Merchant不存在
1004服務未開通
1005Order號重複