# Instruções Deverá ser um endpoint com método POST. * Será enviado um token JWT com criptografia HS256, assinado com o `clientSecret` fornecido ao parceiro. * O token terá duração de 1h (apenas para referência). Payload JWT ```typescript { businessId: businessId // identificador único básico do seu negócio. } ``` ## Requisição `POST` `/seuEndPoint` **Headers** | Name | Value | Description | | ------------- | ------------------ | ----------- | | Content-Type | `application/json` | | | Authorization | `Bearer ` | JWT | **Body** ```json { "ids": { "businessId": "string", "transactionId": "string", "partnerTransactionId": "string", "afterPaymentId": "string", "endToEndId": "string", "brCode": "string", "gatewayId": "string", "hashWeb3": "string" }, "transactionPayload": { "userId": "string", "userCpf": "string", "userPixKey": "string", "userWalletAddress": "string", "productName": "string", "quantity": number, "unitPrice": number, "usdtAmount": number, "reaisAmount": number }, "transactionType": "PIX_PURCHASE", "transactionStatus": "COMPLETED", "transactionErrorType": "NONE", "transactionErrorMessage": "NONE" } ``` Descrição dos campos

Identificadores da transação (ids) :

Sobre os campos com observação: _{Caso os campos marcoados no checkBox abaixo sejam enviados com o sufixo "-NOT-UPDATED", significa que a transação deu erro OU que o fluxo da transação não atualiza o ID, caso seja um erro virá acompanhado do} _{`transactionStatus`} _e _{`transactionErrorMessage`} _relacionado.

Name	Descriptiton	Observação
`businessId`	identificador único básico do seu negócio.	false
`transactionId`	identificador único da transação, fornecido pela nossa API.	false
`partnerTransactionId`	identificador único da transação, fornecido pela API do parceiro.	false
`afterPaymentId`	Identificador único da transação para conciliação e estornos.	true
`endToEndId`	Identificador único da transação para conciliação e identificação de um pagamento PIX.	true
`brCode`	Identificador único do qr code para conciliação com o que já foi enviado anteriormente, vale lembrar que esse é o PIX copia e cola.	true
`gatewayId`	Identificador único de conciliação tripla, também recebido após o pagamento do qr code, único.	true
`hashWeb3`	Identificador único de transação no blockchain.	true

Dados da transação (transactionPayload):

Sobre os campos com observação: _{Os campos marcado com observação podem ser} _`undefined` _{por não fazer parte do fluxo da transação.}

Name	Descriptiton	Observação
`userId`	identificador único fornecido pelo parceiro para identificar de usuário pagador da transação e conciliar com a base de dados do parceiro.	false
`userCpf`	cpf do pagador da transação para identificação de pagamento que foi enviado pelo parceiro.	false
`userPixKey`	identificador único da transação, fornecido pela API do parceiro.	true
`userWalletAddress`	Endereço BEP20 da carteira de recebimento do usuário nas transações que envolvem cripto.	true
`productName`	Nome do produto ou serviço.	false
`quantity`	Quantidade do produto ou serviço.	false
`unitPrice`	Preço unitário do produto ou serviço.	false
`usdtAmount`	Montante em dólares (UDST)	false
`reaisAmount`	Montante em reais (R$)	false

Name	Descriptiton
`transactionType`	Tipo da transação.
`transactionStatus`	Status da transação
`transactionErrorType`	Tipo do erro da transação.
`transactionErrorMessage`	Mensagem de erro da transação.

Claro, aqui está uma descrição breve para cada uma das tipagens, que você pode colocar antes da tabela no seu documento ou documentação: *** #### Detalhes dos status de transação. Abaixo estão os tipos utilizados para definir o status, tipo e possíveis erros relacionados a uma transação. Eles são essenciais para o controle e entendimento do fluxo de uma operação dentro do sistema. `transactionType` Define o **tipo da transação**. Pode ser: * `PIX_PURCHASE`: Ordem de compra via Pix. * `CRYPTO_PURCHASE`: Compra via cripto. * `PIX_WITHDRAW`: Ordem de saque via Pix. * `CRYPTO_WITHDRAW`: Saque via cripto. `transactionStatus` Define o **status atual da transação**. Os valores possíveis são: * `CREATED`: Transação criada. * `WAITING_PAYMENT`: Aguardando pagamento. * `PAID`: Pagamento confirmado. * `PROCESSING`: Transação em processamento. * `RETRYING`: Tentando novamente após falha. * `COMPLETED`: Transação concluída com sucesso. * `REFUNDED`: Valor reembolsado. * `ERROR`: Transação com erro. `transactionErrorType` Define o **tipo do erro ocorrido**, caso exista. Os valores possíveis são: * `NONE`: Sem erro. * `DIVERGENT_PAYER`: Pagador divergente. * `DIVERGENT_RECEIVER`: Recebedor divergente. * `BLOCKCHAIN_ERROR`: Erro relacionado à blockchain. * `TRANSACTION_NOT_FOUND`: Transação não encontrada. * `REFUNDED_BY_ERROR`: Reembolso causado por erro. * `MISSING_REFUND_USER`: Falha no reembolso após um erro. `transactionErrorMessage` Define a **mensagem descritiva do erro**, oferecendo mais contexto. Pode conter: * `NONE`: Nenhuma mensagem de erro. * `Divergent payer`: O pagador é diferente do esperado. * `Divergent receiver`: O recebedor é diferente do esperado. * `Blockchain error`: Erro na execução da transação na blockchain. * `Transaction not found`: Transação não localizada. * `Max attempts reached`: Número máximo de tentativas excedido. * `Refunded by error`: Reembolsada por conta de erro. * `Missing refund user`: Falh no reembolso após um erro ou divergência. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.criptonopix.app.br/docs/cripto-no-pix-partner-api/webhook/instrucoes.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.