应用签到 - PayCloud SaaS

更新记录:

2023-06-13 配置参数新增 posp_channel_index , 用于处理codePay 多通道路由可选项： ELAVON/TSYS/FISERV
2023-07-11 CodePay Register 新增支付配置 charge_method_list 和 trans_type_list
2023-08-02 charge_method_list 新增主被扫
2023-08-07 商户应用配置新增 settle_config、pre_auth_complete_not_present_card
2023-09-13 sales_tax_config 新增 support_for_cash ，tip_config 新增 enable_max_tip、max_tip_rate、 max_tip_amount
2024-01-05 新增cash_discount_config, 新增 enable_esignature、enable_unreferenced_refund 设置
2024-02-22 cash_discount_config新增字段 sales_amount_based
2024-02-23 新增通道沙箱标识
2024-02-29 cash discount 新增优惠的最小交易金额
2023-03-01 新增 receipt_logo 小票logo字段
2023-03-04 settle_config 新增 mode 字段
2024-04-10 新增posp_dek、pc_pek、pc_dek 参数
2024-04-12 新增 state_short_name 州简写 CodePay 使用
2024-06-04 新增debicheck_switch 开关
2024-06-12 CodePay Register 小费配置新增 record_cashier 开关
2024-08-07 新增cashback_config 配置
2024-08-14 更新cashback_config 配置
2024-10-28 新增 enable_income_display 字段，默认false
2024-11-04 新增enable_pinbypass 字段默认false 不开启
2025-01-06 新增enable_cashier_authentication字段，默认false，不开启
2025-05-27 新增pre_auth_cancel_not_present_card 字段，默认false, 不开启

请求参数

Header 参数

app_version

string

可选

cashier版本号

示例值:

2122060266

Body 参数application/json

method

string

方法

必需

固定值：cashier.signin

app_id

string

应用号

必需

version

string

版本号

必需

固定值：2.0

terminal_sn

string

设备编号

必需

timestamp

integer

时间戳

必需

key_mode

enum<string>

密钥模式

必需

枚举值:

SKDUKPT

ksn

string

可选

key_mode=DUPKT 存在

sign

string

可选

key_mode=DUPKT 存在

mac_key_cipher

string

签名KEY加密字符串

可选

key_mode=SK 存在

data_key_cipher

string

数据KEY加密字符串

可选

key_mode=SK 存在

username

string

登陆名

可选

enable_user_signin = true 存在

password

string

密码

可选

enable_user_signin = true 存在 sha256（用户密码）

query_pay_info

boolean

查询支付参数

可选

默认：false

示例

