ایجاد پرداخت مکرر

پرداخت های مکرر در cryptocurrency راهی برای خودکارسازی معاملات منظم با استفاده از دارایی های دیجیتال است. آنها می توانند برای خدمات مبتنی بر اشتراک ، کمکهای مالی ، عضویت و سایر پرداختهای مکرر مفید باشند.

برای استفاده از پرداختهای مکرر ، باید مبلغی را ایجاد کنید که مبلغ ، ارز و فرکانس پرداخت ها را مشخص کند و سپس آن را با پرداخت کنندگان خود به اشتراک بگذارید. پرداخت کننده به وب سایت Cryptomus هدایت می شود ، جایی که وی برای تأیید برنامه پرداخت و اولین پرداخت نیاز به ورود به سیستم دارد. پس از آن ، طبق برنامه ، پرداخت ها به طور خودکار انجام می شود.


post
https://api.cryptomus.com/v1/recurrence/create
کپی

درخواست

پارامترهای پرس و جو

نامنوع پارامتریمقدار پیش فرضتعریف
amount*stringمبلغ پرداخت مکرر
currency*stringکد ارز
name*stringmin:3max:60نام پرداخت مکرر
period*stringدوره پرداخت مکرردر دسترس:weeklymonthlythree_month
to_currencyکد ارزی برای پذیرش پرداختاین پارامتر برای تعیین ارز هدف برای تبدیل مبلغ پرداخت مکرر استفاده می شود.Por ejemplo, para crear un pago recurrente por 20 USD en bitcoin:
amount: 20
currency: usd
to_currency : btcAPI براساس نرخ ارز فعلی ، 20 دلار مبلغ 20 دلار را به معادل خود در BTC تبدیل می کند و کاربر در BTC پرداخت می کند to_currency همیشه باید کد cryptocurrency باشد ، نه یک کد ارزی FIAT.
order_idstringmin:1max:100nullشناسه را در سیستم خود سفارش دهید
url_callbackurlnullURL که از طریق وضعیت پرداخت وب به آنها ارسال می شود
discount_daysintegermin:1max:3650روزهای تخفیف (مورد نیاز با "تخفیف_مونت")
discount_amountstringnullمبلغ تخفیف (مورد نیاز با "تخفیف_ روز"). در اینجا مبلغ ارز پارامتر "ارز"
additional_datastringnullجزئیات پرداخت مکرر اضافی

نوع پارامتری

string

تعریف

مبلغ پرداخت مکرر

نوع پارامتری

string

تعریف

کد ارز

نوع پارامتری

stringmin:3max:60

تعریف

نام پرداخت مکرر

نوع پارامتری

string

تعریف

دوره پرداخت مکرردر دسترس:weeklymonthlythree_month

تعریف

کد ارزی برای پذیرش پرداختاین پارامتر برای تعیین ارز هدف برای تبدیل مبلغ پرداخت مکرر استفاده می شود.Por ejemplo, para crear un pago recurrente por 20 USD en bitcoin:
amount: 20
currency: usd
to_currency : btcAPI براساس نرخ ارز فعلی ، 20 دلار مبلغ 20 دلار را به معادل خود در BTC تبدیل می کند و کاربر در BTC پرداخت می کند to_currency همیشه باید کد cryptocurrency باشد ، نه یک کد ارزی FIAT.

نوع پارامتری

stringmin:1max:100

تعریف

شناسه را در سیستم خود سفارش دهید

نوع پارامتری

url

تعریف

URL که از طریق وضعیت پرداخت وب به آنها ارسال می شود

نوع پارامتری

integermin:1max:365

تعریف

روزهای تخفیف (مورد نیاز با "تخفیف_مونت")

نوع پارامتری

string

تعریف

مبلغ تخفیف (مورد نیاز با "تخفیف_ روز"). در اینجا مبلغ ارز پارامتر "ارز"

نوع پارامتری

string

تعریف

جزئیات پرداخت مکرر اضافی

* - پارامتر اجباری

تخفیف:

اولین دوره در روزها (پارامتر discount_days) ، که مبلغ متفاوتی هزینه خواهد داشت (پارامتر discount_amount ). به عنوان مثال ، می توانید برای 30 روز اول و یک دوره ماهانه یک discount_amount تنظیم کنید ، سپس کاربر مبلغ اول را با قیمت پایین تر پرداخت می کند ، پرداخت های دوم و بعدی با قیمت کامل خواهد بود.

مبلغ تخفیف باید در ارز مشخص شده توسط پارامتر "ارز" باشد.

مثال

در زیر نمونه ای از نمونه با حداقل تعداد مورد نیاز پارامترها در این حالت وجود دارد ، فاکتور با ارز فیات USD ایجاد می شود. در صفحه پرداخت ، کاربر قادر به انتخاب Cryptocurrency و شبکه برای پرداخت این لایحه خواهد بود.


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عود مجدد
nameنام مکرر
order_idشناسه را در سیستم خود سفارش دهید
amountمبلغ مکرر
currencyکد ارز
payer_currencyارز که در آن مشتری باید پرداخت را انجام دهد.
payer_amount_usdمبلغ معادل USD در payer_currency که مشتری باید بپردازد
payer_amountمبلغ در payer_currency که مشتری باید بپردازد
url_callbackURL که از طریق وضعیت پرداخت وب به آنها ارسال می شود
periodدوره پرداخت مکرر
statusوضعیت مکررگزینه های موجود:• wait_accept• cancel_by_merchant• active• cancel_by_user
urlURL صفحه پرداخت Cryptomus که در آن پرداخت کننده پرداخت را انجام می دهد
last_pay_offتاریخ آخرین پرداخت منطقه زمانی UTC+3 است. اگر ارزش تهی باشد ، هیچ پرداختی انجام نشده است.
additional_dataجزئیات پرداخت مکرر اضافی

تعریف

عود مجدد

تعریف

نام مکرر

تعریف

شناسه را در سیستم خود سفارش دهید

تعریف

مبلغ مکرر

تعریف

کد ارز

تعریف

ارز که در آن مشتری باید پرداخت را انجام دهد.

تعریف

مبلغ معادل USD در payer_currency که مشتری باید بپردازد

تعریف

مبلغ در payer_currency که مشتری باید بپردازد

تعریف

URL که از طریق وضعیت پرداخت وب به آنها ارسال می شود

تعریف

دوره پرداخت مکرر

تعریف

وضعیت مکررگزینه های موجود:- wait_accept- cancel_by_merchant- active- cancel_by_user

تعریف

URL صفحه پرداخت Cryptomus که در آن پرداخت کننده پرداخت را انجام می دهد

تعریف

تاریخ آخرین پرداخت منطقه زمانی 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}
کپی