Creación de pago recurrente

Los pagos recurrentes en la criptomoneda son una forma de automatizar las transacciones regulares utilizando activos digitales. Pueden ser útiles para servicios basados en suscripción, donaciones, membresías y otros pagos recurrentes.

Para utilizar pagos recurrentes, debe crear un pago que especifique la cantidad, moneda y frecuencia de los pagos, y luego compartirlo con sus pagadores. El pagador será redirigido al sitio web de Cryptomus, donde deberá iniciar sesión para confirmar el plan de pago y realizar el primer pago. Después de eso, los pagos se realizarán automáticamente de acuerdo con el plan.

post

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

COPIAR

Pedido

Parámetros de consulta

Nombre	Tipo de parámetro	Valor por defecto	Definición
amount*	string		Monto del pago recurrente
currency*	string		Código de moneda
name*	stringmin:3max:60		Nombre de pago recurrente
period*	string		Período de pago recurrentedisponible:weeklymonthlythree_month
to_currency			Código de moneda para aceptar pagosEl parámetro se utiliza para especificar la moneda de destino para convertir el monto del pago recurrente.Por ejemplo, para crear un pago recurrente por 20 USD en bitcoin: amount: 20 currency: usd to_currency : btcLa API convertirá el monto de 20 USD a su equivalente en BTC en función del tipo de cambio actual y el usuario pagará en BTCEl to_currency siempre debe ser el código de criptomoneda, no un código de moneda fiduciaria.
order_id	stringmin:1max:100	null	ID de pedido en su sistema
url_callback	url	null	URL a la que se enviarán los webhooks con estado de pago
discount_days	integermin:1max:365	0	Días de período de descuento (requerido con 'descuento_amount')
discount_amount	string	null	Cantidad de descuento (requerido con 'descuento_days'). Aquí la cantidad en la moneda del parámetro "moneda"
additional_data	string	null	Detalles de pago recurrentes adicionales

Tipo de parámetro

string

Definición

Monto del pago recurrente

Tipo de parámetro

string

Definición

Código de moneda

Tipo de parámetro

stringmin:3max:60

Definición

Nombre de pago recurrente

Tipo de parámetro

string

Definición

Período de pago recurrentedisponible:weeklymonthlythree_month

Definición

Código de moneda para aceptar pagosEl parámetro se utiliza para especificar la moneda de destino para convertir el monto del pago recurrente.Por ejemplo, para crear un pago recurrente por 20 USD en bitcoin:
amount: 20
currency: usd
to_currency : btcLa API convertirá el monto de 20 USD a su equivalente en BTC en función del tipo de cambio actual y el usuario pagará en BTCEl to_currency siempre debe ser el código de criptomoneda, no un código de moneda fiduciaria.

Tipo de parámetro

stringmin:1max:100

Definición

ID de pedido en su sistema

Tipo de parámetro

url

Definición

URL a la que se enviarán los webhooks con estado de pago

Tipo de parámetro

integermin:1max:365

Definición

Días de período de descuento (requerido con 'descuento_amount')

Tipo de parámetro

string

Definición

Cantidad de descuento (requerido con 'descuento_days'). Aquí la cantidad en la moneda del parámetro "moneda"

Tipo de parámetro

string

Definición

Detalles de pago recurrentes adicionales

* - parámetro obligatorio

Descuento:

El primer período en días (el parámetro discount_days ), que cuesta una cantidad diferente (el parámetro discount_amount ). Por ejemplo, durante los primeros 30 días y un período mensual, puede establecer un discount_amount . El usuario paga el primer pago con un precio inferior. El segundo y posteriores pagos serán a precio completo.

El monto de descuento debe estar en la moneda especificada por el parámetro "moneda".

Ejemplo de solicitud

A continuación se muestra un ejemplo de muestra con el número mínimo requerido de parámetros en este caso, se creará una factura con la moneda Fiat USD. En la página de pago, el usuario podrá seleccionar la criptomoneda y la red para pagar esta factura.


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

COPIAR

Respuesta

Parámetros de respuesta

Nombre	Definición
uuid	Uuid recurrente
name	Nombre recurrente
order_id	ID de pedido en su sistema
amount	Monto Recurrente
currency	Código de moneda
payer_currency	La moneda en la que el cliente debe realizar el pago.
payer_amount_usd	El monto de USD equivalente en payer_currency que el cliente debe pagar
payer_amount	La cantidad en payer_currency que el cliente debe pagar
url_callback	URL a la que se enviarán los webhooks con estado de pago
period	Período de pago recurrente
status	Estado recurrenteOpciones Disponibles:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	La URL de la página de pago de Cryptomus donde el pagador realizará el pago
last_pay_off	Fecha del último pago. La zona horaria es UTC+3. Si el valor es nulo, no se hicieron pagos.
additional_data	Detalles de pago recurrentes adicionales

: Definición
Uuid recurrente
: Definición
Nombre recurrente
: Definición
ID de pedido en su sistema
: Definición
Monto Recurrente
: Definición
Código de moneda
: Definición
La moneda en la que el cliente debe realizar el pago.
: Definición
El monto de USD equivalente en payer_currency que el cliente debe pagar
: Definición
La cantidad en payer_currency que el cliente debe pagar
: Definición
URL a la que se enviarán los webhooks con estado de pago
: Definición
Período de pago recurrente
: Definición
Estado recurrenteOpciones Disponibles:- wait_accept- cancel_by_merchant- active- cancel_by_user
: Definición
La URL de la página de pago de Cryptomus donde el pagador realizará el pago
: Definición
Fecha del último pago. La zona horaria es UTC+3. Si el valor es nulo, no se hicieron pagos.
: Definición
Detalles de pago recurrentes adicionales

Ejemplo de respuesta

Si la solicitud es exitosa. El código de respuesta es 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}

COPIAR

Más ejemplos

Ejemplo de datos de solicitud para crear un pago de recurrencia para 15 USD


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

COPIAR

Ejemplo de respuesta:


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}

COPIAR

Solicitud de datos de datos para crear un pago de recurrencia por 15 USDT (solo se permitirá el USDT para el pago)


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

COPIAR

Ejemplo de respuesta:


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}

COPIAR

Solicitar el ejemplo de datos para crear un pago de recurrencia por 15 USD y permitir solo la moneda de BTC para el pago


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}

COPIAR

Ejemplo de respuesta:


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}

COPIAR

Solicite el ejemplo de datos para crear un pago recurrente por un monto de $ 15. Los primeros 30 días el precio será de $ 1, después de eso - $ 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}

COPIAR

Ejemplo de respuesta:


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}

COPIAR