建立定期付款

加密貨幣定期付款是一種使用數位資產自動執行定期交易的方式。它適用於訂閱服務、捐贈、會員資格和其他定期付款。

要使用定期付款，您需要建立付款，指定付款金額、貨幣和頻率，然後將其分享給付款人。付款人將被重定向到 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	發送付款狀態 webhook 的 URL
discount_days	integermin:1max:365	0	折扣期天數（'discount_amount' 必填）
discount_amount	string	null	折扣金額（'discount_days' 必填）。此處金額以參數「currency」的貨幣表示
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
預設值
null
定義
您系統中的訂單 ID
: 參數類型
url
預設值
null
定義
發送付款狀態 webhook 的 URL
: 參數類型
integermin:1max:365
預設值
0
定義
折扣期天數（'discount_amount' 必填）
: 參數類型
string
預設值
null
定義
折扣金額（'discount_days' 必填）。此處金額以參數「currency」的貨幣表示
: 參數類型
string
預設值
null
定義
額外的定期付款詳情

* - 必需參數

折扣：

第一個週期以天數為單位（discount_days 參數），其費用金額會有所不同（discount_amount 參數）。例如，您可以為前 30 天和每月週期設定一個 discount_amount，這樣使用者第一次付款時會以較低的價格支付，第二次及後續付款則以全額支付。

折扣金額必須採用參數「貨幣」指定的貨幣。

請求範例

以下是一個包含最低要求參數數量的範例。本例中，將使用法定貨幣美元建立發票。在支付頁面上，用戶將能夠選擇加密貨幣和支付網路來支付此帳單。


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_currency 表示）
payer_amount	客戶必須支付的 payer_currency 金額
url_callback	發送付款狀態 webhook 的 URL
period	定期付款期
status	重複狀態可用選項：• wait_accept• cancel_by_merchant• active• cancel_by_user
url	付款人進行付款的 Cryptomus 付款頁面的 URL
last_pay_off	上次付款日期。時區為 UTC+3。如果值為空，則表示未付款。
additional_data	額外的定期付款詳情

: 定義
循環 uuid
: 定義
重複名稱
: 定義
您系統中的訂單 ID
: 定義
經常性金額
: 定義
貨幣代碼
: 定義
客戶必須用來付款的貨幣。
: 定義
客戶必須支付的等值美元金額（以 payer_currency 表示）
: 定義
客戶必須支付的 payer_currency 金額
: 定義
發送付款狀態 webhook 的 URL
: 定義
定期付款期
: 定義
重複狀態可用選項：- wait_accept- cancel_by_merchant- active- cancel_by_user
: 定義
付款人進行付款的 Cryptomus 付款頁面的 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 的定期付款（僅允許使用 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}

複製