获取支付方式接口

提供查询可用支付方式的能力，返回平台支持的各类支付方式的编码及名称，默认情况下无可用支付方式，需单独申请开通。

适用场景

查询当前支持的支付方式

为订单支付页面提供支付方式选择的数据源

接口类型

GET

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/pay/list
测试环境：https://testing.westmonth.com/openapi/pay/list

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	array	支付方式列表数据

data数组字段

字段	类型	说明
value	integer	支付类型编码，用于标识不同的支付方式
name	string	支付类型名称，展示给用户的支付方式名称

调用示例

URL请求

请求示例

成功返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "value": 1,
      "name": "微信支付"
    },
    {
      "value": 2,
      "name": "支付宝"
    },
    {
      "value": 3,
      "name": "额度支付"
    },
    {
      "value": 6,
      "name": "万里汇"
    },
    {
      "value": 7,
      "name": "预付款"
    },
    {
      "value": 8,
      "name": "组合支付支付宝"
    },
    {
      "value": 9,
      "name": "组合支付万里汇"
    }
  ]
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

常见问题

Q1：为什么返回的支付方式列表为空？

A：默认情况下系统没有启用任何支付方式，需要单独向平台申请开通支付方式后才能获取到数据。

Q2：支付方式的value（编码）是否会发生变化？

A：支付方式的编码（value）是固定的，一旦确定不会变更，可放心用于业务逻辑中标识支付方式。

版本历史

版本	日期	修改说明
v1.0	2025-01-01	初始版本

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": [
        {
            "value": 1,
            "name": "微信支付"
        },
        {
            "value": 2,
            "name": "支付宝"
        },
        {
            "value": 3,
            "name": "额度支付"
        },
        {
            "value": 6,
            "name": "万里汇"
        },
        {
            "value": 7,
            "name": "预付款"
        },
        {
            "value": 8,
            "name": "组合支付支付宝"
        },
        {
            "value": 9,
            "name": "组合支付万里汇"
        }
    ]
}

获取支付方式

获取支付方式接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：为什么返回的支付方式列表为空？#

Q2：支付方式的value（编码）是否会发生变化？#

版本历史#

请求参数

请求示例代码

返回响应

获取支付方式接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：为什么返回的支付方式列表为空？

Q2：支付方式的value（编码）是否会发生变化？

版本历史