Création de paiement récurrent

Les paiements récurrents en crypto-monnaie sont un moyen d'automatiser les transactions régulières à l'aide d'actifs numériques. Ils peuvent être utiles pour les services, les dons, les abonnements et les autres paiements récurrents.

Pour utiliser les paiements récurrents, vous devez créer un paiement qui spécifie le montant, la monnaie et la fréquence des paiements, puis le partager avec vos payeurs. Le payeur sera redirigé vers le site Web de Cryptomus, où il devra se connecter pour confirmer le plan de paiement et effectuer le premier paiement. Après cela, les paiements seront effectués automatiquement selon le plan.

post

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

COPIE

Demande

Paramètres de requête

Nom	Type de paramètre	Valeur par défaut	Définition
amount*	string		Montant de paiement récurrent
currency*	string		Code de devise
name*	stringmin:3max:60		Nom de paiement récurrent
period*	string		Période de paiement récurrentedisponible:weeklymonthlythree_month
to_currency			Code de devise pour accepter les paiementsLe paramètre est utilisé pour spécifier la monnaie cible pour convertir le montant de paiement récurrent.Par exemple, pour créer un paiement récurrent pour 20 USD dans Bitcoin: amount: 20 currency : USD to_currency : btcL'API convertira 20 USD à son équivalent en BTC en fonction du taux de change actuel et l'utilisateur paiera en BTCLe to_currency doit toujours être le code de crypto-monnaie, pas un code de monnaie fiduciaire.
order_id	stringmin:1max:100	null	Commandez ID dans votre système
url_callback	url	null	URL à laquelle les webhooks avec l'état de paiement seront envoyés
discount_days	integermin:1max:365	0	Days de période de réduction (requis avec «Discount_amount»)
discount_amount	string	null	Montant de réduction (requis avec «Discount_days»). Ici, le montant de la devise du paramètre «devise»
additional_data	string	null	Détails de paiement récurrent supplémentaires

Type de paramètre

string

Définition

Montant de paiement récurrent

Type de paramètre

string

Définition

Code de devise

Type de paramètre

stringmin:3max:60

Définition

Nom de paiement récurrent

Type de paramètre

string

Définition

Période de paiement récurrentedisponible:weeklymonthlythree_month

Définition

Code de devise pour accepter les paiementsLe paramètre est utilisé pour spécifier la monnaie cible pour convertir le montant de paiement récurrent.Par exemple, pour créer un paiement récurrent pour 20 USD dans Bitcoin:
amount: 20
currency : USD
to_currency : btcL'API convertira 20 USD à son équivalent en BTC en fonction du taux de change actuel et l'utilisateur paiera en BTCLe to_currency doit toujours être le code de crypto-monnaie, pas un code de monnaie fiduciaire.

Type de paramètre

stringmin:1max:100

Définition

Commandez ID dans votre système

Type de paramètre

url

Définition

URL à laquelle les webhooks avec l'état de paiement seront envoyés

Type de paramètre

integermin:1max:365

Définition

Days de période de réduction (requis avec «Discount_amount»)

Type de paramètre

string

Définition

Montant de réduction (requis avec «Discount_days»). Ici, le montant de la devise du paramètre «devise»

Type de paramètre

string

Définition

Détails de paiement récurrent supplémentaires

* - paramètre obligatoire

Rabais:

La première période de jours (le paramètre discount_days ), qui coûtera un montant différent (le paramètre discount_amount ). Par exemple, vous pouvez définir un Discount_amount pour les 30 premiers jours et une période mensuelle, puis l'utilisateur paiera le premier paiement à un prix inférieur, le deuxième paiement et les paiements suivants seront au prix fort.

Le montant de réduction doit être dans la devise spécifiée par la «monnaie» du paramètre.

Demander un exemple

Vous trouverez ci-dessous un exemple d'exemple avec le nombre minimum requis de paramètres dans ce cas, une facture sera créée avec la monnaie fiduciaire USD. Sur la page de paiement, l'utilisateur pourra sélectionner la crypto-monnaie et le réseau pour payer cette facture.


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

COPIE

Réponse

Paramètres de réponse

Nom	Définition
uuid	Uuid récurrent
name	Nom récurrent
order_id	Commandez ID dans votre système
amount	Somme récurrente
currency	Code de devise
payer_currency	La monnaie dans laquelle le client doit effectuer le paiement.
payer_amount_usd	Le montant USD équivalent dans payer_currency que le client doit payer
payer_amount	Le montant dans payer_currency que le client doit payer
url_callback	URL à laquelle les webhooks avec l'état de paiement seront envoyés
period	Période de paiement récurrente
status	Statut récurrentOptions disponibles:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	L'URL de la page de paiement Cryptomus où le payeur effectuera le paiement
last_pay_off	Date du dernier paiement. Le fuseau horaire est UTC + 3. Si la valeur est nul, aucun paiement n'a été effectué.
additional_data	Détails de paiement récurrent supplémentaires

: Définition
Uuid récurrent
: Définition
Nom récurrent
: Définition
Commandez ID dans votre système
: Définition
Somme récurrente
: Définition
Code de devise
: Définition
La monnaie dans laquelle le client doit effectuer le paiement.
: Définition
Le montant USD équivalent dans payer_currency que le client doit payer
: Définition
Le montant dans payer_currency que le client doit payer
: Définition
URL à laquelle les webhooks avec l'état de paiement seront envoyés
: Définition
Période de paiement récurrente
: Définition
Statut récurrentOptions disponibles:- wait_accept- cancel_by_merchant- active- cancel_by_user
: Définition
L'URL de la page de paiement Cryptomus où le payeur effectuera le paiement
: Définition
Date du dernier paiement. Le fuseau horaire est UTC + 3. Si la valeur est nul, aucun paiement n'a été effectué.
: Définition
Détails de paiement récurrent supplémentaires

Exemple de réponse

Si la demande réussit. Le code de réponse est de 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}

COPIE

Plus d'exemples

Demandez l'exemple de données pour créer un paiement de récidive pour 15 USD


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

COPIE

Exemple de réponse:


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}

COPIE

Demandez l'exemple de données pour créer un paiement de récidive pour 15 USDT (seul USDT sera autorisé pour le paiement)


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

COPIE

Exemple de réponse:


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}

COPIE

Demandez l'exemple de données pour créer un paiement de récurrence pour 15 USD et autoriser uniquement la monnaie BTC pour le paiement


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}

COPIE

Exemple de réponse:


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}

COPIE

Demandez l'exemple de données pour créer un paiement récurrent d'un montant de 15 $. Les 30 premiers jours, le prix sera de 1 $, après cela - 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}

COPIE

Exemple de réponse:


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}

COPIE