# CrediPay Documentation

> Documentation for CrediPay

## Guides
- [Introdução](https://docs.credipay.credix.finance/docs/getting-started-introduction.md): Entenda o que é a CrediPay, como ela funciona e por que pode ser a solução ideal de crédito para suas vendas B2B.
- [Como funciona?](https://docs.credipay.credix.finance/docs/how-does-credipay-works.md): Conheça as etapas que compõem o ciclo completo de um pedido com a CrediPay — da análise de crédito à conciliação dos pagamentos.
- [Canais de vendas: e-commerce e televendas](https://docs.credipay.credix.finance/docs/canais-de-vendas.md): Veja como a criação, confirmação e acompanhamento de pedidos varia conforme o canal de venda, e prepare sua integração de forma alinhada ao seu modelo de operação.
- [Opções de Integração](https://docs.credipay.credix.finance/docs/getting-started-integration-options.md): Conheça as formas de operar com a CrediPay — via plataforma, integração parcial ou full API — e entenda como aproveitar ao máximo a modularidade da solução.
- [Glossário](https://docs.credipay.credix.finance/docs/getting-started-glossary.md): Entenda os principais termos usados neste guia e como eles se aplicam à jornada com a CrediPay.
- [Criando sua conta no portal do vendedor](https://docs.credipay.credix.finance/docs/setting-up-the-platform.md)
- [Funcionalidades da plataforma](https://docs.credipay.credix.finance/docs/funcionalidades-da-plataforma.md)
- [Como adicionar um novo comprador](https://docs.credipay.credix.finance/docs/como-adicionar-um-novo-comprador.md)
- [Solicitar aumento de limite](https://docs.credipay.credix.finance/docs/solicitar-aumento-de-limite.md)
- [Como criar um novo pedido](https://docs.credipay.credix.finance/docs/como-adicionar-um-novo-pedido.md)
- [Aprovação do comprador](https://docs.credipay.credix.finance/docs/aprovação-do-comprador.md)
- [Envio e validação da nota fiscal](https://docs.credipay.credix.finance/docs/envio-e-validação-da-nota-fiscal.md)
- [Múltiplas Notas Fiscais por Pedido](https://docs.credipay.credix.finance/docs/multi-nf.md)
- [Emissão e visualização dos boletos](https://docs.credipay.credix.finance/docs/emissão-e-visualização-dos-boletos.md)
- [Solicitar reembolso parcial ou total](https://docs.credipay.credix.finance/docs/solicitar-reembolso-parcial-ou-total.md)
- [Gerenciar usuários da plataforma](https://docs.credipay.credix.finance/docs/gerenciar-usuários-da-plataforma.md)
- [Guia de status](https://docs.credipay.credix.finance/docs/status-guide.md)
- [Seções do dashboard](https://docs.credipay.credix.finance/docs/credipay-dashboard.md): O CrediPay Dashboard é a central de acompanhamento das suas operações.
- [Reconciliação de Desembolsos](https://docs.credipay.credix.finance/docs/reconciliação-de-desembolsos.md): Conecte cada transferência bancária recebida da CrediPay às respectivas Notas Fiscais e duplicatas que a originaram, para cruzar com o seu ERP
- [Autenticação e ambientes](https://docs.credipay.credix.finance/docs/api-usage-authentication.md): Learn how to authenticate with the CrediPay API.
- [Ciclo de vida de um pedido](https://docs.credipay.credix.finance/docs/módulos-de-integração.md)
- [Guia de Status](https://docs.credipay.credix.finance/docs/order-installment-statuses.md)
- [Etapas de integração](https://docs.credipay.credix.finance/docs/módulos-de-integração-1.md)
- [0. Criação de compradores](https://docs.credipay.credix.finance/docs/1-criação-de-compradores.md): Embora o endpoint ofereça praticidade, recomendamos sempre iniciar pela importação em massa via lista, garantindo limites mais altos logo no primeiro uso.
- [1. Criação de pedido](https://docs.credipay.credix.finance/docs/checar-e-reservar-limites-de-crédito.md)
- [2. Formalização de pedido](https://docs.credipay.credix.finance/docs/receber-confirmações-e-enviar-notas-fiscais.md): Dependência: Módulo 1. Checar e reservar limites de crédito
- [2.1. Recebimento de boletos](https://docs.credipay.credix.finance/docs/receber-boletos.md): Dependências: Módulo 1. Checar e reservar limites de crédito e Módulo 2. Receber confirmações e enviar Notas Fiscais
- [3. Pagamento de pedido](https://docs.credipay.credix.finance/docs/receber-notificações-de-repagamento.md)
- [Adicional: Solicitação de Aumento de Limite de Crédito](https://docs.credipay.credix.finance/docs/11-solicitação-de-aumento-de-limite-de-crédito.md)
- [Adicional: Reembolsos e cancelamentos](https://docs.credipay.credix.finance/docs/emitir-reembolsos-e-cancelamentos.md)
- [Adicional: Múltiplas Notas Fiscais por pedido](https://docs.credipay.credix.finance/docs/adicional-múltiplas-notas-fiscais-por-pedido.md)
- [Adicional: Reconciliação](https://docs.credipay.credix.finance/docs/adicional-reconciliação.md)
- [Webhooks](https://docs.credipay.credix.finance/docs/api-usage-webhooks.md)
- [Implementando CrediPay em minutos com IA](https://docs.credipay.credix.finance/docs/implementando-credipay-em-minutos-com-ia.md)
- [Integração Parcial](https://docs.credipay.credix.finance/docs/use-cases.md)
- [Visão geral ](https://docs.credipay.credix.finance/docs/visão-geral.md)
- [Experiência do comprador](https://docs.credipay.credix.finance/docs/experiência-do-comprador.md): Toda a experiência acontece dentro da VTEX. O comprador não sai da loja, não preenche cadastro longo e não envia documentos para comprar a prazo.
- [Configuração da integração](https://docs.credipay.credix.finance/docs/configuração-da-integração.md): A integração tem dois lados: o que se ajusta na **VTEX** e o que se ajusta no seu **ERP**. O time de Integrações CrediPay acompanha cada etapa.
- [Fluxo da operação](https://docs.credipay.credix.finance/docs/fluxo-da-operação.md): Depois de configurada, a integração roda automaticamente. Veja quem faz o quê em cada etapa, da compra ao recebimento.
- [Cancelamentos & reembolsos](https://docs.credipay.credix.finance/docs/cancelamentos-reembolsos.md)
- [Relatórios](https://docs.credipay.credix.finance/docs/relatórios.md): Junto com a integração VTEX-CrediPay, entregamos um dashboard para acompanhar as principais métricas e dados da operação. Os mesmos dados estão disponíveis por API para alimentar o seu ERP.

## API Reference
- [Obter compradores](https://docs.credipay.credix.finance/reference/buyerscontroller_getbuyers.md): Obtém todos os compradores associados a um vendedor.
- [Obter um pedido](https://docs.credipay.credix.finance/reference/orderscontroller_getorderbyid.md): Obtém um pedido pelo ID interno de pedido da CrediPay.
- [Pesquisar pedidos](https://docs.credipay.credix.finance/reference/orderscontroller_searchorders.md): Pesquisa pedidos por diversos critérios.  O parâmetro `query` aceita: - ID do pedido (UUID) - CNPJ do comprador (14 dígitos; pontos, hífens e barras são ignorados) - Nome do comprador (busca parcial) - ID externo do pedido (busca parcial) - Chave de acesso da NF-e (`NFe` + 44 dígitos, ou apenas os 44 dígitos com ou sem espaços) - Número da nota fiscal (`nNF`, até 10 dígitos — busca parcial)
- [Criar um pedido](https://docs.credipay.credix.finance/reference/orderscontroller_postorder.md): Cria um pedido enviando um payload JSON.  ### Formato dos erros Erros de validação são serializados pelo filtro global da CrediPay em duas formas: - **`CredixErrorResponse`** (uma única validação): `{ message, code, context, timestamp, path, request_id }` - **`CredixAggregateErrorResponse`** (várias validações falhando juntas): `{ message, code: "ORDER_VALIDATION_AGGREGATE_ERROR", errors: [{ message, code, context }], timestamp, path, request_id }`  O campo `code` é estável e deve ser usado pelo seu sistema como chave de identificação do erro. A mensagem em `message` permanece em inglês para evitar quebras quando a tradução evoluir.
- [Criar um pedido por NF-e](https://docs.credipay.credix.finance/reference/orderscontroller_postinvoicexml.md): Permite criar um pedido enviando um arquivo XML de Nota Fiscal. Se orderId não for informado, um novo pedido é criado. Se orderId for informado, a nota fiscal é vinculada ao pedido especificado. Para que uma nota fiscal seja aceita, ela precisa estar dentro do limite de crédito disponível do comprador e do prazo máximo de pagamento.  ### Formato dos erros Erros de validação seguem o mesmo formato de `POST /v2/orders`: `CredixErrorResponse` (uma falha) ou `CredixAggregateErrorResponse` (várias falhas, em `errors[]`). O `code` é estável e deve ser usado para o tratamento programático.  Falhas no parsing do XML da NF-e são consolidadas sob o código `NFE_PARSE_ERROR` — o detalhamento dos campos inválidos vem em `context.error.issues`.
- [Capturar pedido](https://docs.credipay.credix.finance/reference/orderscontroller_captureorder.md): Endpoint que permite enviar um arquivo XML de Nota Fiscal para um pedido existente. Assim que o arquivo XML é aceito, um job é disparado para realizar validações e capturar o pedido — parte das validações roda de forma assíncrona. Falhas síncronas (estado do pedido, lock em andamento, parsing do XML, validações internas de elegibilidade/política) retornam imediatamente nesta resposta.  ### Formato dos erros Erros seguem o mesmo formato de `POST /v2/orders`: `CredixErrorResponse` (uma falha) ou `CredixAggregateErrorResponse` (várias falhas, em `errors[]`). O `code` é estável e deve ser usado para o tratamento programático.
- [Reembolsar pedido](https://docs.credipay.credix.finance/reference/orderscontroller_refundorder.md): Este é um endpoint assíncrono que permite solicitar um reembolso de um pedido existente.
- [Cancelar pedido](https://docs.credipay.credix.finance/reference/orderscontroller_cancelorder.md): Move um pedido para o estado cancelado e aumenta o limite de crédito disponível do comprador pelo valor total desse pedido. Se o pedido já tiver uma nota fiscal vinculada, ele será totalmente reembolsado.
- [Concluir captura parcial](https://docs.credipay.credix.finance/reference/orderscontroller_completecapture.md): Conclui a captura de um pedido parcialmente capturado.
- [Buscar repasses de vendedores](https://docs.credipay.credix.finance/reference/sellerdisbursementscontroller_getsellerdisbursements.md): Este endpoint permite obter uma lista de repasses com base em parâmetros específicos. https://docs.credipay.credix.finance/docs/adicional-reconcilia%C3%A7%C3%A3o
- [Listar usuários da organização autenticada](https://docs.credipay.credix.finance/reference/userscontroller_getusers.md): Lista os usuários ativos da organização autenticada.
- [Criar usuário](https://docs.credipay.credix.finance/reference/userscontroller_createuser.md): Cria um usuário na organização autenticada.
- [Obter usuário atual](https://docs.credipay.credix.finance/reference/userscontroller_getcurrentuser.md): Retorna os dados do usuário autenticado na organização atual.
- [Atualizar usuário](https://docs.credipay.credix.finance/reference/userscontroller_updateuser.md): Atualiza um usuário ativo da organização autenticada.
- [Exclui usuário](https://docs.credipay.credix.finance/reference/userscontroller_deleteuser.md): Revoga o acesso do usuário e o remove da organização autenticada.
- [Solicitar um limite de crédito](https://docs.credipay.credix.finance/reference/credit_underwrite_request_risk_engine_credit_underwrite_request_post.md): Solicite um limite de crédito para um comprador específico pela primeira vez. Se for necessário limite adicional, use o endpoint de aumento de limite.
- [Obter uma solicitação de limite de crédito](https://docs.credipay.credix.finance/reference/get_credit_underwrite_request_risk_engine_credit_underwrite_request__creditunderwritingid__get.md): Obtenha uma solicitação de limite de crédito pelo ID (UUID)
- [Solicitar um aumento de limite de crédito](https://docs.credipay.credix.finance/reference/credit_limit_increase_request_risk_engine_credit_limit_increase_request_post.md): Solicite um aumento de limite de crédito para um comprador específico
- [Obter uma solicitação de aumento de limite de crédito](https://docs.credipay.credix.finance/reference/get_credit_limit_increase_request_risk_engine_credit_limit_increase_request__clirequestid__get.md): Obtenha uma solicitação de aumento de limite de crédito pelo ID (UUID)
- [Generate a buyer platform token](https://docs.credipay.credix.finance/reference/generate_buyer_platform_token_risk_engine_buyer_platform_buyer_token_post.md): Generate a signed JWT token for embedding the buyer platform on your website.
- [Obter vendedores vinculados à organização](https://docs.credipay.credix.finance/reference/api-v2-get-organization-sellers.md): Retorna todos os vendedores associados à organização atual.
- [Obter configuração de desembolso da organização](https://docs.credipay.credix.finance/reference/api-v2-get-disbursement-config.md): Gate org-level da UI no-anticipation: indica se a organização tem ao menos um segmento no-anticipation efetivo (flag Statsig ON + segmento configurado com estratégia diferente de OnAssetCreation).
- [Criar contato do comprador para a organização vendedora](https://docs.credipay.credix.finance/reference/api-v2-create-seller-buyer-contact.md): Adiciona um contato do comprador (email e telefone) visível apenas para a organização atual.
- [Atualizar email e telefone do contato do comprador](https://docs.credipay.credix.finance/reference/api-v2-update-seller-buyer-contact.md): Atualiza o email e o telefone de um contato do comprador da organização atual.
- [Remover contato do comprador da organização vendedora](https://docs.credipay.credix.finance/reference/api-v2-delete-seller-buyer-contact.md): Remove o contato do comprador da organização atual. Não afeta o mesmo comprador em outras organizações.
- [Obter URL de sessão do painel de webhooks](https://docs.credipay.credix.finance/reference/api-v2-get-webhook-dashboard-session-url.md): Retorna a URL e o token de sessão para acessar o painel de webhooks da organização na plataforma Svix. A URL e o token são válidos por 7 dias.
- [Reenviar webhooks com falha](https://docs.credipay.credix.finance/reference/api-v2-post-resend-failed-webhooks.md): Reenvia os webhooks que falharam em um determinado período. Mensagens enviadas com sucesso não são reenviadas. O ID do endpoint pode ser encontrado no painel de webhooks.