Testando Webhook

Pagamento de teste

post https://api.cryptomus.com/v1/test-webhook/payment Cópia

Para validar a assinatura da matriz de dados webhook, use a chave da API de pagamento.

Para garantir que você esteja recebendo corretamente os webhooks e pode validar a assinatura, você deve usar esse método para testar os webhooks para pagamento.
Observe que nenhum dado é salvo no banco de dados e quaisquer dados recebidos no webhook são armazenados apenas em uma matriz para fins de teste para garantir a correção da assinatura e testar a recuperação dessa matriz.

Para testar um webhook com uma fatura existente, forneça seu ID UUID ou pedido. Se esses parâmetros não forem fornecidos, o webhook será enviado com uma fatura de teste.

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Valor padrão	Definição
url_callback*	stringmin:6max:150url	-	URL para quais webhooks com status de pagamento serão enviados
currency*	string	-	Código da moeda da fatura
network*	string	-	Código da rede de faturas
uuid	stringuuid	string uuid aleatória	Uuid da fatura
order_id	stringmin:1max:32alpha_dash	string aleatória	ID do pedido da fatura
status*	string	paid	Status do pagamentoOpções disponíveis:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

: Tipo de parâmetro
stringmin:6max:150url
Definição
URL para quais webhooks com status de pagamento serão enviados
: Tipo de parâmetro
string
Definição
Código da moeda da fatura
: Tipo de parâmetro
string
Definição
Código da rede de faturas
: Tipo de parâmetro
stringuuid
Valor padrão
string uuid aleatória
Definição
Uuid da fatura
: Tipo de parâmetro
stringmin:1max:32alpha_dash
Valor padrão
string aleatória
Definição
ID do pedido da fatura
: Tipo de parâmetro
string
Valor padrão
paid
Definição
Status do pagamentoOpções disponíveis:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - parâmetro obrigatório

Você pode passar por um dos parâmetros UUID ou Order_ID, se você passar os dois, a conta será identificada pelo UUID

Exemplo de solicitação


curl https://api.cryptomus.com/v1/test-webhook/payment \
-X POST \
-H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'

Cópia

Resposta

Exemplo de resposta


1{
2  "state": 0,
3  "result": []
4}

Cópia

Teste de pagamento

post https://api.cryptomus.com/v1/test-webhook/payout Cópia

Para validar a assinatura da matriz de dados webhook, use a chave da API de pagamento.

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Valor padrão	Definição
url_callback*	stringmin:6max:150url	-	URL para quais webhooks com status de pagamento serão enviados
currency*	string	-	Código da moeda de pagamento
network*	string	-	Código de rede de pagamento
uuid	stringuuid	string uuid aleatória	uuid do pagamento
order_id	stringmin:1max:32alpha_dash	string aleatória	Pedido ID do pagamento
status*	string	paid	Status de pagamentoOpções disponíveis:• process• check• paid• fail• cancel• system_fail

: Tipo de parâmetro
stringmin:6max:150url
Definição
URL para quais webhooks com status de pagamento serão enviados
: Tipo de parâmetro
string
Definição
Código da moeda de pagamento
: Tipo de parâmetro
string
Definição
Código de rede de pagamento
: Tipo de parâmetro
stringuuid
Valor padrão
string uuid aleatória
Definição
uuid do pagamento
: Tipo de parâmetro
stringmin:1max:32alpha_dash
Valor padrão
string aleatória
Definição
Pedido ID do pagamento
: Tipo de parâmetro
string
Valor padrão
paid
Definição
Status de pagamentoOpções disponíveis:- process- check- paid- fail- cancel- system_fail

* - parâmetro obrigatório

Você pode passar por um dos parâmetros UUID ou Order_ID, se você passar os dois, a conta será identificada pelo UUID

Exemplo de solicitação


curl https://api.cryptomus.com/v1/test-webhook/payout \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'

Cópia

Resposta

Exemplo de resposta


1{
2  "state": 0,
3  "result": []
4}

Cópia

Carteira de teste

post https://api.cryptomus.com/v1/test-webhook/wallet Cópia

Para validar a assinatura da matriz de dados webhook, use a chave da API de pagamento.

Solicitar

Parâmetros de consulta

Nome	Tipo de parâmetro	Valor padrão	Definição
url_callback*	stringmin:6max:150url	-	URL para quais webhooks com status de pagamento serão enviados
currency*	string	-	Código da moeda de pagamento
network*	string	-	Código da rede de pagamento
uuid	stringuuid	string uuid aleatória	uuid de carteira de negócios
order_id	stringmin:1max:32alpha_dash	string aleatória	ID do pedido da fatura
status*	string	paid	Status do pagamentoOpções disponíveis:• process• check• paid• paid_over• fail• wrong_amount• cancel• system_fail• refund_process• refund_fail• refund_paid

: Tipo de parâmetro
stringmin:6max:150url
Definição
URL para quais webhooks com status de pagamento serão enviados
: Tipo de parâmetro
string
Definição
Código da moeda de pagamento
: Tipo de parâmetro
string
Definição
Código da rede de pagamento
: Tipo de parâmetro
stringuuid
Valor padrão
string uuid aleatória
Definição
uuid de carteira de negócios
: Tipo de parâmetro
stringmin:1max:32alpha_dash
Valor padrão
string aleatória
Definição
ID do pedido da fatura
: Tipo de parâmetro
string
Valor padrão
paid
Definição
Status do pagamentoOpções disponíveis:- process- check- paid- paid_over- fail- wrong_amount- cancel- system_fail- refund_process- refund_fail- refund_paid

* - parâmetro obrigatório

Exemplo de solicitação


curl https://api.cryptomus.com/v1/test-webhook/wallet \
-X POST -H 'merchant: 860166ce-478c-4087-9813-55cfb6c34580' \
-H 'sign: a466b82fad9415cdbf5f47802b8d376c' \
-H 'Content-Type: application/json' \
-d '{
	"uuid": "e1830f1b-50fc-432e-80ec-15b58ccac867",
	"currency": "ETH",
	"url_callback": "https://your.site/callback",
	"network": "eth",
	"status": "paid"
}'

Cópia

Resposta

Exemplo de resposta


1{
2  "state": 0,
3  "result": []
4}

Cópia

Possíveis erros

Erros de validação

código : 422

exemplos de respostas:

Se você passa uuid ou order_id e fatura/carteira estática/pagamento não será encontrado:


1{
2    "state": 1,
3    "message": "Not found payment"
4}

Cópia


1{
2    "state": 1,
3    "message": "Not found payout"
4}

Cópia


1{
2    "state": 1,
3    "message": "Not found wallet"
4}

Cópia

Se você não passar os parâmetros necessários:


1{
2	"state": 1,
3	"errors": {
4		"currency": ["validation.required"]
5	}
6}

Cópia

Se a moeda e a rede fornecidas não forem criptografadas ou não são suportadas:


1{
2    "state": 1,
3    "message": "Payment service not found"
4}

Cópia


1{
2    "state": 1,
3    "message": "Payout service not found"
4}

Cópia