v1

latestOpenAPI 3.1.02026-07-26850209.3 KB

订阅申请

创建订阅订单

post/subscription/apply

Request body

appIdinteger required

业务ID(后台获取,需要根据参数currency传递对应的业务ID)

subscriptionOrderIdstring required

商户订单号(必须保证唯一性,长度不超过48)

amountstring required

交易金额(精确到小数点后两位;禁止添加标点符号,例如:",")

namestring

用户姓名,推荐使用真实姓名,格式:包含firstName和lastName,以空格分割的,示例:John Doe

phonestring required

真实手机号(格式参考电话号码格式)

emailstring email

真实电子邮件

subjectstring required

订阅标题

bodystring

备注详情

inBankCode'CREDIT_CARD' | 'GOOGLE_PAY' | 'APPLE_PAY' required

支付方式编码,与 paymentMethods 二选一

payType'SUBSCRIPTION' required

支付方式类型

callBackUrlstring uri required

用户支付成功后跳转地址

notifyUrlstring uri required

异步通知地址

countrystring required

国家

currency'USD' required

币种,目前支持:USD

partnerUserIdstring required

用户唯一标识(如用户ID userId),用于风控系统,必须真实有效,否则会影响交易。格式要求:数字、大小写字母或常用符号-~!@#$%&*()_。

recurringInterval'D' | 'W' | 'M' | 'Y' required

循环周期类型 D(天),W(周),M(月),Y(年)

recurringIntervalCountinteger required

循环周期间隔

recurringMaxNumberinteger required

最大循环次数,无论循环周期是哪个,最长时间不能超过三年,到期订阅自动取消

websitestring uri required

交易网站

retryTimesinteger required

定期扣款失败重试次数,默认为3

cancelUrlstring uri

用户取消支付URL,如果传递,用户可在支付页面点击返回到此页面

couponPeriodinteger

优惠期数(暂时只支持首期优惠与全期优惠,即couponPeriod只能等于1或者等于recurringMaxNumber)

couponAmountPerPeriodstring

每期优惠金额

signstring required

签名

paymentMethodsstring

支持的支付方式列表,英文逗号分隔,如 CREDIT_CARD,GOOGLE_PAY,APPLE_PAY,与 inBankCode 二选一,暂时仅支持前置组件组合模式使用

Response

statusstring

状态码

errorstring

错误码

msgstring

返回信息