好的收款接口及相应的说明文档

来源:互联网 发布:防晒霜推荐知乎 编辑:程序博客网 时间:2024/06/05 15:29

需要对接一个接口时,一般先要阅读这个接口的文档,一个好的收款接口及相应的说明文档应该包含以下几个方面:

接口作用描述

描述这个收款支付接口的一般使用场景,给阅读者一个整体概念。

整体调用过程描述

描述这个收款支付接口的在各种情况下如何调用其他相关后续接口。比如收款检测接口,退款接口等

输入参数作用描述

描述这个收款接口所有输入参数的要求和作用。

不同场景输入参数举例

对不同场景下输入参数的举例,让阅读者有直观认识。

返回参数完整,说明清晰

描述这个接口的所有返回参数的作用,并且保证返回参数能够满足所有业务方的需要。

返回结果判定依据清晰

根据返回参数能够清晰准确地判断当前支付请求的状态。

错误码表完整,说明清晰

有完整的错误码及相应描述,既便于调用方能够根据错误码进行相应的后续处理,还能提高对接开发效率。

有相应支付检测接口

有支付检测接口可以随时查询当前支付请求的状态

有代码Demo供参考

降低开发者的入门难度,提高对接开发效率。


收款检测接口及相应的说明文档应该包含以下几个方面:

输入参数完整

检测的输入参数支持使用商户订单号及第三方订单号

返回参数完整,说明清晰

描述这个接口的所有返回参数的作用,并且保证返回参数能够满足所有业务方的需要。

返回结果判定依据清晰

根据返回参数能够清晰准确地判断当前支付请求的状态。

错误码表完整,说明清晰

有完整的错误码及相应描述,既便于调用方能够根据错误码进行相应的后续处理,还能提高对接开发效率。

有代码Demo供参考

降低开发者的入门难度,提高对接开发效率。


0 0