定期的な支払いの作成

暗号通貨での定期的な支払いは、デジタル資産を使用して定期的なトランザクションを自動化する方法です。サブスクリプションベースのサービス、寄付、メンバーシップ、およびその他の定期的な支払いに役立ちます。

定期的な支払いを使用するには、支払いの金額、通貨、および頻度を指定する支払いを作成し、支払い者と共有する必要があります。支払者はCryptomus Webサイトにリダイレクトされ、そこで支払い計画を確認して最初の支払いを行うためにログインする必要があります。その後、計画に従って支払いが自動的に行われます。

post

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

コピー

リクエスト

クエリパラメーター

名前	パラメータータイプ	デフォルト値	意味
amount*	string		定期的な支払い額
currency*	string		通貨コード
name*	stringmin:3max:60		定期的な支払い名
period*	string		定期的な支払い期間利用可能：weeklymonthlythree_month
to_currency			支払いを受け入れるための通貨コードこのパラメーターは、ターゲット通貨を指定して、再発金額を変換するために使用されます。methods.For example, to create an recurrent payment for 20 USD in bitcoinAPIは、現在の為替レートに基づいて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」で必要）。ここでは、パラメーター「通貨」の通貨の金額
additional_data	string	null	追加の定期的な支払いの詳細

パラメータータイプ

string

意味

定期的な支払い額

パラメータータイプ

string

意味

通貨コード

パラメータータイプ

stringmin:3max:60

意味

定期的な支払い名

パラメータータイプ

string

意味

定期的な支払い期間利用可能：weeklymonthlythree_month

意味

支払いを受け入れるための通貨コードこのパラメーターは、ターゲット通貨を指定して、再発金額を変換するために使用されます。methods.For example, to create an recurrent payment for 20 USD in bitcoinAPIは、現在の為替レートに基づいて20米ドルをBTCの同等物に変換し、ユーザーはBTCで支払います to_currency は、常にフィアット通貨コードではなく、暗号通貨コードである必要があります。

パラメータータイプ

stringmin:1max:100

意味

システムでIDを注文します

パラメータータイプ

url

意味

支払いステータスのWebhookが送信されるURL

パラメータータイプ

integermin:1max:365

意味

割引期間（「Discount_Amount」で必要）

パラメータータイプ

string

意味

割引額（「Discount_days」で必要）。ここでは、パラメーター「通貨」の通貨の金額

パラメータータイプ

string

意味

追加の定期的な支払いの詳細

* - 必須パラメーター

割引：

日の最初の期間（ discount_days パラメーター）。たとえば、最初の30日間と毎月の期間にA Discount_Amount を設定できます。その後、ユーザーはより低い価格で最初の支払いを支払います。

割引額は、パラメーター「通貨」で指定された通貨内でなければなりません。

リクエスト例

以下は、必要なパラメーターの最小数を含むサンプルの例です。この場合、請求書はFIAT通貨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_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です。値がnullの場合、支払いは行われませんでした。
additional_data	追加の定期的な支払いの詳細

: 意味
繰り返しuuid
: 意味
繰り返しの名前
: 意味
システムでIDを注文します
: 意味
繰り返し金額
: 意味
通貨コード
: 意味
顧客が支払いをしなければならない通貨。
: 意味
顧客が支払わなければならない payer_currency の同等の米ドルの金額
: 意味
顧客が支払わなければならない payer_currency の金額
: 意味
支払いステータスのWebhookが送信されるURL
: 意味
定期的な支払い期間
: 意味
繰り返しステータス利用可能なオプション：- wait_accept- cancel_by_merchant- active- cancel_by_user
: 意味
支払者が支払いをするCryptomus支払いページのURL
: 意味
最後の支払いの日付。タイムゾーンはUTC+3です。値がnullの場合、支払いは行われませんでした。
: 意味
追加の定期的な支払いの詳細

応答の例

リクエストが成功した場合。応答コードは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}

コピー