跳转到主要内容
POST
/
subscription
/
apply
订阅申请
curl --request POST \
  --url https://uat-interface.haipay.asia/subscription/apply \
  --header 'Content-Type: application/json' \
  --data '
{
  "country": "USA",
  "referer": "https://test.com",
  "amount": "0.5",
  "callBackUrl": "https://www.google.com",
  "inBankCode": "CREDIT_CARD",
  "subject": "Test subscription",
  "subscriptionOrderId": "1736739758574",
  "recurringIntervalCount": 1,
  "sign": "JeJR4N40eKncoohebUN31aNqPqpBxR799rmMutqrSmMaBn0Sjmqbskl4Wiitmatvvx6tqvuwkOYtk6ryrYj7YqJxDeNfDqthWzOxv2ixkKY0YDoWEAra9sWc4CnXBBssP0VIKg0jSTMNzdvmvuNBa7sLEQj5YjgswUnCGtYCmsz154JHSSRpdeYDLL+Nt5b96pzQn8WyRr6b/9SSCrLCWSdt22gJmY5sQh7cc9OcJfAGb5E1XflTq5Va78cV+fw9hHhaZmFzKncg4wxrdaatxg9tCElMJpL1OuWO7XLfcfqgA/8Y/qRCWmNf11Ji3ZSrr7rU4+V7Egrfu1Fcr5DTlw==",
  "partnerUserId": "H20241231",
  "payType": "SUBSCRIPTION",
  "phone": "0845632145871",
  "appId": 1724,
  "name": "howard",
  "notifyUrl": "https://www.google.com",
  "currency": "USD",
  "email": "howard@gmail.com",
  "recurringInterval": "D"
}
'
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "subscriptionNo": "4025011311423010028",
    "subscriptionOrderId": "1736739758574",
    "appId": 1724,
    "subject": "Test subscription",
    "payType": "SUBSCRIPTION",
    "inBankCode": "CREDIT_CARD",
    "amount": 0.5,
    "recurringInterval": "D",
    "recurringIntervalCount": 1,
    "status": "2",
    "sign": "QrOo7yPJMTRk92bP9WU8P0ATdRvCm8dWElhbxqV6qmZEWZDRXeJAwUvd3839zErg+3tN/U4Rwyru219AkXg9CJZtocna3fiYj7uLxwD6bpAp+i9DGz5ZKV9ab5mwIEPWIQXKuY6wATzmlz6W4TvAkRqgGtqLkwYUaeqsmgJrh4WlIMK13GW/zvoCmYfFD6pNZUByVixpll8JPeZG7F9d+x7yjDigJZ2S1wm4F307OzZJkUSKSvQn6Q0lOvp1JS0feXSC+hwCfrdllFXIE10TDV0itoPY5G7+3QdmHpINWp3kWmepR/1pOsN+09hLxe8xKAIZrX2GFHY00xo3QnxBIw=="
  }
}

密钥私钥(生成签名)

请求体

application/json
appId
integer
必填

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

subscriptionOrderId
string
必填

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

Maximum string length: 48
amount
string
必填

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

Pattern: ^\d+\.\d{2}$
name
string
必填

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

phone
string
必填

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

email
string<email>
必填

真实电子邮件

subject
string
必填

订阅标题

inBankCode
enum<string>
必填

支付方式编码

可用选项:
CREDIT_CARD,
GOOGLE_PAY,
APPLE_PAY
payType
enum<string>
必填

支付方式类型

可用选项:
SUBSCRIPTION
callBackUrl
string<uri>
必填

用户支付成功后跳转地址

notifyUrl
string<uri>
必填

异步通知地址

country
string
必填

国家

currency
enum<string>
必填

币种,目前支持:USD

可用选项:
USD
partnerUserId
string
必填

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

Pattern: ^[A-Za-z0-9\-~!@#$%&*()_]+$
recurringInterval
enum<string>
必填

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

可用选项:
D,
W,
M,
Y
recurringIntervalCount
integer
必填

循环周期间隔

必填范围: x >= 1
recurringMaxNumber
integer
必填

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

必填范围: x >= 1
website
string<uri>
必填

交易网站

retryTimes
integer
默认值:3
必填

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

必填范围: x >= 0
sign
string
必填

签名

body
string

备注详情

cancelUrl
string<uri>

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

couponPeriod
integer

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

couponAmountPerPeriod
string

每期优惠金额

Pattern: ^\d+\.\d{2}$

响应

200 - application/json
status
string

状态码

error
string

错误码

msg
string

返回信息

data
object
Last modified on April 10, 2026