SparkPay OpenAPI 文档
简体中文
简体中文
简体中文
English
简体中文
简体中文
简体中文
English
接入必读
复制页面
产品介绍
快速指引
接入准备
接口加签说明
接入必读
接口规则
异步通知
接口错误码
网络与币种
对接场景
支付
关闭订单
API列表
统一收银台付款
POST
支付订单关闭
POST
支付订单查询
GET
统一收银台付款(专业版)
POST
支付订单查询(专业版)
GET
常见问题
通知相关问题
跳转失败问题
接口报错提示问题
测试币领取/测试网连接
对接示例
接口签名示例-Postman
接口签名示例-php
版本说明
版本说明
简体中文
简体中文
简体中文
English
简体中文
简体中文
简体中文
English
接入必读
复制页面
接口规则
基本规则
#
1.
所有的API请求必须使用HTTPS。
2.
请按照
接口加签说明
要求生成请求签名,请务必在服务端完成签名生成。
3.
调用方每次发起调用时,都需使用
User-Agent
HTTP 请求头来标识自己,支付平台会拒绝处理无
User-Agent
的请求
数据格式
#
支付平台API使用JSON作为消息体的数据交换格式。请求须设置HTTP头部:
参数兼容性
#
请求是否成功,与请求参数的顺序无关。
请求是否成功,与请求JSON中的键值对出现的顺序无关。
处理应答时,不应假设应答JSON中的键值对出现的顺序。
新的API版本可能在请求或应答中加入新的参数或者JSON的键值对。
新的API版本不会去除请求和应答中已经存在的必填参数或者JSON的键值对。
当请求或应答中的JSON键值对的值为空(null)时,可以省略。
错误信息
#
支付平台API使用HTTP状态码来表示请求处理的结果。
处理成功的请求,如果有应答的消息体将返回200。
请求处理失败时,如缺少必要的入参、支付时余额不足等,将会返回400范围内的错误码。
请求处理时发生了支付平台侧的服务系统错误,将返回500的状态码。这种情况比较少见。
错误码与错误提示
#
当请求处理失败时,除了HTTP状态码表示错误之外,API将在消息体返回错误相应说明具体的错误原因。
code:
接口错误码
。
message:错误描述,使用易理解的文字表示错误的原因。
User Agent
#
HTTP协议要求发起请求的客户端在每一次请求中都使用HTTP头User-Agent来标识自己。支付平台建议调用方选用以下两种方式的一种:
1.使用HTTP客户端默认的User-Agent。
2.遵循HTTP协议,使用自身系统和应用的名称和版本等信息,组成自己独有的User-Agent。
支付平台API会拒绝处理无User-Agent的请求。
修 改于
2024-10-12 06:45:55
上一页
接口加签说明
下一页
异步通知