Tworzenie powtarzających się płatności

Powtarzające się płatności w kryptowalucie są sposobem na automatyzację regularnych transakcji za pomocą aktywów cyfrowych. Mogą być przydatne do usług opartych na subskrypcji, darowizn, członkostwa i innych powtarzających się płatności.

Aby korzystać z powtarzających się płatności, musisz utworzyć płatność, która określa kwotę, walutę i częstotliwość płatności, a następnie udostępnić ją płatnikom. Płatnik zostanie przekierowany na stronę Cryptomus, gdzie będzie musiał zalogować się, aby potwierdzić plan płatności i dokonać pierwszej płatności. Następnie płatności będą dokonywane automatycznie zgodnie z planem.

post

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

KOPIUJ

Wniosek

Parametry zapytania

Nazwa	Typ parametru	Domyślna wartość	Definicja
amount*	string		Powtarzająca się kwota płatności
currency*	string		Kod waluty
name*	stringmin:3max:60		Powtarzająca się nazwa płatności
period*	string		Powtarzający się okres płatnościdostępny:weeklymonthlythree_month
to_currency			Kod waluty do przyjmowania płatnościParametr służy do określenia docelowej waluty do konwersji powtarzającej się kwoty płatności.Na przykład, aby utworzyć powtarzającą się płatność za 20 USD w Bitcoin: amount: 20 currency: USD to_currency : BTC API przekonwertuje kwotę 20 USD na równoważny w BTC na podstawie bieżącego kursu walutowego, a użytkownik zapłaci w BTC to_currency powinien być zawsze kodem kryptowaluty, a nie kodem waluty fiat.
order_id	stringmin:1max:100	null	Zamów identyfikator w twoim systemie
url_callback	url	null	URL, do którego Webhooks ze statusem płatności zostaną wysłane
discount_days	integermin:1max:365	0	Dni okresu rabatowego (wymagane z „discount_amount”)
discount_amount	string	null	Kwota rabatowa (wymagana z „dyskontem”). Tutaj kwota w walucie parametru „waluta”
additional_data	string	null	Dodatkowe powtarzające się szczegóły płatności

Typ parametru

string

Definicja

Powtarzająca się kwota płatności

Typ parametru

string

Definicja

Kod waluty

Typ parametru

stringmin:3max:60

Definicja

Powtarzająca się nazwa płatności

Typ parametru

string

Definicja

Powtarzający się okres płatnościdostępny:weeklymonthlythree_month

Definicja

Kod waluty do przyjmowania płatnościParametr służy do określenia docelowej waluty do konwersji powtarzającej się kwoty płatności.Na przykład, aby utworzyć powtarzającą się płatność za 20 USD w Bitcoin:
amount: 20
currency: USD
to_currency : BTC API przekonwertuje kwotę 20 USD na równoważny w BTC na podstawie bieżącego kursu walutowego, a użytkownik zapłaci w BTC to_currency powinien być zawsze kodem kryptowaluty, a nie kodem waluty fiat.

Typ parametru

stringmin:1max:100

Definicja

Zamów identyfikator w twoim systemie

Typ parametru

url

Definicja

URL, do którego Webhooks ze statusem płatności zostaną wysłane

Typ parametru

integermin:1max:365

Definicja

Dni okresu rabatowego (wymagane z „discount_amount”)

Typ parametru

string

Definicja

Kwota rabatowa (wymagana z „dyskontem”). Tutaj kwota w walucie parametru „waluta”

Typ parametru

string

Definicja

Dodatkowe powtarzające się szczegóły płatności

* - obowiązkowy parametr

Rabat:

Pierwszy okres od dni (parametr discount_days), który będzie kosztował inną kwotę (parametr discount_amount ). Na przykład możesz ustawić discount_amount przez pierwsze 30 dni i okres miesięczny, wówczas użytkownik zapłaci pierwszą płatność niższą cenę, drugie i kolejne płatności będą w pełnej cenie.

Kwota rabatowa musi znajdować się w walucie określonej przez parametr „waluta”.

Przykład żądania

Poniżej znajduje się przykładowy przykład z minimalną wymaganą liczbą parametrów W tym przypadku faktura zostanie utworzona z walutą FIAT. Na stronie płatności użytkownik będzie mógł wybrać kryptowalutę i sieć, aby zapłacić ten rachunek.


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"
}'

KOPIUJ

Odpowiedź

Parametry odpowiedzi

Nazwa	Definicja
uuid	Powtarzający się UUID
name	Powtarzające się nazwa
order_id	Zamów identyfikator w twoim systemie
amount	Powtarzająca się kwota
currency	Kod waluty
payer_currency	Waluta, w której klient musi dokonać płatności.
payer_amount_usd	Równoważna kwota USD w payer_currency , że klient musi zapłacić
payer_amount	Kwota w payer_currency , którą klient musi zapłacić
url_callback	URL, do którego Webhooks ze statusem płatności zostaną wysłane
period	Powtarzający się okres płatności
status	Powtarzający się statusDostępne opcje:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	URL strony płatności kryptomus, na której płatnik dokona płatności
last_pay_off	Data ostatniej płatności. Strefa czasowa to UTC+3. Jeśli wartość jest zerowa, nie dokonano płatności.
additional_data	Dodatkowe powtarzające się szczegóły płatności

: Definicja
Powtarzający się UUID
: Definicja
Powtarzające się nazwa
: Definicja
Zamów identyfikator w twoim systemie
: Definicja
Powtarzająca się kwota
: Definicja
Kod waluty
: Definicja
Waluta, w której klient musi dokonać płatności.
: Definicja
Równoważna kwota USD w payer_currency , że klient musi zapłacić
: Definicja
Kwota w payer_currency , którą klient musi zapłacić
: Definicja
URL, do którego Webhooks ze statusem płatności zostaną wysłane
: Definicja
Powtarzający się okres płatności
: Definicja
Powtarzający się statusDostępne opcje:- wait_accept- cancel_by_merchant- active- cancel_by_user
: Definicja
URL strony płatności kryptomus, na której płatnik dokona płatności
: Definicja
Data ostatniej płatności. Strefa czasowa to UTC+3. Jeśli wartość jest zerowa, nie dokonano płatności.
: Definicja
Dodatkowe powtarzające się szczegóły płatności

Przykład odpowiedzi

Jeśli żądanie się powiedzie. Kod odpowiedzi to 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}

KOPIUJ

Więcej przykładów

Przykład danych żądania, aby utworzyć płatność nawrotu za 15 USD


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

KOPIUJ

Przykład odpowiedzi:


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}

KOPIUJ

Przykład danych żądania, aby utworzyć płatność nawrotu za 15 USDT (tylko USDT będzie dozwolony do płatności)


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

KOPIUJ

Przykład odpowiedzi:


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}

KOPIUJ

Zakładaj przykład danych, aby utworzyć płatność nawrotu za 15 USD i zezwolić tylko na walutę BTC na płatność


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}

KOPIUJ

Przykład odpowiedzi:


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}

KOPIUJ

Przykład danych żądania, aby utworzyć powtarzającą się płatność w wysokości 15 USD. Pierwsze 30 dni cena wyniesie 1 USD, po tym - 15 USD:


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}

KOPIUJ

Przykład odpowiedzi:


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}

KOPIUJ