{
    "method": "string",
    "app_id": "string",
    "version": "string",
    "terminal_sn": "string",
    "timestamp": 0,
    "key_mode": "SK",
    "ksn": "string",
    "sign": "string",
    "mac_key_cipher": "string",
    "data_key_cipher": "string",
    "username": "string",
    "password": "string",
    "query_pay_info": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

msg

string

必需

code

string

必需

data

object

必需

basic_info

object

必需

auth_token

string

可选

key_mode = SK 存在

pay_info

array [object {2}]

可选

user_info

object

可选

enable_user_signin = true 存在

psn

string

必需

示例

{
    "msg": "string",
    "code": "string",
    "data": {
        "basic_info": {
            "country": "string",
            "merchant_no": "string",
            "receipt_print_logo": "string",
            "institution_no": "string",
            "city": "string",
            "state_short_name": "string",
            "store_no": "string",
            "timezone": "string",
            "merchant_name": "string",
            "language": "string",
            "store_photos": [
                "string"
            ],
            "institution_name": "string",
            "address_detail": "string",
            "country_no": 0,
            "country_code": "string",
            "app_name": "string",
            "configuration_parameters": {
                "only_3rd_app_use_payment": true,
                "enable_log_upload": true,
                "enable_bill_send": true,
                "enable_esignature": true,
                "enable_unreferenced_refund": true,
                "sales_tax_config": {
                    "enable": true,
                    "name": "string",
                    "charge_mode": 0,
                    "fee_model": 0,
                    "fee_rate": 0,
                    "fee_amount": 0,
                    "description": "string",
                    "support_for_cash": true
                },
                "service_charge_config": {
                    "enable": true,
                    "name": "string",
                    "charge_mode": 0,
                    "fee_model": 0,
                    "fee_rate": 0,
                    "fee_amount": 0,
                    "description": "string"
                },
                "surcharge_config": {
                    "enable": true,
                    "name": "string",
                    "fee_model": 0,
                    "fee_rate": 0,
                    "fee_amount": 0,
                    "description": "string"
                },
                "cash_discount_config": {
                    "enable": true,
                    "sales_amount_based": 0,
                    "name": "string",
                    "fee_model": 0,
                    "fee_rate": 0,
                    "fee_amount": 0,
                    "description": "string",
                    "minimum_amount": 0
                },
                "tip_config": {
                    "enable": true,
                    "name": "string",
                    "charge_type": 0,
                    "fee_model": 0,
                    "rate_list": [
                        0
                    ],
                    "fee_amount_list": [
                        0
                    ],
                    "description": "string",
                    "enable_max_tip": true,
                    "max_tip_rate": 0,
                    "max_tip_amount": 0,
                    "record_cashier": true
                },
                "payment_config": {
                    "charge_method_list": [
                        1
                    ],
                    "trans_type_list": [
                        1
                    ]
                },
                "settle_config": {
                    "enable": true,
                    "time": "string",
                    "mode": 0
                },
                "pre_auth_complete_not_present_card": true,
                "debicheck_switch": true,
                "cashback_config": {
                    "cashback_ratio_rule": {
                        "min": "string",
                        "max": "string"
                    },
                    "limit_amount_rule": {
                        "currency": {
                            "cashback_amount_min": 0,
                            "cashback_amount_max": 0,
                            "purchase_amount_min": 0
                        }
                    }
                },
                "enable_income_display": true,
                "enable_pinbypass": true,
                "enable_cashier_authentication": true
            },
            "country_code2": "string",
            "supported_settlement_currencies": "string",
            "store_name": "string",
            "supported_price_currencies": "string",
            "app_id": "string",
            "terminal_sn": "string",
            "receipt_logo": "string"
        },
        "auth_token": "string",
        "pay_info": [
            {
                "pay_scenario": "string",
                "pay_method_list": [
                    {
                        "icon_url": "string",
                        "pay_channel_id": "string",
                        "pay_channel_name": "string",
                        "sandbox": 0,
                        "is_alipay_plus": "string",
                        "pay_method_id": "string",
                        "supported_price_currencies": "string",
                        "pay_method_configuration": "string",
                        "sort": 0,
                        "support_sub_pay_method_ids": [
                            "string"
                        ],
                        "pay_method_name": "string",
                        "sub_pay_method_ids": [
                            {
                                "icon_url": "string",
                                "pay_method_id": "string",
                                "pay_method_configuration": "string",
                                "pay_method_name": "string"
                            }
                        ],
                        "supported_trans_type": "string",
                        "payment_parameters": {
                            "pc_server_protocol": "http",
                            "pc_server_host": "string",
                            "pc_server_port": "string",
                            "posp_server_protocol": "string",
                            "posp_server_host": "string",
                            "posp_server_port": "string",
                            "posp_channel_index": "string",
                            "pc_merchant_no": "string",
                            "pc_terminal_no": "string",
                            "pc_dek": {
                                "index": "string",
                                "identifier": "string"
                            },
                            "pc_pek": {
                                "index": "string",
                                "identifier": "string"
                            },
                            "posp_dek": {
                                "index": "string",
                                "identifier": "string"
                            }
                        }
                    }
                ]
            }
        ],
        "user_info": {
            "employee_id": "string",
            "role_type": "SHOP_MANAGER",
            "role_name": "string",
            "last_login_time": "string",
            "employee_name": "string",
            "username": "string"
        }
    },
    "psn": "string"
}

🔴500失败