​
接入API

POST /api/v2/checkout

​
请求

​
请求参数

名称类型是否必须描述
pidinteger(int64)是Cregis中该收单项目的唯一编号
noncestring是6位随机字符串
timestampinteger(int64)是时间戳
signstring是签名
order_idstring是调⽤⽅唯⼀订单编号【不超过128位字符】
order_amountstring是付款总额【精度可以参考法币信息列表接⼝decimals字段值】
order_currencystring是订单货币代码，即ISO 4217货币代码,例如 CNY、HKD，参考法币信息列表接⼝
order_detailsJSONString否订单详情，订单内的商品，单价及购买数量将可显示在收银台页面的订单详情部分，方便用户在支付过程中确认订单内容
sub_merchantJSONString否商户可使用此字段来记录内部子商户的编号
payer_idstring是付款⼈id标识【不超过32位字符】
payer_namestring否付款⼈姓名【不超过32位字符】
payer_emailstring否付款⼈邮箱
tokensArrayString否通过在tokens字段中输入相应的token_name来控制您允许客户支付的代币
如果此字段留空，则表示您接受Cregis支持的所有代币作为客户的支付代币。可以通过 查询支持加密货币获得Cregis支付引擎中所有支持的代币
示例: [“USDT-TRC20”,“USDT-BEP20”]
stablecoin_realtime_ratestring否默认值：false
false：代表 USDT/USDC 兑 USD 使用固定1:1的汇率
true：代表 USDT/USDC兑USD 使用从CoinMarketCap上获取的实时汇率
callback_urlstring否回调通知地址：Cregis 会向此地址发送付款状态更新的 webhook 通知,回调详情参考 订单支付通知
remarkstring否商户可对这笔支付订单做出备注【不超过256位字符】
valid_timeinteger否设置订单超时时间【单位/分钟】，区间【10-60】，如果未填写，系统默认设置为30分钟；
success_urlstring是付款成功后，点击“返回商店”按钮，付款人将被重定向到此 URL。请确保 URL 中包含“http://”或“https://”
cancel_urlstring是未付款并点击“取消”按钮，则重定向 URL。请确保 URL 中包含“http://”或“https://”

order_details object

名称类型是否必须描述
shopping_costdecimal否运费
tax_costdecimal否消费税
itemsJSONArrayString否商品信息列表

​items object

名称类型是否必须描述
item_idstring否商品ID
item_namestring否商品名称
item_pricedecimal否商品价格
price_currencystring否商品价格货币代码【列如：HKD】
item_quantityinteger(int64)否商品数量

sub_merchant object

名称类型是否必须描述
sub_merchant_idstring否商户ID
sub_merchant_namestring否商户名称
请求示例
{
    "timestamp": 1734327655,
    "nonce": "dositl",
    "sign": "f5be13fdd8c6f63951ca4427359457cb",
    "order_id": "merchant_order_id_12334567",
    "order_amount": "5",
    "order_currency": "USD",
    "callback_url": "https://callback.com",
    "remark": "VIP order",
    "payer_id": "payer001",
    "payer_name": "payer",
    "payer_email": "[email protected]",
    "valid_time": 60,
    "pid": 1419287201923072,
    "cancel_url": "https://cancel.merchant.com",
    "success_url": "https://success.merchant.com",
    "tokens": "[\"USDT-TRC20\",\"USDT-BEP20\"]",
    "order_details": "{\"items\": [{\"item_id\": \"10001\", \"item_name\": \"Product1\",\"item_price\": 123.00,\"item_quantity\": 1,\"price_currency\": \"USD\"},{\"item_id\": \"10002\", \"item_name\": \"Product2\",\"item_price\": 100.00,\"item_quantity\": 2,\"price_currency\": \"USD\"}],\"shopping_cost\": 10.88,\"tax_cost\": 10.00}"
    "sub_merchant": "{\"sub_merchant_id\": \"submerchant10001\",\"sub_merchant_name\": \"Merchant1\"}"
}

​
返回

​
返回数据

名称类型描述
codestring返回码
msgstring返回信息
dataArray返回数据

​
返回数据 data 数组对象

名称类型描述
cregis_idstringCregis唯⼀识标
checkout_urlstring收银台链接
merchant_namestring收银台展示的商户名称
merchant_logo_urlstring收银台展示的商户logo
order_amountstring订单交易⾦额【精度可以参考法币信息列表接⼝decimals字段值】
order_currencystring订单货币代码，即ISO 4217货币代码,例如CNY、HKD，参考法币信息列表接⼝
created_timeinteger(int64)订单创建时间【13位时间戳】
expire_timeinteger(int64)订单到期时间【13位时间戳】
payment_infoarray订单相关讯息

​
payment_info 对象

名称类型描述
payment_addressstring充值地址
token_symbolstring货币标识
blockchainstring货币⽹络
token_namestring货币名称
logo_urlstring货币logo地址
token_decimalsinteger货币精度
receive_amountstring汇率转换后的订单⾦额
receive_currencystring汇率转换后订单货币代码
exchange_ratestring货币汇率
asset_logostring资产logo
返回示例
{
    "code": "00000",
    "msg": "ok",
    "data": {
        "cregis_id": "po1420761885130752",
        "checkout_url": "http://192.168.2.60:9099?cid=b2fb433c953a43bd9bdfc3f611567887",
        "merchant_name": null,
        "merchant_logo_url": null,
        "order_amount": "5",
        "order_currency": "HKD",
        "created_time": 1734328473070,
        "expire_time": 1734332073070,
        "payment_info": [
            {
                "payment_address": "TX8GZJfLYPtmzRgd3FoiXuCHbptiQ37NSM",
                "token_symbol": "USDT",
                "blockchain": "TRON",
                "token_name": "USDT-TRC20",
                "logo_url": "https://static.cregis.io/pic/coin/[email protected]",
                "token_decimals": 6,
                "receive_amount": "0.642951",
                "receive_currency": "USDT",
                "exchange_rate": "0.1285902181",
                "asset_logo": "https://static.cregis.io/pic/coin/tether%[email protected]"
            },
            {
                "payment_address": "0xf9d70ab23195cfc9c0c14b384a1fd3a3f12cd4f8",
                "token_symbol": "USDT",
                "blockchain": "BNB-BSC",
                "token_name": "USDT-BEP20",
                "logo_url": "https://static.cregis.io/pic/coin/USDT-BNB%[email protected]",
                "token_decimals": 18,
                "receive_amount": "0.642951",
                "receive_currency": "USDT",
                "exchange_rate": "0.1285902181",
                "asset_logo": "https://static.cregis.io/pic/coin/tether%[email protected]"
            },
        ]
    }
}