Criando pagamento recorrente

Os pagamentos recorrentes em criptomoeda são uma maneira de automatizar transações regulares usando ativos digitais. Eles podem ser úteis para serviços, doações, associações e outros pagamentos recorrentes.

Para usar pagamentos recorrentes, você precisa criar um pagamento que especifique o valor, a moeda e a frequência dos pagamentos e compartilhe -o com seus pagadores. O pagador será redirecionado para o site da Cryptomus, onde ele precisará fazer login para confirmar o plano de pagamento e efetuar o primeiro pagamento. Depois disso, os pagamentos serão feitos automaticamente de acordo com o plano.

post https://api.cryptomus.com/v1/recurrence/create Cópia

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Valor padrão	Definição
amount*	string	-	Valor do pagamento recorrente
currency*	string	-	Código da moeda
name*	stringmin:3max:60	-	Nome de pagamento recorrente
period*	string	-	Período de pagamento recorrentedisponível:weeklymonthlythree_month
to_currency		-	Código da moeda para aceitar pagamentosO parâmetro é usado para especificar a moeda alvo para converter o valor do pagamento recorrente.Por exemplo, para criar um pagamento recorrente para 20 USD em Bitcoin: amount: 20 currency: usd to_currency : BTCA API converterá 20 valor de USD em seu equivalente no BTC com base na taxa de câmbio atual e o usuário pagará no BTCO to_currency deve sempre ser o código de criptomoeda, não um código de moeda fiduciário.
order_id	stringmin:1max:100	null	Pedido ID em seu sistema
url_callback	url	null	URL para quais webhooks com status de pagamento serão enviados
discount_days	integermin:1max:365	0	Dias do período de desconto (exigido com 'desconto_amount')
discount_amount	string	null	Valor do desconto (exigido com 'desconto_days'). Aqui o valor na moeda do parâmetro 'moeda'
additional_data	string	null	Detalhes de pagamento recorrentes adicionais

: Tipo de parâmetro
string
Definição
Valor do pagamento recorrente
: Tipo de parâmetro
string
Definição
Código da moeda
: Tipo de parâmetro
stringmin:3max:60
Definição
Nome de pagamento recorrente
: Tipo de parâmetro
string
Definição
Período de pagamento recorrentedisponível:weeklymonthlythree_month
: Definição
Código da moeda para aceitar pagamentosO parâmetro é usado para especificar a moeda alvo para converter o valor do pagamento recorrente.Por exemplo, para criar um pagamento recorrente para 20 USD em Bitcoin:
amount: 20
currency: usd
to_currency : BTCA API converterá 20 valor de USD em seu equivalente no BTC com base na taxa de câmbio atual e o usuário pagará no BTCO to_currency deve sempre ser o código de criptomoeda, não um código de moeda fiduciário.
: Tipo de parâmetro
stringmin:1max:100
Valor padrão
null
Definição
Pedido ID em seu sistema
: Tipo de parâmetro
url
Valor padrão
null
Definição
URL para quais webhooks com status de pagamento serão enviados
: Tipo de parâmetro
integermin:1max:365
Valor padrão
0
Definição
Dias do período de desconto (exigido com 'desconto_amount')
: Tipo de parâmetro
string
Valor padrão
null
Definição
Valor do desconto (exigido com 'desconto_days'). Aqui o valor na moeda do parâmetro 'moeda'
: Tipo de parâmetro
string
Valor padrão
null
Definição
Detalhes de pagamento recorrentes adicionais

* - parâmetro obrigatório

Desconto:

O primeiro período em dias (o parâmetro discount_days ), que custará uma quantia diferente (o parâmetro discount_amount ). Por exemplo, você pode definir um discount_amount nos primeiros 30 dias e um período mensal; em seguida, o usuário pagará o primeiro pagamento com um preço mais baixo, o segundo e os pagamentos subsequentes terão o preço total.

O valor do desconto deve estar na moeda especificada pelo parâmetro "moeda".

Exemplo de solicitação

Abaixo está um exemplo de amostra com o número mínimo necessário de parâmetros nesse caso, uma fatura será criada com o USD da moeda fiduciária. Na página de pagamento, o usuário poderá selecionar a criptomoeda e a rede para pagar esta conta.


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

Cópia

Resposta

Parâmetros de resposta

Nome	Definição
uuid	Uuid recorrente
name	Nome recorrente
order_id	Pedido ID em seu sistema
amount	Quantidade recorrente
currency	Código da moeda
payer_currency	A moeda em que o cliente deve efetuar o pagamento.
payer_amount_usd	O valor equivalente a USD em payer_currency que o cliente deve pagar
payer_amount	O valor em pager_currency que o cliente deve pagar
url_callback	URL para quais webhooks com status de pagamento serão enviados
period	Período de pagamento recorrente
status	Status recorrenteOpções disponíveis:• wait_accept• cancel_by_merchant• active• cancel_by_user
url	O URL da página de pagamento do Cryptomus, onde o pagador fará o pagamento
last_pay_off	Data do último pagamento. O fuso horário é UTC+3. Se o valor for nulo, nenhum pagamento foi feito.
additional_data	Detalhes de pagamento recorrentes adicionais

: Definição
Uuid recorrente
: Definição
Nome recorrente
: Definição
Pedido ID em seu sistema
: Definição
Quantidade recorrente
: Definição
Código da moeda
: Definição
A moeda em que o cliente deve efetuar o pagamento.
: Definição
O valor equivalente a USD em payer_currency que o cliente deve pagar
: Definição
O valor em pager_currency que o cliente deve pagar
: Definição
URL para quais webhooks com status de pagamento serão enviados
: Definição
Período de pagamento recorrente
: Definição
Status recorrenteOpções disponíveis:- wait_accept- cancel_by_merchant- active- cancel_by_user
: Definição
O URL da página de pagamento do Cryptomus, onde o pagador fará o pagamento
: Definição
Data do último pagamento. O fuso horário é UTC+3. Se o valor for nulo, nenhum pagamento foi feito.
: Definição
Detalhes de pagamento recorrentes adicionais

Exemplo de resposta

Se a solicitação for bem -sucedida. O código de resposta é 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}

Cópia

Mais exemplos

Solicite exemplo de dados para criar um pagamento de recorrência 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}

Cópia

Exemplo de resposta:


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}

Cópia

Solicitar exemplo de dados para criar um pagamento de recorrência para 15 USDT (apenas USDT será permitido para pagamento)


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

Cópia

Exemplo de resposta:


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}

Cópia

Solicite exemplo de dados para criar um pagamento de recorrência por 15 dólares e permitir apenas moeda BTC para pagamento


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}

Cópia

Exemplo de resposta:


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}

Cópia

Solicite o exemplo de dados para criar um pagamento recorrente no valor de US $ 15. Nos primeiros 30 dias, o preço será de US $ 1, depois disso - US $ 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}

Cópia

Exemplo de resposta:


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}

Cópia