接口描述:

  • 获取支付配置列表。

请求 URL:

  • http|https://host/api/v1/payment/method/get.payment.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

相关文档:

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
type string 见附属 A deposit 支付类型
is_select integer in:0,1 0 是否选择框 0=否 1=是
exclude_code integer min[]:0 [1,2] 排除支付编码

附属 A:
in:deposit,inpour,payment,refund
deposit=可用于财务充值
inpour=可用于账号充值
payment=可用于订单支付
refund=支持原路退款

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data array [] 返回数组
data 类型 是否返回 示例值 描述
payment_id integer 3 支付编号
name string 支付宝 支付名称
code integer 2 支付编码,详见「Code常量」
image string //image.jpg 支付图片
is_deposit integer 1 是否用于财务充值 0=否 1=是
is_inpour integer 1 是否用于账号充值 0=否 1=是
is_payment integer 1 是否用于订单支付 0=否 1=是
is_refund integer 1 是否支持原路退款 0=否 1=是
model string alipay 支付配置对应模型,详见「Model模块驱动」
sort integer 50 支付排序值
status integer 1 支付状态 0=禁用 1=启用

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": [
  5. {
  6. "payment_id": 1,
  7. "name": "账户资金",
  8. "code": 0,
  9. "image": "",
  10. "is_deposit": 1,
  11. "is_inpour": 0,
  12. "is_payment": 0,
  13. "is_refund": 0,
  14. "model": "",
  15. "sort": 50,
  16. "status": 1
  17. },
  18. {
  19. "payment_id": 2,
  20. "name": "货到付款",
  21. "code": 1,
  22. "image": "",
  23. "is_deposit": 0,
  24. "is_inpour": 0,
  25. "is_payment": 1,
  26. "is_refund": 0,
  27. "model": "cod",
  28. "sort": 50,
  29. "status": 1
  30. },
  31. {
  32. "payment_id": 3,
  33. "name": "支付宝",
  34. "code": 2,
  35. "image": "//image.jpg",
  36. "is_deposit": 1,
  37. "is_inpour": 1,
  38. "is_payment": 1,
  39. "is_refund": 1,
  40. "model": "alipay",
  41. "sort": 50,
  42. "status": 1
  43. },
  44. {
  45. "payment_id": 4,
  46. "name": "微信支付",
  47. "code": 3,
  48. "image": "",
  49. "is_deposit": 1,
  50. "is_inpour": 1,
  51. "is_payment": 1,
  52. "is_refund": 1,
  53. "model": "weixin",
  54. "sort": 50,
  55. "status": 1
  56. },
  57. {
  58. "payment_id": 5,
  59. "name": "银行转账",
  60. "code": 4,
  61. "image": "",
  62. "is_deposit": 1,
  63. "is_inpour": 0,
  64. "is_payment": 0,
  65. "is_refund": 0,
  66. "model": "",
  67. "sort": 50,
  68. "status": 1
  69. },
  70. {
  71. "payment_id": 6,
  72. "name": "购物卡",
  73. "code": 5,
  74. "image": "",
  75. "is_deposit": 0,
  76. "is_inpour": 0,
  77. "is_payment": 0,
  78. "is_refund": 0,
  79. "model": "",
  80. "sort": 50,
  81. "status": 1
  82. },
  83. {
  84. "payment_id": 7,
  85. "name": "其他",
  86. "code": 6,
  87. "image": "",
  88. "is_deposit": 1,
  89. "is_inpour": 0,
  90. "is_payment": 0,
  91. "is_refund": 0,
  92. "model": "",
  93. "sort": 50,
  94. "status": 1
  95. }
  96. ]
  97. }

is_select=1 响应参数:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": [
  5. {
  6. "name": "账户资金",
  7. "code": 0,
  8. "image": ""
  9. },
  10. {
  11. "name": "货到付款",
  12. "code": 1,
  13. "image": ""
  14. },
  15. {
  16. "name": "支付宝",
  17. "code": 2,
  18. "image": "//image.jpg"
  19. },
  20. {
  21. "name": "微信支付",
  22. "code": 3,
  23. "image": ""
  24. },
  25. {
  26. "name": "银行转账",
  27. "code": 4,
  28. "image": ""
  29. },
  30. {
  31. "name": "购物卡",
  32. "code": 5,
  33. "image": ""
  34. },
  35. {
  36. "name": "其他",
  37. "code": 6,
  38. "image": ""
  39. }
  40. ]
  41. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-06-04 11:17