支付方式接口
按门店维度查询支付方式字典。返回字段 payMethod / payMethodName 与销售单据接口 ticket/increment-page(传 needTicketPayments = true)中的支付明细字段口径完全一致,可直接互相参照。
查询全部支付方式
POST/openapi/v3/pay-method/all返回全部可用支付方式:内置支付方式全集(数据字典 payMethod)+ 该门店的自定义支付方式。适合对接方做支付方式编码对照表。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
account | string | 是 | 目标门店账号。传哪个账号,就返回哪个门店的自定义支付方式(内置部分各门店一致)。 |
业务说明
- 固定消耗
100 token。 - 无分页,一次性返回全量。
- 内置方式各门店一致;自定义方式(
custompaymethod,启用状态)按门店返回。
请求示例
{
"account": "store001"
}
返回示例
{
"status": "success",
"errorCode": 0,
"result": [
{ "payMethod": 1, "payMethodName": "现金支付", "name": "现金" },
{ "payMethod": 2, "payMethodName": "储值卡支付", "name": "储值卡" },
{ "payMethod": 3, "payMethodName": "银联支付", "name": "银联" },
{ "payMethod": 7, "payMethodName": "储值卡支付", "name": "网店会员储值" }
]
}
同名消歧:不同编码的支付方式可能展示名相同(如上例 2 与 7 都叫"储值卡支付"),请以 payMethod 编码为准做匹配,需要展示区分时使用 name(内部名称)。
查询门店已启用支付方式
POST/openapi/v3/pay-method/my返回该门店在收银端实际启用的支付方式。适合只关心"这张单据可能出现的支付方式"的对接方。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
account | string | 是 | 目标门店账号。 |
业务说明
- 固定消耗
100 token。 - 现金支付(
1)、储值卡支付(2)、银联支付(3)对所有门店恒可用,必定返回。 - 其余内置方式按门店支付开关(收银端"支付方式管理"中的启用状态)过滤。
- 门店自定义支付方式只要处于启用状态即返回,不受开关影响。
请求示例
{
"account": "store001"
}
返回示例
{
"status": "success",
"errorCode": 0,
"result": [
{ "payMethod": 1, "payMethodName": "现金支付", "name": "现金" },
{ "payMethod": 2, "payMethodName": "储值卡支付", "name": "储值卡" },
{ "payMethod": 3, "payMethodName": "银联支付", "name": "银联" }
]
}
返回字段说明
status、errorCode 请参考《公共响应格式》,此处仅补充 result[] 字段。
| 字段 | 类型 | 说明 |
|---|---|---|
payMethod | int | 支付方式编码。 |
payMethodName | string | 展示名称,与收银端展示一致;不同编码可能同名。 |
name | string | 内部名称,用于区分 payMethodName 相同的条目。 |