创建经常付款

加密货币的反复付款是一种使用数字资产自动进行定期交易的方式。它们可用于基于订阅的服务，捐赠，会员资格和其他经常性付款。

要使用经常付款，您需要创建一个指定付款金额，货币和频率的付款，然后与您的付款人共享。付款人将被重定向到Cryptomus网站，在那里他需要登录以确认付款计划并首次付款。之后，将根据计划自动进行付款。

post

https://api.cryptomus.com/v1/recurrence/create

复制

要求

查询参数

姓名	参数类型	默认值	定义
amount*	string		经常付款金额
currency*	string		货币代码
name*	stringmin:3max:60		经常出现的付款名称
period*	string		经常付款期可用的：weeklymonthlythree_month
to_currency			接受付款的货币代码该参数用于指定用于转换复发付款金额的目标货币。例如，在比特币中创建20美元的经常付款： amount：20 currency：usd to_currency ：btcAPI将根据当前汇率将20美元的金额转换为BTC中的同等金额，用户将在BTC中付款 to_currency 应始终是加密货币代码，而不是法定货币代码。
order_id	stringmin:1max:100	null	在您的系统中订购ID
url_callback	url	null	将发送具有付款状态的Webhooks的URL
discount_days	integermin:1max:365	0	折扣日（需要'discount_amount'）
discount_amount	string	null	折扣金额（'discount_days'需要）。在这里，参数“货币”的货币金额
additional_data	string	null	其他重复的付款详细信息

参数类型

string

定义

经常付款金额

参数类型

string

定义

货币代码

参数类型

stringmin:3max:60

定义

经常出现的付款名称

参数类型

string

定义

经常付款期可用的：weeklymonthlythree_month

定义

接受付款的货币代码该参数用于指定用于转换复发付款金额的目标货币。例如，在比特币中创建20美元的经常付款：
amount：20
currency：usd
to_currency ：btcAPI将根据当前汇率将20美元的金额转换为BTC中的同等金额，用户将在BTC中付款 to_currency 应始终是加密货币代码，而不是法定货币代码。

参数类型

stringmin:1max:100

定义

在您的系统中订购ID

参数类型

url

定义

将发送具有付款状态的Webhooks的URL

参数类型

integermin:1max:365

定义

折扣日（需要'discount_amount'）

参数类型

string

定义

折扣金额（'discount_days'需要）。在这里，参数“货币”的货币金额

参数类型

string

定义

其他重复的付款详细信息

* - 强制性参数

折扣：

几天中的第一个阶段（ discount_days 参数），它将花费不同的金额（ discount_amount 参数）。例如，您可以在最初的30天和每月期间设置 discount_amount ，然后用户将以较低的价格支付第一笔付款，第二次和随后的付款将全价格为全价。

折扣金额必须按照“货币”参数指定的货币。

请求示例

以下是一个示例示例，在这种情况下，将使用Fiat Currency USD创建发票。在付款页面上，用户将能够选择加密货币和网络来支付此账单。


curl https://api.cryptomus.com/v1/recurrence/create \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
	"amount": "15",
	"currency": "USDT",
	"name": "Recurring payment",
	"period": "monthly"
}'

复制

响应参数

姓名	定义
uuid	反复出现的uuid
name	重复名称
order_id	在您的系统中订购ID
amount	经常性量
currency	货币代码
payer_currency	客户必须付款的货币。
payer_amount_usd	客户必须付款
payer_amount	客户必须付款
url_callback	将发送具有付款状态的Webhooks的URL
period	经常付款期
status	重复状态可用选项：• wait_accept• cancel_by_merchant• active• cancel_by_user
url	加密付款页面的URL，付款人将在其中付款
last_pay_off	最后付款的日期。时区为UTC+3。如果该价值为无效，则无需付款。
additional_data	其他重复的付款详细信息

