Wiederherstellung der Zahlung

Wiederkehrende Zahlungen in der Kryptowährung sind eine Möglichkeit, regelmäßige Transaktionen mithilfe digitaler Vermögenswerte zu automatisieren. Sie können für abonnementbasierte Dienste, Spenden, Mitgliedschaften und andere wiederkehrende Zahlungen nützlich sein.

Um wiederkehrende Zahlungen zu verwenden, müssen Sie eine Zahlung erstellen, die den Betrag, die Währung und die Häufigkeit der Zahlungen angibt und sie dann mit Ihren Zahler teilen. Der Zahler wird auf die Kryptomus -Website weitergeleitet, auf der er sich anmelden muss, um den Zahlungsplan zu bestätigen und die erste Zahlung zu leisten. Danach werden Zahlungen automatisch gemäß dem Plan erfolgen.

post

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

KOPIEREN

Anfrage

Abfrageparameter

Name	Parametertyp	Standardwert	Definition
amount*	string		Wiederkehrender Zahlungsbetrag
currency*	string		Währungscode
name*	stringmin:3max:60		Wiederkehrender Zahlungsname
period*	string		Wiederkehrender Zahlungsfristverfügbar:weeklymonthlythree_month
to_currency			Währungscode zum Annehmen von ZahlungenDer Parameter wird verwendet, um die Zielwährung für die Konvertierung des wiederkehrenden Zahlungsbetrags anzugeben.Zum Beispiel eine wiederkehrende Zahlung für 20 USD in Bitcoin: amount: 20 currency: USD to_currency : btcDie API wird basierend auf dem aktuellen Wechselkurs 20 USD in BTC in ihre Äquivalent umwandeln, und der Benutzer zahlt in BTCDie to_currency sollte immer der Kryptowährungscode sein, nicht ein Fiat -Währungscode.
order_id	stringmin:1max:100	null	Bestell -ID in Ihrem System bestellen
url_callback	url	null	URL, an die Webhooks mit Zahlungsstatus gesendet werden
discount_days	integermin:1max:365	0	Rabattzeit Tage (erforderlich mit 'Rabatt_Amount')
discount_amount	string	null	Rabattbetrag (erforderlich mit 'Rabatt_Days'). Hier der Betrag in der Währung des Parameters "Währung"
additional_data	string	null	Zusätzliche wiederkehrende Zahlungsdetails

Parametertyp

string

Definition

Wiederkehrender Zahlungsbetrag

Parametertyp

string

Definition

Währungscode

Parametertyp

stringmin:3max:60

Definition

Wiederkehrender Zahlungsname

Parametertyp

string

Definition

Wiederkehrender Zahlungsfristverfügbar:weeklymonthlythree_month

Definition

Währungscode zum Annehmen von ZahlungenDer Parameter wird verwendet, um die Zielwährung für die Konvertierung des wiederkehrenden Zahlungsbetrags anzugeben.Zum Beispiel eine wiederkehrende Zahlung für 20 USD in Bitcoin:
amount: 20
currency: USD
to_currency : btcDie API wird basierend auf dem aktuellen Wechselkurs 20 USD in BTC in ihre Äquivalent umwandeln, und der Benutzer zahlt in BTCDie to_currency sollte immer der Kryptowährungscode sein, nicht ein Fiat -Währungscode.

Parametertyp

stringmin:1max:100

Definition

Bestell -ID in Ihrem System bestellen

Parametertyp

url

Definition

URL, an die Webhooks mit Zahlungsstatus gesendet werden

Parametertyp

integermin:1max:365

Definition

Rabattzeit Tage (erforderlich mit 'Rabatt_Amount')

Parametertyp

string

Definition

Rabattbetrag (erforderlich mit 'Rabatt_Days'). Hier der Betrag in der Währung des Parameters "Währung"

Parametertyp

string

Definition

Zusätzliche wiederkehrende Zahlungsdetails

* - obligatorischer Parameter

Rabatt:

