Skip to content

创建在线收款单 ​

能力概览 ​

  • 接入方在线 Payin 创建服务

调用地址 ​

  • /pay/merchant/createOrder

请求参数 ​

  • body
字段提交要求数据类型长度限制业务含义
merchantId是String32平台分配给接入方的唯一商户标识
merOrderId是String64接入方系统生成的收款订单号,需保证在接入方侧唯一
subMerId否String32二级商户标识;存在二级接入方场景时传入
orderType是String32收款交易类型,固定传入 online_payin
paymentType否String100指定可用支付方式;可不传,支持多个值并使用英文逗号分隔。
取值见支付方式清单
orderAmt是String12收款订单金额,按两位小数格式提交,如:100.00
orderCurrency是String10收款订单币种代码,例如:SAR
expireTime是String4收款订单有效时长,单位为 min,默认 30min
serverNotifyUrl否String255支付结果服务端通知地址;传入时平台按该 URL 推送,未传入时使用后台配置地址
frontRedirectUrl是String255支付完成后前端页面跳转的目标地址
productInfo是List<Object>收款订单关联的商品明细列表,元素结构见 Object:productInfo
customerInfo是Object支付用户资料对象,结构见 Object:customerInfo
deliveryInfo条件Object物流配送资料对象;当 productInfo.productType=physical 时必须提交
orderDesc否String128收款订单的业务说明
cashierIsSdk否String2收银台接入模式,未传入时默认为 0
0:统一收银台
1:SDK 方式
  • Object:productInfo
字段提交要求数据类型长度限制业务含义
productType是String32商品形态分类
virtual:虚拟商品
physical:实体商品
productName是String128商品展示名称
productSku否String100接入方商品 SKU 或商品编码
productQuantity是String5本笔订单中的商品购买数量
productUnitPrice是String12商品单价,按两位小数提交,如:1.00
productCurrency是String10商品金额对应的币种代码,如:SAR
productDesc否String128商品补充描述信息
productAvatarUrl是String255商品图片的可访问 URL
  • Object:customerInfo
字段提交要求数据类型长度限制业务含义
customerUid是String40接入方系统内的支付用户唯一标识
customerName是String128支付用户姓名
customerPlatform是String128用户发起购买行为的应用或平台名称
customerPhone条件String18用户手机号;当 productType=physical 时必须提交
customerEmail是String64支付用户邮箱地址
  • Object:deliveryInfo
字段提交要求数据类型长度限制业务含义
firstName是String64收货人名
lastName是String64收货人姓
phone是String18收货人手机号
country是String128收货地址所属国家
city是String128收货地址所属城市
address是String128收货地址的详细街道信息
zipCode是String10收货地址邮政编码

请求示例 ​

json
{
  "merchantId": "MER20460873",
  "merOrderId": "PAYIN202605090001",
  "subMerId": "SME70451236",
  "orderType": "online_payin",
  "paymentType": "cardpay,applepay",
  "orderAmt": "186.40",
  "orderCurrency": "SAR",
  "expireTime": "30",
  "serverNotifyUrl": "https://merchant.example.com/notify/payin",
  "frontRedirectUrl": "https://merchant.example.com/payment/result",
  "productInfo": [
    {
      "productType": "physical",
      "productName": "Wireless Headphones",
      "productSku": "SKU-HP-20260509",
      "productQuantity": "1",
      "productUnitPrice": "186.40",
      "productCurrency": "SAR",
      "productDesc": "Bluetooth audio device",
      "productAvatarUrl": "https://merchant.example.com/assets/products/headphones.png"
    }
  ],
  "customerInfo": {
    "customerUid": "UID20260509001",
    "customerName": "Noura Ahmed",
    "customerPlatform": "SaudiPays Demo Store",
    "customerPhone": "0551234567",
    "customerEmail": "noura.ahmed@example.com"
  },
  "deliveryInfo": {
    "firstName": "Noura",
    "lastName": "Ahmed",
    "phone": "0551234567",
    "country": "Saudi Arabia",
    "city": "Riyadh",
    "address": "Olaya Street Building 18",
    "zipCode": "12213"
  },
  "orderMemo": "PAYIN-MEMO-20260509",
  "cashierIsSdk": "0"
}

响应参数 ​

  • data
字段数据类型业务含义
merchantIdString当前收款订单所属的接入方标识
orderIdString平台生成的收款交易订单号
merOrderIdString接入方提交的收款订单号,按请求原值返回
subMerIdString二级接入方标识
orderTypeString收款交易类型,取值为 online_payin
paymentTypeString本订单可用支付方式,可包含多个值并使用英文逗号分隔。
取值见支付方式清单
paymentUrlString用户完成支付所需访问的收银台跳转链接
orderStatusString收款订单当前处理状态:
init:初始化
pending:处理中
success:成功
fail:失败
expired:已过期

响应示例 ​

json
{
  "code": 10000,
  "message": "success",
  "data": {
    "merchantId": "MER20460873",
    "orderId": "TRD20260509104532001876",
    "merOrderId": "PAYIN202605090001",
    "subMerId": "SME70451236",
    "orderType": "online_payin",
    "paymentType": "cardpay,applepay",
    "paymentUrl": "https://openapi-uat.saudipays.cn/en-US/order/TRD20260509104532001876",
    "orderStatus": "init"
  }
}