Створення періодичного платежу

Повторні платежі в криптовалюті - це спосіб автоматизувати регулярні транзакції за допомогою цифрових активів. Вони можуть бути корисними для послуг на основі підписки, пожертвування, членства та інших періодичних платежів.

Щоб використовувати повторювані платежі, вам потрібно створити платіж, який визначає суму, валюту та частоту платежів, а потім ділитися нею зі своїми платниками. Платник буде перенаправлений на веб -сайт Cryptomus, де йому потрібно буде увійти, щоб підтвердити план оплати та здійснити перший платіж. Після цього виплати здійснюватимуться автоматично відповідно до плану.

post

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

Копіювати

Прохання

Параметри запиту

Назва	Тип параметра	Значення за замовчуванням	Визначення
amount*	string		Повторювана сума платежу
currency*	string		Валютний код
name*	stringmin:3max:60		Повторюване ім'я платежу
period*	string		Періодичний період оплатив наявності:weeklymonthlythree_month
to_currency			Код валюти для прийняття платежівПараметр використовується для визначення цільової валюти для перетворення періодичної суми платежів.Наприклад, створити періодичний платіж за 20 USD в біткойн: amount: 20 currency: USD to_currency : btcAPI перетворить суму 20 USD в його еквівалент у BTC на основі поточного обмінного курсу, і користувач заплатить у BTC to_currency завжди має бути кодом криптовалюти, а не кодом фіатної валюти.
order_id	stringmin:1max:100	null	Ідентифікатор замовлення у вашій системі
url_callback	url	null	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 USD в біткойн:
amount: 20
currency: USD
to_currency : btcAPI перетворить суму 20 USD в його еквівалент у BTC на основі поточного обмінного курсу, і користувач заплатить у BTC to_currency завжди має бути кодом криптовалюти, а не кодом фіатної валюти.

Тип параметра

stringmin:1max:100

Визначення

Ідентифікатор замовлення у вашій системі

Тип параметра

url

Визначення

URL -адреса, до якої будуть надіслані веб -куки зі статусом платежів

Тип параметра

integermin:1max:365

Визначення

Дні знижки (необхідні з "discount_amount")

Тип параметра

string

Визначення

Сума знижки (необхідна з "discount_days"). Тут сума у валюті параметра "валюта"

Тип параметра

string

Визначення

Додаткові реквізити оплати

* - обов'язковий параметр

Знижка:

Перший період за дні (параметр discount_days ), який коштуватиме іншу суму (параметр discount_amount ). Наприклад, ви можете встановити discount_amount протягом перших 30 днів і щомісячного періоду, тоді користувач заплатить перший платіж із нижчою ціною, другий та наступний платежі будуть за повною ціною.

Сума знижок повинна бути у валюті, визначеній параметром "валюта".

Приклад запиту

Нижче наведено зразок прикладу з мінімальною необхідною кількістю параметрів у цьому випадку, рахунок -фактура буде створена з FIAT WURNCY 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	Ідентифікатор замовлення у вашій системі
amount	Повторювана сума
currency	Валютний код
payer_currency	Валюта, в якій замовник повинен здійснити платіж.
payer_amount_usd	Еквівалентна сума USD в payer_currency , яку повинен платити клієнт
payer_amount	Сума в payer_currency , яку повинен платити клієнт
url_callback	URL -адреса, до якої будуть надіслані веб -куки зі статусом платежів
period	Періодичний період оплати
status	Повторюваний статусДоступні варіанти:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	URL -адреса сторінки платежу Cryptomus, де платник здійснить платіж
last_pay_off	Дата останнього платежу. Часовий пояс - UTC+3. Якщо значення нульова, платежів не здійснювалося.
additional_data	Додаткові реквізити оплати

: Визначення
Повторювана uuid
: Визначення
Повторюване ім'я
: Визначення
Ідентифікатор замовлення у вашій системі
: Визначення
Повторювана сума
: Визначення
Валютний код
: Визначення
Валюта, в якій замовник повинен здійснити платіж.
: Визначення
Еквівалентна сума 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 USD і дозволити лише валюту 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}

Копіювати