Notificação Crypto
Quando um Criptomoeda for pago, o sistema enviará uma notificação para o endereço fornecido pelo cliente, informando atualização de status do mesmo.
A URL que receberá as notificações deverá ser informada através do endpoint Cadastrar/Alterar Webhook.
Recebimento de Criptomoeda
Fazendo Requisição
A notificação será enviada utilizando o método POST, e espera uma resposta do tipo HTTP 200.
Segue estrutura do JSON enviado como request body:
{
"notification_type":"crypto_receivement",
"message":{
"value":10.5,
"wallet_id":"19114010-0487-4d7d-b15f-efb6213de9ea",
"payer_address":"TOSJDFSOIDFJSOFISDF",
"payment_date":"2024-08-13T11:10:02.965-03:00",
"operation_code":"dc41da0b-9dd4-49e9-bec2-5b34a68556f5"
}
}
Descrição dos Atributos
| PARÂMETRO | DESCRIÇÃO | TIPO |
|---|---|---|
| notification_type (Obrigatório) | Indica o tipo de mensagem transmitida. | ENUM crypto_receivement |
| message (Obrigatório) | Atualizado, conforme apresentado pelo endpoint. | STRING limite de 255 caracteres |
| message.value (Obrigatório) | Valor, em centavos. | DECIMAL Maior que 0 |
| message.wallet_id (Obrigatório) | ID da carteira cadastrada. | STRING |
| message.payer_address (Obrigatório) | Endereço do destinatário que receberá as moedas | STRING |
| message.payment_date (Obrigatório) | Data do pagamento. | STRING formato datetime YYYY-mm-ddTHH:MM:ss |
| message.operation_code (Obrigatório) | Código da operação. | STRING limite de 255 caracteres |
Erro
Caso seja obtido um resultado diferente de 200, o sistema tentará enviar pelos próximos 10 minutos, a cada minuto ou enquanto não for obtido um resultado de sucesso.
O erro persistindo nas 10 tentativas, a notificação será marcada como cancelada no sistema e nossa equipe entrará em contato para averiguar quaisquer problemas de integração.
OBS: Para gerar o hash md5 da mensagem é necessário considerar o seguinte formato da STRING a ser codificada.
cryptoreceivement.{address}.{operation_code}.{value}.{secret_key}
Onde:
cryptoreceivement:A palavra cryptoreceivement escrita em minúsculo{address}Endereço do destinatário que receberá as moedas{operation_code}:Código da operação{value}:Valor em centavos{secret_key}:Chave única, exclusiva do cliente para gerar hash. ela será gerada junto a credenciais de acesso da API
A string abaixo deve ser montada para gerar o Hash MD5 da mensagem citada como exemplo acima, considerando que a chave secreta do cliente seja a palavra SECRETKEY:
cryptoreceivement.address.operation_code.value.secret_key
O reenvio de notificações após a primeira tentativa falha ocorrerá apenas em ambiente de produção.
Pagamento em Criptomoeda
Fazendo Requisição
A notificação será enviada utilizando o método POST, e espera uma resposta do tipo HTTP 200.
Segue estrutura do JSON enviado como request body:
{
"notification_type":"crypto_payment",
"message":{
"crypto_currency_code":"USDT",
"reference_code":"CE202408130000000042",
"receiver_address":"TLyxu5on2Jdkcn5Y9TBfoTCXaQR4gG8rAL",
"value":1.49,
"status":"completed",
"operation_code":"test42",
"payment_date":"2024-08-13T11:19:51.945-03:00",
"return_date":"2024-08-13T11:19:51.945-03:00",
"return_message":null
}
}
Descrição dos Atributos
| PARÂMETRO | DESCRIÇÃO | TIPO |
|---|---|---|
| notification_type (Obrigatório) | Indica o tipo de mensagem transmitida. | ENUM crypto_payment |
| message (Obrigatório) | Atualizado, conforme apresentado pelo endpoint. | STRING limite de 255 caracteres |
| message.crypto_currency_code (Obrigatório) | código cripto. | STRING |
| message.reference_code (Obrigatório) | código de referência. | STRING |
| message.receiver_address (Obrigatório) | Endereço do recebedor. | STRING |
| message.value (Obrigatório) | Valor, em centavos. | DECIMAL Maior que 0 |
| message.status (Obrigatório) | Status do pagamento. | ENUM |
| message.operation_code (Obrigatório) | Código da operação. | STRING limite de 255 caracteres |
| message.wallet_id (Obrigatório) | ID da carteira cadastrada. | STRING |
| message.payer_address (Obrigatório) | Endereço do pagador | STRING |
| message.payment_date (Obrigatório) | Data do pagamento. | STRING formato datetime YYYY-mm-ddTHH:MM:ss |
| message.return_date (Obrigatório) | Data do retorno do pagamento. | STRING formato datetime YYYY-mm-ddTHH:MM:ss |
Erro
Caso seja obtido um resultado diferente de 200, o sistema tentará enviar pelos próximos 10 minutos, a cada minuto ou enquanto não for obtido um resultado de sucesso.
O erro persistindo nas 10 tentativas, a notificação será marcada como cancelada no sistema e nossa equipe entrará em contato para averiguar quaisquer problemas de integração.
OBS: Para gerar o hash md5 da mensagem é necessário considerar o seguinte formato da STRING a ser codificada.
cryptopayment.{reference_code}.{confirmation_code}.{value}.{secret_key}"
Onde:
cryptopayment:A palavra cryptoreceivement escrita em minúsculo{reference_code}Código de referência{confirmation_code}:Código da operação{value}:Valor em centavos{secret_key}:Chave única, exclusiva do cliente para gerar hash. ela será gerada junto a credenciais de acesso da API
A string abaixo deve ser montada para gerar o Hash MD5 da mensagem citada como exemplo acima, considerando que a chave secreta do cliente seja a palavra SECRETKEY:
cryptoreceivement.ZENDRYPIXQRCODE2.E18236120202206142202a1022c1tg10.2.SECRETKEY
O reenvio de notificações após a primeira tentativa falha ocorrerá apenas em ambiente de produção.