Die erste Periode in Tagen (der Parameter discount_days ), der einen anderen Betrag kostet (der Parameter discount_amount ). Zum Beispiel können Sie für die ersten 30 Tage und einen monatlichen Zeitraum a discount_amount festlegen. Der Benutzer zahlt die erste Zahlung mit einem niedrigeren Preis. Die zweite und nachfolgende Zahlungen werden zum vollen Preis liegen.

Der Rabattbetrag muss sich in der Währung befinden, die durch den Parameter „Währung“ angegeben ist.

Beispiel anfordern

Im Folgenden finden Sie ein Beispielbeispiel, bei dem in diesem Fall die minimal erforderliche Anzahl von Parametern eine Rechnung mit dem Fiat -Währung USD erstellt wird. Auf der Zahlungsseite kann der Benutzer die Kryptowährung und das Netzwerk für die Zahlung dieser Rechnung auswählen.


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

KOPIEREN

Antwort

Antwortparameter

Name	Definition
uuid	Wiederkehrendes Uuid
name	Wiederkehrender Name
order_id	Bestell -ID in Ihrem System bestellen
amount	Wiederkehrender Betrag
currency	Währungscode
payer_currency	Die Währung, in der der Kunde die Zahlung leisten muss.
payer_amount_usd	Der äquivalente USD -Betrag in payer_currency , dass der Kunde zahlen muss
payer_amount	Der Betrag in payer_currency , dass der Kunde zahlen muss
url_callback	URL, an die Webhooks mit Zahlungsstatus gesendet werden
period	Wiederkehrender Zahlungsfrist
status	Wiederkehrender StatusVerfügbare Optionen:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	Die URL der Kryptomus -Zahlungsseite, auf der der Zahler die Zahlung leistet
last_pay_off	Datum der letzten Zahlung. Die Zeitzone ist UTC+3. Wenn der Wert null ist, wurden keine Zahlungen geleistet.
additional_data	Zusätzliche wiederkehrende Zahlungsdetails

: Definition
Wiederkehrendes Uuid
: Definition
Wiederkehrender Name
: Definition
Bestell -ID in Ihrem System bestellen
: Definition
Wiederkehrender Betrag
: Definition
Währungscode
: Definition
Die Währung, in der der Kunde die Zahlung leisten muss.
: Definition
Der äquivalente USD -Betrag in payer_currency , dass der Kunde zahlen muss
: Definition
Der Betrag in payer_currency , dass der Kunde zahlen muss
: Definition
URL, an die Webhooks mit Zahlungsstatus gesendet werden
: Definition
Wiederkehrender Zahlungsfrist
: Definition
Wiederkehrender StatusVerfügbare Optionen:- wait_accept- cancel_by_merchant- active- cancel_by_user
: Definition
Die URL der Kryptomus -Zahlungsseite, auf der der Zahler die Zahlung leistet
: Definition
Datum der letzten Zahlung. Die Zeitzone ist UTC+3. Wenn der Wert null ist, wurden keine Zahlungen geleistet.
: Definition
Zusätzliche wiederkehrende Zahlungsdetails

Antwortbeispiel

Wenn die Anfrage erfolgreich ist. Der Antwortcode ist 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}

KOPIEREN

Mehr Beispiele

Fordern Sie Datenbei


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

KOPIEREN

Antwortbeispiel:


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}

KOPIEREN

Anfordern von Daten Beispiel, um eine Wiederholung Zahlung für 15 USDT zu erstellen (nur USDT ist für die Zahlung zulässig)


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

KOPIEREN

Antwortbeispiel:


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}

KOPIEREN

Fordern Sie Datenbei


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}

KOPIEREN

Antwortbeispiel:


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}

KOPIEREN

Anfordern Sie Datenbeispiel, um eine wiederkehrende Zahlung in Höhe von 15 USD zu erstellen. In den ersten 30 Tagen beträgt der Preis 1 US -Dollar, danach - 15 US -Dollar:


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}

KOPIEREN

Antwortbeispiel:


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}

KOPIEREN