: 定义
反复出现的uuid
: 定义
重复名称
: 定义
在您的系统中订购ID
: 定义
经常性量
: 定义
货币代码
: 定义
客户必须付款的货币。
: 定义
客户必须付款
: 定义
客户必须付款
: 定义
将发送具有付款状态的Webhooks的URL
: 定义
经常付款期
: 定义
重复状态可用选项：- wait_accept- cancel_by_merchant- active- cancel_by_user
: 定义
加密付款页面的URL，付款人将在其中付款
: 定义
最后付款的日期。时区为UTC+3。如果该价值为无效，则无需付款。
: 定义
其他重复的付款详细信息

响应示例

如果请求成功。响应代码为200。


1{
2	"state": 0,
3	"result": {
4		"uuid": "afd050e8-35ea-4129-bbdd-73f510dce556",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USDT",
9		"payer_currency": "USDT",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "15.00000000",
12		"url_callback": null,
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/afd050e8-35ea-4129-bbdd-73f510dce556",
16		"last_pay_off": null
17	}
18}

复制

更多例子

请求数据示例以创建15美元的重复付款


1{
2	"amount": "15",
3	"currency": "USD",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"url_callback": "https://your.site/callback"
7}

复制

响应示例:


1{
2	"state": 0,
3	"result": {
4		"uuid": "1d4c1ef7-1dcd-4f98-9433-2e19d2e62820",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": null,
10		"payer_amount_usd": "0.00",
11		"payer_amount": null,
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/1d4c1ef7-1dcd-4f98-9433-2e19d2e62820",
16		"last_pay_off": null
17	}
18}

复制

请求数据示例以创建15美元的重复付款（仅允许USDT付款）


1{
2	"amount": "15",
3	"currency": "USDT",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"url_callback": "https://your.site/callback"
7}

复制

响应示例:


1{
2	"state": 0,
3	"result": {
4		"uuid": "ec04dc64-fea4-445a-9698-59baa474317a",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USDT",
9		"payer_currency": "USDT",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "15.00000000",
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/ec04dc64-fea4-445a-9698-59baa474317a",
16		"last_pay_off": null
17	}
18}

复制

请求数据示例，以创建15美元的复发付款，仅允许BTC货币付款


1{
2	"amount": "15",
3	"currency": "USD",
4	"to_currency": "BTC",
5	"name": "Recurring payment",
6	"period": "monthly",
7	"url_callback": "https://your.site/callback"
8}

复制

响应示例:


1{
2	"state": 0,
3	"result": {
4		"uuid": "e7d9c265-3849-4ff8-84c1-15435368f05f",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": "BTC",
10		"payer_amount_usd": "15.00",
11		"payer_amount": "0.00051495",
12		"url_callback": "https://your.site/callback",
13		"period": "monthly",
14		"status": "wait_accept",
15		"url": "https://pay.cryptomus.com/recurring/e7d9c265-3849-4ff8-84c1-15435368f05f",
16		"last_pay_off": null
17	}
18}

复制

请求数据示例，以15美元的价格创建重复付款。最初30天的价格为$ 1，此后-15美元：


1{
2	"amount": "15",
3	"currency": "USD",
4	"name": "Recurring payment",
5	"period": "monthly",
6	"discount_days": 30,
7  "discount_amount": "1"
8	"url_callback": "https://your.site/callback"
9}

复制

响应示例:


1{
2	"state": 0,
3	"result": {
4		"uuid": "1ee00fbd-42e7-4653-b316-1ab12f8a447b",
5		"name": "Recurring payment",
6		"order_id": null,
7		"amount": "15",
8		"currency": "USD",
9		"payer_currency": null,
10		"payer_amount_usd": "0.00",
11		"payer_amount": null,
12		"url_callback": "https://your.site/callback",
13		"discount_days": "30",
14                "discount_amount": "1",
15		"end_of_discount": "2023-07-11T20:23:52+03:00",
16		"period": "monthly",
17		"status": "wait_accept",
18		"url": "https://pay.cryptomus.com/recurring/1ee00fbd-42e7-4653-b316-1ab12f8a447b",
19		"last_pay_off": null
20	}
21}

复制

创建经常付款

要求

查询参数

折扣：

请求示例

回复

响应参数

响应示例

更多例子