概述

本文档详细描述了调用所有订单管理API接口时所需的通用参数、业务参数的格式、规则和要求。请在发起请求前仔细阅读。

调用流程

通用参数（所有接口必传）

这部分是所有接口都需要的公共参数，通常与身份认证、签名和账单基础信息相关。

参数名	类型	长度	是否必填	描述	示例
account	string	6	是	Oceanpayment账户号
terminal	string	8-12	是	Oceanpayment终端号
signValue	string	64	是	安全签名，用于验证交易的安全性，使用SHA256加密

订单状态查询

Request

参数名	类型	长度	是否必填	描述	示例
order_number	string	1-50	是	网站订单号 单次最大同时查询100笔交易，交易之间用“,”进行分隔

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
paymentInfo	string	支付信息订单出现多个paymentInfo时，多个paymentInfo会按照交易时间进行倒序
order_currency	string	交易币种
order_amount	string	交易金额
order_number	string	网站订单号
order_notes	string	订单备注信息，返回时则原样返回
methods	string	支付方式代码
order_currency	string	订单号的交易币种
payment_details	string	该笔交易的支付详情
order_amount	string	订单号的交易金额
payment_dateTime	string	交易时间 格式： yyyy-mm-dd HH:mm:ss
order_sourceUrl	string	订单来源URL
payment_id	string	支付ID，Oceanpayment的支付唯一单号
payment_results	string	对账结果
payment_details	string	该笔交易的支付详情
payment_risk	string	未通过的风控规则
payment_authCode	string	这笔交易的授权码，非信用卡交易返回为空
payment_eci	string	ECI值
payment_dateTime	string	支付日期时间 GMT+8 格式： yyyy-mm-dd HH:mm:ss
auth_status	string	预授权状态 0: 非预授权交易 1: 撤销授权 2: 待处理 3: 授权成功
payment_debitTime	string	记账时间 GMT+8 格式： yyyy-mm-dd HH:mm:ss
pay_barCode	string	订单打印码/微信/支付宝支付流水号
refund_status	string	退款状态 0: 未退款 1: 已退款
refundList	string	refundList退款节点信息
chargeBack_status	string	拒付状态 0: 未拒付 1: 已拒付
chargeBackList	string	chargeBackList拒付节点信息
duplicate_status	string	重复状态 相同终端号下，当30天内存在大于2笔成功/预授权待处理交易时返回1，否则返回0 0: 无 1: 有
transactionList	string	transactionList交易节点信息
update_status	string	更新状态 0: 未更新 1: 已更新
networkToken	string	networkToken节点信息
payment_authType	string	交易类型 0: 该交易类型为‘Sale’一般交易 1: 该交易类型为‘预授权且非3D’交易 2: 该交易类型为‘3D且非预授权’交易 3: 该交易类型为‘3D且预授权’交易
threeDSecure	string	threeDSecure3D节点信息
pay_typeCode	string	钱包返回类型，仅支付宝和微信支付会返回

成功订单查询

Request

参数名	类型	长度	是否必填	描述	示例
order_beginDate	string	19	是	开始时间 格式：yyyy-mm-dd HH:mm:ss
order_endDate	string	19	是	结束时间 格式：yyyy-mm-dd HH:mm:ss
pages	string	5	否	分页

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
results	string	支付结果
details	string	结果详情
count	string	总笔数
totalpages	string	总页数
pages	string	当前页
orderInfo	string	orderInfo订单节点信息

业务订单查询

Request

参数名	类型	长度	是否必填	描述	示例
order_beginDate	string	19	是	开始时间 格式：yyyy-mm-dd HH:mm:ss
order_endDate	string	19	是	结束时间 格式：yyyy-mm-dd HH:mm:ss
pages	string	5	否	分页
count	string	3	否	每页返回笔数 默认10 10: 10笔 50: 50笔 100: 100笔
date_type	string	3	否	时间类型 默认0 0: 复核时间 1: 交易时间 2: 异常时间

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
results	string	结果代码
details	string	结果详情
count	string	总笔数
totalpages	string	总页数
pages	string	当前页
orderInfo	string	orderInfo订单节点信息

争议订单查询

Request

参数名	类型	长度	是否必填	描述	示例
order_beginDate	string	19	是	开始时间 格式：yyyy-mm-dd HH:mm:ss
order_endDate	string	19	是	结束时间 格式：yyyy-mm-dd HH:mm:ss
notice_type	string	0-50	否	争议类型 默认查询所有 disputes-period: 宽限期 dispute: 争议
payment_id	string	0-50	否	支付ID，Oceanpayment的支付唯一单号
order_number	string	0-50	否	网站订单号

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
results	string	结果代码
details	string	结果详情
count	string	总笔数
totalpages	string	总页数
pages	string	当前页
orderInfo	string	orderInfo订单节点信息

预授权

