# Guia Nexus

- [Guia Nexus](https://nexus-docs.ticto.dev/index.md): Do sandbox à primeira venda: kickoff técnico de integração com a API Nexus (Ticto).
- [Visão geral](https://nexus-docs.ticto.dev/guia/visao-geral.md): Uma API REST, quatro domínios.
- [Autenticação e restrição de origem](https://nexus-docs.ticto.dev/guia/autenticacao.md): mTLS no transporte, dois tokens na sessão.
- [Setup dos ambientes](https://nexus-docs.ticto.dev/guia/ambientes.md): Sandbox primeiro, produção na virada.
- [Autenticar cliente](https://nexus-docs.ticto.dev/guia/autenticar-cliente.md): Troca o client_id e o token do cadastro pelo client_token usado em todas as demais rotas.
- [Criar usuário (produtor)](https://nexus-docs.ticto.dev/guia/criar-usuario.md): Usado para provisionar um novo usuário no ecossistema Ticto via API.
- [Criar produto](https://nexus-docs.ticto.dev/guia/criar-produto.md): A oferta pertence a um produto. Sem product_hash não há oferta, e sem oferta não há checkout.
- [Criar oferta do produto](https://nexus-docs.ticto.dev/guia/criar-oferta.md): Obrigatório para definir preços e métodos de pagamento antes de realizar uma venda.
- [Tokenizar cartão](https://nexus-docs.ticto.dev/guia/tokenizacao-cartao.md): Como obter o card_code exigido pelo checkout com cartão de crédito sem que o número do cartão passe pelo seu servidor.
- [Processar checkout (venda)](https://nexus-docs.ticto.dev/guia/checkout.md): Gera uma transação financeira na Ticto.
- [Webhooks / retornos assíncronos](https://nexus-docs.ticto.dev/guia/webhooks.md): Seus sistemas sincronizados em tempo real.
- [Validação de identidade e segurança](https://nexus-docs.ticto.dev/guia/kyc-e-tokenizacao.md): KYC via Idwall, cartão só tokenizado.
- [Afiliação](https://nexus-docs.ticto.dev/regras/afiliacao.md): Regras de negócio, endpoints e fluxos do programa de afiliados via Nexus API.
- [Autenticar cliente](https://nexus-docs.ticto.dev/api-reference/autenticação/autenticar-cliente.md): Autentica o cliente e retorna um token de acesso.
- [Configurar cliente](https://nexus-docs.ticto.dev/api-reference/configurações-do-cliente/configurar-cliente.md): Define configurações do cliente para receber notificações via webhook.
- [Testar recebimento de webhook](https://nexus-docs.ticto.dev/api-reference/configurações-do-cliente/testar-recebimento-de-webhook.md): Endpoint de teste para validar o envio de webhooks. Registra o payload recebido internamente para fins de depuração. Útil para verificar se as configurações de webhook do cliente estão funcionando corretamente.
- [Criar usuário](https://nexus-docs.ticto.dev/api-reference/usuários/criar-usuário.md): Registra um novo usuário no sistema
- [Buscar usuário por e-mail](https://nexus-docs.ticto.dev/api-reference/usuários/buscar-usuário-por-e-mail.md): Busca um usuário pelo endereço de e-mail. Retorna apenas usuários vinculados ao cliente autenticado.
- [Visualizar usuário](https://nexus-docs.ticto.dev/api-reference/usuários/visualizar-usuário.md): Retorna os dados gerais de um usuário pelo Hash
- [Excluir usuário](https://nexus-docs.ticto.dev/api-reference/usuários/excluir-usuário.md): Remove um usuário do sistema
- [Atualizar usuário](https://nexus-docs.ticto.dev/api-reference/usuários/atualizar-usuário.md): Atualiza os dados de um usuário no sistema.
- [Onboarding de usuário](https://nexus-docs.ticto.dev/api-reference/onboarding-de-usuário/onboarding-de-usuário.md): Inicia o processo de KYC (Know Your Customer) do usuário autenticado.
- [Listar contas bancárias](https://nexus-docs.ticto.dev/api-reference/contas-bancárias/listar-contas-bancárias.md): Retorna todas as contas bancárias do usuário autenticado.
- [Criar conta bancária](https://nexus-docs.ticto.dev/api-reference/contas-bancárias/criar-conta-bancária.md): Cria uma nova conta bancária para o usuário autenticado.
- [Visualizar conta bancária](https://nexus-docs.ticto.dev/api-reference/contas-bancárias/visualizar-conta-bancária.md): Retorna os dados de uma conta bancária específica
- [Atualizar conta bancária](https://nexus-docs.ticto.dev/api-reference/contas-bancárias/atualizar-conta-bancária.md): Atualiza os dados de uma conta bancária existente.
- [Excluir conta bancária](https://nexus-docs.ticto.dev/api-reference/contas-bancárias/excluir-conta-bancária.md): Remove uma conta bancária do sistema
- [Listar faixas de taxa](https://nexus-docs.ticto.dev/api-reference/faixas-de-taxa/listar-faixas-de-taxa.md): Retorna as faixas de taxa personalizadas do usuário autenticado, ordenadas por valor mínimo.
- [Histórico de alterações de taxas](https://nexus-docs.ticto.dev/api-reference/faixas-de-taxa/histórico-de-alterações-de-taxas.md): Retorna o histórico de alterações nas faixas de taxa do usuário autenticado, ordenado do mais recente para o mais antigo.
- [Cotar frete](https://nexus-docs.ticto.dev/api-reference/frete/cotar-frete.md): Calcula o frete para uma oferta específica baseado no CEP de destino.
- [Criar checkout](https://nexus-docs.ticto.dev/api-reference/financeiro/criar-checkout.md): Cria um novo checkout para processamento de pagamento.
- [Consultar reembolso da transação](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-reembolso-da-transação.md): Retorna os dados do reembolso associado à transação informada
- [Solicitar reembolso (assíncrono)](https://nexus-docs.ticto.dev/api-reference/financeiro/solicitar-reembolso-assíncrono.md): Solicita um reembolso para uma transação específica. A operação é processada de forma assíncrona — o endpoint retorna `202 Accepted` imediatamente com o header `Location` apontando para o endpoint de consulta de status.
- [Consultar status da operação de reembolso](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-status-da-operação-de-reembolso.md): Retorna o status atual da operação assíncrona de reembolso.
- [Consultar histórico de saques](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-histórico-de-saques.md): Retorna o histórico paginado de saques da conta do usuário autenticado, do mais recente para o mais antigo (mesma listagem exibida na aba "Histórico de Saques" do painel). Saques arquivados não são retornados. O resultado é cacheado por 10 minutos por conta/filtros.
- [Solicitar saque](https://nexus-docs.ticto.dev/api-reference/financeiro/solicitar-saque.md): Solicita um saque para a conta bancária do usuário.
- [Visualizar saque](https://nexus-docs.ticto.dev/api-reference/financeiro/visualizar-saque.md): Retorna os dados de um saque específico. Use o campo `code` retornado na criação do saque (POST) como parâmetro da rota.
- [Consultar saldo](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-saldo.md): Retorna o saldo atual do usuário autenticado
- [Consultar extrato financeiro](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-extrato-financeiro.md): Retorna o extrato financeiro paginado do usuário autenticado, contendo o saldo consolidado (no mesmo formato de `/financial/balance`), a lista de eventos financeiros (vendas, reembolsos, antecipações, saques, etc.) e os metadados de paginação. O resultado é cacheado por 10 minutos por usuário/conta/…
- [Consultar gráfico do extrato](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-gráfico-do-extrato.md): Retorna os dados de gráfico do extrato financeiro do usuário autenticado, sumarizando os valores por período. O resultado é cacheado por 10 minutos por conta/filtros.
- [Solicitar exportação de extrato](https://nexus-docs.ticto.dev/api-reference/financeiro/solicitar-exportação-de-extrato.md): Solicita a exportação assíncrona do extrato financeiro em um formato específico (ex.: CSV, PDF). A operação retorna um hash para consultar o status da exportação.
- [Consultar exportação de extrato](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-exportação-de-extrato.md): Consulta o status de uma exportação de extrato previamente solicitada. Retorna o status atual (`processing`, `completed`, `failed`) e, quando concluída, a URL para download do arquivo.
- [Consultar agenda de recebíveis](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-agenda-de-recebíveis.md): Retorna a agenda de recebíveis do usuário autenticado: os valores pendentes agrupados pela data em que serão liberados (`available_at`), somados em centavos. É uma visão simplificada e complementar ao extrato (`/financial/account-statement`): responde "quanto será liberado e quando", já refletindo r…
- [Consultar histórico de antecipações](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-histórico-de-antecipações.md): Retorna o histórico paginado de antecipações da conta do usuário autenticado, da mais recente para a mais antiga (mesma listagem exibida na aba "Histórico de Antecipações" do painel). O resultado é cacheado por 10 minutos por conta/filtros.
- [Consultar extrato financeiro consolidado](https://nexus-docs.ticto.dev/api-reference/financeiro/consultar-extrato-financeiro-consolidado.md): Retorna o extrato financeiro paginado no mesmo formato apresentado na aba "Extrato Financeiro" do painel do vendedor: cada movimentação traz a descrição do lançamento já traduzida (ex.: "Comissão de Produtor", "Reembolso", "Saque"), a natureza da operação (`credit`/`debit`/`neutral`), a data de libe…
- [Calcular antecipação](https://nexus-docs.ticto.dev/api-reference/financeiro/calcular-antecipação.md): Calcula os cenários (above/below) para antecipação de recebíveis.
- [Confirmar antecipação](https://nexus-docs.ticto.dev/api-reference/financeiro/confirmar-antecipação.md): Confirma uma antecipação previamente calculada (cenário above ou below).
- [Visualizar fatura](https://nexus-docs.ticto.dev/api-reference/financeiro/visualizar-fatura.md): Retorna a fatura de um pedido específico
- [Listar assinaturas do usuário](https://nexus-docs.ticto.dev/api-reference/financeiro/listar-assinaturas-do-usuário.md): Retorna todas as assinaturas (ativas e canceladas) do usuário autenticado. Os dados são consultados diretamente no banco local, sem dependência de serviços externos.
- [Buscar assinatura por código](https://nexus-docs.ticto.dev/api-reference/financeiro/buscar-assinatura-por-código.md): Retorna uma assinatura específica do usuário autenticado pelo código.
- [Cancelar assinatura](https://nexus-docs.ticto.dev/api-reference/financeiro/cancelar-assinatura.md): Cancela uma assinatura do usuário autenticado
- [Atualizar método de pagamento da assinatura](https://nexus-docs.ticto.dev/api-reference/financeiro/atualizar-método-de-pagamento-da-assinatura.md): Atualiza o método de pagamento de uma assinatura
- [Atualizar dia de cobrança da assinatura](https://nexus-docs.ticto.dev/api-reference/financeiro/atualizar-dia-de-cobrança-da-assinatura.md): Atualiza o melhor dia de cobrança da assinatura
- [Listar PIX Automático do usuário](https://nexus-docs.ticto.dev/api-reference/pix-automático/listar-pix-automático-do-usuário.md): Retorna os mandatos de PIX Automático das assinaturas em que o usuário do token `Authorization: Bearer` é o **assinante** (`subscriptions.user_id`), do mais recente para o mais antigo.
- [Detalhar PIX Automático da assinatura](https://nexus-docs.ticto.dev/api-reference/pix-automático/detalhar-pix-automático-da-assinatura.md): Retorna o mandato de PIX Automático vinculado à assinatura, lido do banco da Ticto.
- [Consultar status do PIX Automático](https://nexus-docs.ticto.dev/api-reference/pix-automático/consultar-status-do-pix-automático.md): Retorna o estado atual do mandato de PIX Automático, consultado no Payments da Ticto. Traz campos que o detalhe não traz, como `cancelled_at`, `last_retry_at` e `subscription_canceled_at`.
- [Cancelar PIX Automático](https://nexus-docs.ticto.dev/api-reference/pix-automático/cancelar-pix-automático.md): Cancela a assinatura e revoga o mandato de PIX Automático no gateway que o emitiu. Depois disso não há novos débitos.
- [Solicitar nova tentativa de cobrança](https://nexus-docs.ticto.dev/api-reference/pix-automático/solicitar-nova-tentativa-de-cobrança.md): Pede uma nova tentativa de cobrança de um PIX Automático que falhou. Vale só para mandatos em `failed` ou `denied` de assinaturas que não foram canceladas.
- [Listar produtos](https://nexus-docs.ticto.dev/api-reference/produtos/listar-produtos.md): Retorna a lista de produtos do cliente
- [Criar produto](https://nexus-docs.ticto.dev/api-reference/produtos/criar-produto.md): Cria um novo produto no sistema.
- [Listar categorias](https://nexus-docs.ticto.dev/api-reference/produtos/listar-categorias.md): Retorna a lista de categorias de produtos disponíveis
- [Visualizar produto](https://nexus-docs.ticto.dev/api-reference/produtos/visualizar-produto.md): Retorna os dados de um produto específico
- [Atualizar produto](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-produto.md): Atualiza os dados de um produto existente.
- [Excluir produto](https://nexus-docs.ticto.dev/api-reference/produtos/excluir-produto.md): Remove um produto do sistema
- [Listar afiliados do produto](https://nexus-docs.ticto.dev/api-reference/produtos/listar-afiliados-do-produto.md): Retorna a lista de afiliados associados a um produto
- [Adicionar afiliados ao produto](https://nexus-docs.ticto.dev/api-reference/produtos/adicionar-afiliados-ao-produto.md): Adiciona um ou mais afiliados a um produto específico.
- [Atualizar afiliação de produto](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-afiliação-de-produto.md): Atualiza os dados de uma afiliação existente em um produto. O campo `user_id` é preenchido automaticamente a partir da afiliação na rota — não é necessário enviá-lo no body.
- [Remover afiliado do produto](https://nexus-docs.ticto.dev/api-reference/produtos/remover-afiliado-do-produto.md): Remove um afiliado de um produto específico
- [Adicionar afiliados em lote](https://nexus-docs.ticto.dev/api-reference/produtos/adicionar-afiliados-em-lote.md): Adiciona múltiplos afiliados a um produto de forma assíncrona. Aceita uma lista de até 5.000 afiliados por requisição. Retorna um `batch_id` para consultar o status da operação.
- [Atualizar comissão de afiliados em lote](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-comissão-de-afiliados-em-lote.md): Atualiza o percentual de comissão de múltiplos afiliados de um produto. Cada afiliado na lista pode receber um percentual individual. Aceita até 5.000 afiliados por requisição.
- [Remover afiliados em lote](https://nexus-docs.ticto.dev/api-reference/produtos/remover-afiliados-em-lote.md): Remove múltiplos afiliados de um produto de forma assíncrona. Aceita uma lista de até 5.000 IDs de usuários por requisição. Retorna um `batch_id` para consultar o status da operação.
- [Consultar status de operação em lote](https://nexus-docs.ticto.dev/api-reference/produtos/consultar-status-de-operação-em-lote.md): Consulta o status de uma operação em lote de afiliados previamente solicitada. Retorna o progresso e resultado da operação.
- [Atualizar comissão de todos os afiliados](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-comissão-de-todos-os-afiliados.md): Atualiza o percentual de comissão de **todos** os afiliados de um produto para um único valor. Operação assíncrona que retorna um `batch_id`.
- [Desativar todos os afiliados](https://nexus-docs.ticto.dev/api-reference/produtos/desativar-todos-os-afiliados.md): Desativa todos os afiliados de um produto de forma assíncrona. Retorna um `batch_id` para consultar o status da operação.
- [Listar coproduções do produto](https://nexus-docs.ticto.dev/api-reference/produtos/listar-coproduções-do-produto.md): Retorna a lista de coproduções associadas a um produto
- [Adicionar coprodução ao produto](https://nexus-docs.ticto.dev/api-reference/produtos/adicionar-coprodução-ao-produto.md): Adiciona uma coprodução a um produto específico.
- [Atualizar coprodução de produto](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-coprodução-de-produto.md): Atualiza os dados de uma coprodução existente em um produto.
- [Remover coprodução do produto](https://nexus-docs.ticto.dev/api-reference/produtos/remover-coprodução-do-produto.md): Remove uma coprodução de um produto específico
- [Listar ofertas do produto](https://nexus-docs.ticto.dev/api-reference/produtos/listar-ofertas-do-produto.md): Retorna a lista de ofertas associadas a um produto
- [Criar oferta para produto](https://nexus-docs.ticto.dev/api-reference/produtos/criar-oferta-para-produto.md): Cria uma nova oferta para um produto específico.
- [Visualizar oferta](https://nexus-docs.ticto.dev/api-reference/produtos/visualizar-oferta.md): Retorna os dados de uma oferta específica
- [Atualizar oferta](https://nexus-docs.ticto.dev/api-reference/produtos/atualizar-oferta.md): Atualiza os dados de uma oferta existente.
- [Excluir oferta](https://nexus-docs.ticto.dev/api-reference/produtos/excluir-oferta.md): Remove uma oferta de um produto
- [Enviar URL de e-book para produto](https://nexus-docs.ticto.dev/api-reference/produtos/enviar-url-de-e-book-para-produto.md): Associa um e-book externo a um produto do tipo e-book por meio de uma URL hospedada no domínio de arquivos do cliente.
- [Configurar área de membros externa do produto](https://nexus-docs.ticto.dev/api-reference/produtos/configurar-área-de-membros-externa-do-produto.md): Define ou atualiza as credenciais e URL de uma área de membros externa para o produto.
- [Remover área de membros externa do produto](https://nexus-docs.ticto.dev/api-reference/produtos/remover-área-de-membros-externa-do-produto.md): Remove a configuração da área de membros externa do produto
- [Listar integrações](https://nexus-docs.ticto.dev/api-reference/integrações/listar-integrações.md): Retorna a lista de integrações do cliente
- [Criar integração](https://nexus-docs.ticto.dev/api-reference/integrações/criar-integração.md): Cria uma nova integração vinculada a um ou mais produtos do cliente.
- [Visualizar integração](https://nexus-docs.ticto.dev/api-reference/integrações/visualizar-integração.md): Retorna os dados de uma integração específica
- [Atualizar integração](https://nexus-docs.ticto.dev/api-reference/integrações/atualizar-integração.md): Atualiza os dados de uma integração existente
- [Excluir integração](https://nexus-docs.ticto.dev/api-reference/integrações/excluir-integração.md): Remove uma integração do sistema
- [user_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-usuários/user_updated.md): Disparado quando qualquer dado do usuário é alterado no sistema.
- [user_onboarded](https://nexus-docs.ticto.dev/api-reference/webhooks:-usuários/user_onboarded.md): Disparado quando o onboarding do usuário é concluído.
- [bank_account_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-contas-bancárias/bank_account_updated.md): Disparado quando uma conta bancária é atualizada.
- [bank_account_deleted](https://nexus-docs.ticto.dev/api-reference/webhooks:-contas-bancárias/bank_account_deleted.md): Disparado quando uma conta bancária é removida do sistema.
- [product_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/product_updated.md): Disparado quando um produto é atualizado.
- [product_deleted](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/product_deleted.md): Disparado quando um produto é removido do sistema.
- [product_affiliate_deleted](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/product_affiliate_deleted.md): Disparado quando um afiliado é removido de um produto.
- [product_coproducer_deleted](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/product_coproducer_deleted.md): Disparado quando um coprodutor é removido de um produto.
- [offer_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/offer_updated.md): Disparado quando uma oferta é atualizada.
- [offer_deleted](https://nexus-docs.ticto.dev/api-reference/webhooks:-produtos-e-ofertas/offer_deleted.md): Disparado quando uma oferta é removida do sistema.
- [refund_requested](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/refund_requested.md): Disparado quando um reembolso é solicitado.
- [refund_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/refund_updated.md): Disparado quando o status de um reembolso é alterado.
- [cashout_requested](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/cashout_requested.md): Disparado quando um saque é solicitado.
- [cashout_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/cashout_updated.md): Disparado quando o status de um saque é alterado.
- [anticipation_requested](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/anticipation_requested.md): Disparado quando uma antecipação de recebíveis é solicitada.
- [anticipation_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-financeiro/anticipation_updated.md): Disparado quando o status de uma antecipação é alterado.
- [fee_tier_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-faixas-de-taxa/fee_tier_updated.md): Disparado quando uma faixa de taxa de um seller é criada, atualizada ou excluída.
- [order_created](https://nexus-docs.ticto.dev/api-reference/webhooks:-pedidos/order_created.md): Disparado quando um novo pedido é criado no sistema.
- [order_item_status_changed](https://nexus-docs.ticto.dev/api-reference/webhooks:-pedidos/order_item_status_changed.md): Disparado quando o status de um item específico do pedido é alterado.
- [transaction_created](https://nexus-docs.ticto.dev/api-reference/webhooks:-cobranças/transaction_created.md): Disparado quando uma cobrança (transação) é criada para um pedido de origem Nexus.
- [transaction_updated](https://nexus-docs.ticto.dev/api-reference/webhooks:-cobranças/transaction_updated.md): Disparado quando o status de uma cobrança (transação) de origem Nexus muda.
- [subscription_cancelled](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/subscription_cancelled.md): Disparado quando uma assinatura é cancelada.
- [subscription_resumed](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/subscription_resumed.md): Disparado quando uma assinatura cancelada é reativada.
- [subscription_extended](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/subscription_extended.md): Disparado quando a próxima cobrança da assinatura é adiada.
- [subscription_overdue](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/subscription_overdue.md): Disparado quando uma assinatura entra em atraso.
- [subscription_ended](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/subscription_ended.md): Disparado quando uma assinatura chega ao fim (todas as cobranças concluídas ou encerramento definitivo).
- [charge_reminder](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/charge_reminder.md): Disparado como lembrete antes de uma cobrança recorrente.
- [trial_started](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/trial_started.md): Disparado quando um período de trial (teste gratuito) é iniciado.
- [trial_ended](https://nexus-docs.ticto.dev/api-reference/webhooks:-assinaturas/trial_ended.md): Disparado quando o período de trial (teste gratuito) termina naturalmente.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.