PayCloud SaaS

预下单模式-交易预下单

开发中

POST

/api/cashier/entry

cashier2

最后修改时间：2024-06-05 01:27:49

责任人：王煜翔

交易预下单，终端交易前，先调用该接口预下单，需将返回的trans_no和本地交易进行关联，用于后续交易状态上送和更新

请求参数

Header 参数

app_version

string

可选

cashier版本号

示例值:

2122060266

Body 参数application/json

method

string

方法

必需

固定值：cashier.terminal.trans.preorder

app_id

string

应用号

必需

version

string

版本号

必需

固定值：2.0

terminal_sn

string

设备编号

必需

timestamp

integer

时间戳

必需

sign

string

签名

必需

通过商户私钥签名，平台通过公钥验证签名签名方式见：https://gw.paycloud.world/docs/#/sign

trans_type

string

交易类型

必需

1：消费；2：消费撤销；3：退货；4：预授权；5：预授权撤销；6：预授权完成；7：预授权完成撤销；8：预授权完成退款；11 ：返现交易

pay_method_id

string

支付方式

必需

orig_merchant_order_no

string

原商户订单号

可选

merchant_order_no

string

商户订单号

可选

pay_channel_trans_no

string

通道交易号

可选

batch_no

string

批次号

可选

voucher_no

string

凭证号

可选

ref_no

string

参考号

可选

auth_no

string

授权码

可选

sys_no

string

系统跟踪号

可选

price_currency

string

标价币种

必需

order_amount

integer

订单金额

必需

cashback_amount

integer

返现金额

可选

service_charge_amount

integer

服务费金额

可选

sales_tax_amount

integer

税费金额

可选

tip_amount

integer

小费金额

可选

paid_amount

integer

顾客实付金额

可选

pay_user_account_id

string

用户支付卡号

可选

card_brand

string

卡品牌

可选

UnionPay、Visa、MasterCard、Amex、Discover、JCB、DinnersClub

card_type

string

卡类型

可选

card_issuers_no

string

发卡行机构号

可选

timezone

string

时区

可选

longitude

string

经度

可选

latitude

string

纬度

可选

term_ip

string

终端IP

可选

cashier

string

收银员编号

可选

description

string

交易描述

可选

attach

string

附件

可选

env_params

string

环境信息

可选

bankcard_ext_params

string

银行卡交易扩展参数

可选

notify_url

string

通知地址

可选

示例

{
    "method": "string",
    "app_id": "string",
    "version": "string",
    "terminal_sn": "string",
    "timestamp": 0,
    "sign": "string",
    "trans_type": "string",
    "pay_method_id": "string",
    "orig_merchant_order_no": "string",
    "merchant_order_no": "string",
    "pay_channel_trans_no": "string",
    "batch_no": "string",
    "voucher_no": "string",
    "ref_no": "string",
    "auth_no": "string",
    "sys_no": "string",
    "price_currency": "string",
    "order_amount": 0,
    "cashback_amount": 0,
    "service_charge_amount": 0,
    "sales_tax_amount": 0,
    "tip_amount": 0,
    "paid_amount": 0,
    "pay_user_account_id": "string",
    "card_brand": "string",
    "card_type": "string",
    "card_issuers_no": "string",
    "timezone": "string",
    "longitude": "string",
    "latitude": "string",
    "term_ip": "string",
    "cashier": "string",
    "description": "string",
    "attach": "string",
    "env_params": "string",
    "bankcard_ext_params": "string",
    "notify_url": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/cashier/entry' \
--header 'app_version: 2122060266' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method": "string",
    "app_id": "string",
    "version": "string",
    "terminal_sn": "string",
    "timestamp": 0,
    "sign": "string",
    "trans_type": "string",
    "pay_method_id": "string",
    "orig_merchant_order_no": "string",
    "merchant_order_no": "string",
    "pay_channel_trans_no": "string",
    "batch_no": "string",
    "voucher_no": "string",
    "ref_no": "string",
    "auth_no": "string",
    "sys_no": "string",
    "price_currency": "string",
    "order_amount": 0,
    "cashback_amount": 0,
    "service_charge_amount": 0,
    "sales_tax_amount": 0,
    "tip_amount": 0,
    "paid_amount": 0,
    "pay_user_account_id": "string",
    "card_brand": "string",
    "card_type": "string",
    "card_issuers_no": "string",
    "timezone": "string",
    "longitude": "string",
    "latitude": "string",
    "term_ip": "string",
    "cashier": "string",
    "description": "string",
    "attach": "string",
    "env_params": "string",
    "bankcard_ext_params": "string",
    "notify_url": "string"
}'

返回响应

🟢200成功

application/json

Body

msg

string

必需

code

string

必需

data

object

必需

trans_no

string

交易号

必需

psn

string

必需

示例

{
    "msg": "string",
    "code": "string",
    "data": {
        "trans_no": "string"
    },
    "psn": "string"
}

🔴500失败

非预下单模式-交易上传

预下单模式-交易完成