接入指引

请求与响应

商户系统的 API 请求通过 HTTPS POST 方法提交给 OTT Pay API 服务器。

商户系统向 OTT Pay API 服务器发送 请求消息，OTT Pay API 服务器处理请求消息后返回 响应结果。请求消息和响应结果均为 JSON 格式，编码格式为 UTF-8。

响应结果采用通用格式的 JSON 对象表示，响应结果中的 status 属性表示是否是成功结果，而 result 属性表示实际返回数据。比如：

{
  "status": "SUCCESS",
  "result": {
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJPTjAwMDAwMTgyMTQiLCJhdWRpZW5jZSI6bnVsbCwicm9sZSI6bnVsbCwiY3JlYXRlZCI6MTY3NzU5NDY2MzM5NywidXNlcnR5cGUiOiJDVVNUT01FUiIsImV4cCI6MTY3NzU5NTU2MywidXNlcmlkIjoxNH0.YHOw2N8oUP3vn_L-euzuUiShDfQbowAjrWjeVef0wn4jgHA4k5zsgcZ6euRUk-R-Xtn2OkYB7R8geGBjQQYnMw",
    "expired": 1677595563672
  }
}

不成功的响应会在 result 中包含 error 和 message，比如：

{
  "status": "ERROR",
  "result": {
    "code": 10003,
    "message": "User does not exist"
  }
}

错误代码和相应的消息请参见：API 响应错误编码

授权方式

OTT Pay API 服务器采用 JWT token 授权的方式进行访问。商户系统需要先调用 授权 API 获得 token, 并在以后的每次API调用时在请求头中包含授权信息:

Authorization: Bearer <token>

例如:

Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJPTjAwMDAwMTgyMTQiLCJhdWRpZW5jZSI6bnVsbCwicm9sZSI6bnVsbCwiY3JlYXRlZCI6MTY3NzU5NDY2MzM5NywidXNlcnR5cGUiOiJDVVNUT01FUiIsImV4cCI6MTY3NzU5NTU2MywidXNlcmlkIjoxNH0.YHOw2N8oUP3vn_L-euzuUiShDfQbowAjrWjeVef0wn4jgHA4k5zsgcZ6euRUk-R-Xtn2OkYB7R8geGBjQQYnMw

@

API 服务器 URL

https://ecom-api.ottpay.com/

获得支付结果

当商户系统调用了 支付 API 后，需要根据返回的响应结果和支付场景进行后续的支付动作，有些支付场景不能立即得到支付结果。OTT Pay API 服务器从支付通道获到支付结果后会将支付结果发送到指定的回调 URL（回调 URL 需要在 支付 API 的请求参数中指定，请参见特定 API 说明）。当然商户系统也能通过 支付状态查询 API 进行主动查询。

API 响应错误编码