Request

参数名	类型	长度	是否必填	描述	示例
payment_id	string	1-50	是	支付ID，Oceanpayment的支付唯一单号
order_amount	string	0-50	否	授权金额 不传金额时视为全额处理
payment_authType	string	1	是	授权类型 1: 确认授权 2: 撤销授权 3: 撤单（仅支持微信、支付宝线下场景）

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
order_number	string	网站订单号
payment_id	string	支付ID，Oceanpayment的支付唯一单号
payment_status	string	操作状态 1: 成功 0: 失败
payment_details	string	结果详情

退款申请

Request

参数名	类型	长度	是否必填	描述	示例
payment_id	string	0-50	是	支付ID，Oceanpayment的支付唯一单号
refund_number	string	0-50	否	商户网站系统内部的退款流水号
refund_type	string	1	是	退款类型 1: 全额退款 2: 部分退款
refund_amount	string	1-10	是	退款金额
refund_description	string	1-100	是	退款原因说明
refund_reference	string	0-50	否	商户网站系统内部的退款参考号

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
payment_id	string	支付ID，Oceanpayment的支付唯一单号
order_number	string	交易订单号
refund_number	string	商户网站系统内部的退款流水号
refund_id	string	退款ID，Oceanpayment的唯一退款编号
refund_results	string	退款申请结果
refund_description	string	退款原因说明
refund_reference	string	商户网站系统内部的退款参考号

退款查询

Request

参数名	类型	长度	是否必填	描述	示例
refund_id	string	1-500	二选一	退款ID，Oceanpayment的唯一退款编号
refund_number	string	1-50	二选一	商户网站系统内部的退款流水号

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
refund_id	string	退款ID，Oceanpayment的唯一退款编号
refund_number	string	商户网站系统内部的退款流水号 有传refund_number时，会原样返回
refund_queryNo	string	退款凭证 发卡银行端提供的退款凭证号码，并非所有发卡行都会进行提供
refund_check	string	退款查询结果代码
refund_description	string	退款查询原因说明

物流单号上传

Request

参数名	类型	长度	是否必填	描述	示例
payment_id	string	1-50	二选一	支付ID，Oceanpayment的支付唯一单号 与order_number二选一
order_number	string	1-50	二选一	网站订单号 与payment_id二选一
tracking_number	string	1-200	否	物流单号相同的支付ID再次上传会覆盖上一次的物流单号物流单号 相同的payment_id再次上传会覆盖上一次的物流单号 如果一笔订单存在多个物流单号用“，”分隔
tracking_site	string	1-100	是	查询物流信息的网站
tracking_handler	string	1-15	是	物流信息添加人

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
payment_id	string	支付ID，Oceanpayment的支付唯一单号
tracking_results	string	物流上传结果

海关上送

Request

参数名	类型	长度	是否必填	描述	示例
type	string	0-500	否	类型 每笔订单只能成功发起一次海关上送请求，如需要重推请发送type=2 1: 海关上送 2: 重新上送(重推)
payment_id	string	0-50	否	支付ID，Oceanpayment的支付唯一单号
pay_userId	string	0-50	否	身份证
pay_userName	string	0-50	否	姓名
price	string	1-100	是	商品单价
total_amount	string	1-100	是	总价
customs	string	1-100	是	海关代码
customs_number	string	1-100	是	商户海关备案号
customs_name	string	1-100	是	商户海关备案名称
sub_order_number	string	0-100	否	商户子订单号，拆单时必传
shipping_fee	string	1-100	是	物流费
order_notes	string	0-500	否	备注

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
signValue	string	安全签名，用于验证交易的安全性，使用SHA256加密
payment_id	string	支付ID，Oceanpayment的支付唯一单号
type	string	类型
status	string	上送状态 0: 失败 1: 成功 2: 待处理 上送结果通过异步进行推送
details	string	详情说明

健康检查

Request

参数名	类型	长度	是否必填	描述	示例
site	string	1-500	是	网站当前使用的主域名，不带https://
key	string	0-256	否	Oceanpayment公钥

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
results	string	校验结果 1: 存在记录且状态为已复核(正常)，可能会存在多条记录的情况，只要其中一条状态为已复核(正常)即视为1 2: 存在记录且全部状态为非已复核(正常) 0: 不存在记录
site	string	网址，原样返回

卡BIN校验

Request

参数名	类型	长度	是否必填	描述	示例
card_bin	array	-	是	前6位卡BIN,单次最大同时查询 100个卡号

Response

参数名	类型	描述	示例
account	string	Oceanpayment账户号
terminal	string	Oceanpayment终端号
list	string	每个卡BIN的结果组成数组
check_results	string	卡BIN的校验结果 1:成功匹配 0:无法识别
card_bin	string	前6位卡BIN，原样返回
card_type	string	卡种名称
card_country	string	卡种国家