description:whether only domestic cards can pay. due to there is huge difference on surcharge rate between domestic cards and international cards. merchants can add a limit on the order.
description:|
Whether only domestic cards can pay. due to there is huge difference on surcharge rate between domestic cards and international cards.
Merchants can add a limit on the order.
**Note:If merchant enabled auto attach surcharge on orders, and international_only is false, this parameter will automatically set to true**
international_only:
type:boolean
default:false
description:|
If set this parameter to true, this order will refuse domestic cards. It is useful when merchant enabled auto attach surcharge to orders.
Then is required to set this value as true to enable international cards. This also means customers should choose use domestic cards or international cards first on merchants' page
And if domestic_only param is true, this param will be ignored.
Retail Passive Payment is used for cashier terminals which can scan BarCode or QRCode. Shop staff input the payment amount and ask customers for their payment code,
then system send price and payment code to server and finish the payment. Retail Passive Payment now support both Alipay and WeChat
<img src="img/Retail_cn.png">
tags:
- RetailPay
@ -715,10 +732,10 @@ paths:
properties:
device_id:
type:string
description:扫码设备id
description:ID of the device which sends the request
auth_code:
type:string
description:付款码
description:The Payment QR Code scanned from customer's WeChat Wallet.
Use for Alipay Payment in PC Website. After create order, jump to the pay_url returned and attach sign params and redirect param. Then enter Alipay page to finish payment.
Used for mobile Apps calling Wechat payment with Wechat SDK. Call this api to create order and get param string for SDK calling.
Call SDK api with the param to start payment and get payment result from Wechat app It is strongly advised to request RoyalPay order query Api to confirm that the order has been paid in order to cancelling order by system at the same time.
tags:
- SDK Payment
parameters:
@ -877,23 +900,23 @@ paths:
properties:
channel:
type:string
description:支付渠道，大小写敏感
description:Payment channel, required, case sensitive
enum:
- Wechat
- Alipay
system:
type:string
description:客户端操作类型，支付宝选填，微信不需要
description:OS type of client app, optional for Alipay, not required for Wechat
enum:
- android
- iphone
- ipad
version:
type:string
description:客户端版本号，支付宝选填，微信不需要
description:client app version, optional for Alipay, not required for Wechat
appid:
type:string
description:微信必填，开发者平台appid
description:wechat appid, required for Wechat, not required for Alipay
One payment order can create more than one refund orders. Total amount of all refund orders must be less than or equal to the actual paid amount and the currency of refund order is the same as the payment order.
tags:
- QRCode
- JSAPI
@ -967,11 +993,11 @@ paths:
- name:partner_order_id
in:path
required:true
description:需要退款订单的单号
description:Payment order id in merchant's system
- name:partner_refund_id
in:path
required:true
description:退款单号
description:Refund id in merchant's system
requestBody:
content:
application/json:
@ -982,10 +1008,10 @@ paths:
properties:
fee:
type:integer
description:退款金额，单位是货币最小单位，单个订单退款单金额总和不能超过用户支付金额
description:退Refund amount. Use base unit of the currency. Total amount of all refund orders must be less than actual paid amount.
device_id:
type:string
description:操作设备id
description:ID of the device which sends the request
This Api will list all transactions for current merchant in the day, containing all payment methods(include no gateway methods) and all payment channels such as payment,
RoyalPay discount cashback, refunds, credit for failure refunds, system pay back,
cashback account income/outcome, etc. Settlement transactions will not be contained.
**Note:A payment order or refund order can contains several transaction records**
tags:
- PublicApi
parameters:
@ -1043,7 +1072,7 @@ paths:
type:string
in:query
required:true
description:账单日期，'yyyyMMdd'格式，GMT+10，只能查今天以前的账单
description:Transaction date. Format as 'yyyyMMdd', GMT+10. Only transaction before today can be query
example:20200315
responses:
200:
@ -1065,13 +1094,13 @@ paths:
SUCCESS
transaction_count:
type:integer
description:流水条数
description:transactions number
order_count:
type:integer
description:付款条数
description:credit number
refund_count:
type:integer
description:退款条数
description:debit number
transactions:
type:array
items:
@ -1086,10 +1115,13 @@ paths:
description:target settlement date, maybe delay due to holidays and bank issues(yyyy-MM-dd)
If notify_url is provided when order is created. System will post request to this url when the payment succeeds.
Request method is POST. Different from Server APIs, sign parameters will be included in json entity.
Partner system shall valid them to prevent fake requests. Partner system shall response with correct parameters.
If RoyalPay did not receive valid response, system will regard as receiving failed and retry the notification.
System will retry up to3 times. Partner system shall be able to handle the repeated requests.
**Itis recommended to actively call the query API to confirm the payment status after receiving the push, so as to prevent other third parties from forging the push!**
tags:
- SDK Payment
- CB Bank
@ -1188,53 +1222,53 @@ paths:
time:
type:integer
format:int64
description:UTC时间戳
description:UTC timestamp in millis
nonce_str:
type:string
description:随机字符串
description:Random string
sign:
type:string
description:签名
description:Sign
partner_order_id:
type:string
description:商户单号
description:Partner order id
channel_order_id:
type:string
description:渠道方交易单号
description:PayChannel(Alipay、Wechat) Transaction Trade No
order_id:
type:string
description:RoyalPay订单号
description:RoyalPay order id
total_fee:
type:integer
description:订单金额，单位是最小货币单位
description:Order amount
real_fee:
type:integer
description:支付金额，单位是最小货币单位
description:Actual paid amount
rate:
type:number
description:交易时使用的汇率，1AUD=?CNY
description:Exchange Rate used while trading. 1AUD=?CNY
yixian
4 years ago