OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
buyer_id | String | Optaion | MAX: 64 | 购买者ID,例如会员ID | |
body | String | Required | MAX: 128 | 对一笔交易的具体描述信息 | |
subject | String | Required | MAX: 256 | 商品标题 | |
order_no | String | Optaion | MAX: 64 | 订单号,不可重复,如果客户端未指定,将由系统自动生成,格式为:YmdHis+随机4位数字 | |
amount | String | Required | MAX: 20 | 需要支付的金额,单位元 | |
timeout_express | Int | Optaion | 600 | 过期时间,单位:秒。默认600秒,即10分钟过期。 | |
return_param | String | Optaion | MAX: 200 | 异步通知时原样返回的数据,不可包含特殊符号 | |
goods_type | Enum | Optaion | 0 | Range: 0/1 | 商品类型,0:虚拟商品 1:实物商品 |
store_id | String | Optaion | MAX: 32 | 商户用来区分门店的标记 | |
qr_mod | Int | Optaion | 2 | MIN: 0;MAX: 4 | pc扫码支付的方式,支持前置模式与后置模式。具体看文档,默认为2 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
buyer_id | Option | |
body | *Required | |
subject | *Required | |
order_no | Option | |
amount | *Required | |
timeout_express | Option | |
return_param | Option | |
goods_type | Option | |
store_id | Option | |
qr_mod | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作状态码,0发起支付成功,1订单号已被使用,2发起支付宝失败,9插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
url | String | 成功发起支付后,返回可以用于跳转到支付宝支付的页面 |
order_no | String | 成功发起支付后的订单号 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |