OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
trade_type | Enum | Optaion | CASH | Range: CASH/JSAPI/QRCODE/NATIVE/APP/H5/WXMINI | 支付类型:
|
body | String | Required | 商品名称,订单标题 | ||
total_fee | String | Required | 订单总金额,单位:分 | ||
openid | String | Required | openid | ||
notify_url | String | Optaion | 前台回调地址 | ||
customer_mobile | String | Optaion | |||
customer_address | String | Optaion | 客户地址 | ||
customer_username | String | Optaion | varchar | ||
remark | String | Optaion | 客户备注,内部使用 | ||
goods_name | String | Optaion | 商品名称 | ||
goods_num | String | Optaion | 商品数量 | ||
goods_total_price | String | Optaion | 商品总价格,单位:分 | ||
goods_image | String | Optaion | 商品图片 | ||
more_params | String | Optaion | 更多订单参数,内部使用,推荐使用json格式。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
trade_type | Option | |
body | *Required | |
total_fee | *Required | |
openid | *Required | |
notify_url | Option | |
customer_mobile | Option | |
customer_address | Option | |
customer_username | Option | |
remark | Option | |
goods_name | Option | |
goods_num | Option | |
goods_total_price | Option | |
goods_image | Option | |
more_params | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
options | Object | 成功创建支付订单后返回给客户端的数据,失败时或人工支付时为null |
out_trade_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 |