> For the complete documentation index, see [llms.txt](https://docs.barte.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.barte.com/changelog/readme.md).

# Changelog

Comunicação de atualizações e melhorias.

### Novembro, 2026

![12 Nov](https://img.shields.io/badge/12%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Links de Pagamento](https://img.shields.io/badge/Links%20de%20Pagamento-686E7A?style=flat\&color=686E7A)

#### Links de pagamento criados pela API passam a abrir no novo checkout

* O campo `url` retornado ao criar, atualizar, buscar e listar links de pagamento passa a apontar para `https://pay.barte.com/payment-link/{uuid}` (no sandbox, `https://sandbox-pay.barte.com/payment-link/{uuid}`). Antes, apontava para `https://checkout.barte.com/payment-link/{uuid}`.
* O formato do campo não muda, e os links já enviados aos clientes continuam funcionando.
* Se a sua integração valida o domínio da URL do link, inclua o novo domínio.

Os guias de [link de pagamento pontual](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/links-de-pagamento/link-de-pagamento-pontual) e [link de pagamento recorrente](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/links-de-pagamento/link-de-pagamento-recorrente) foram atualizados.

***

![10 Nov](https://img.shields.io/badge/10%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Cobrança com cartão salvo é recusada quando o emissor não permite nova tentativa

* Uma cobrança iniciada pelo vendedor com o cartão salvo passa a ser recusada com `BAR-7996`, "O emissor não permite nova tentativa com este cartão", quando o banco emissor recusou uma cobrança anterior daquele cartão para o mesmo comprador indicando que não aceita novas tentativas, e nenhuma cobrança foi aprovada depois. Isso vale para o pedido com `storedCredential.initiator` `MERCHANT`, para a renovação de assinatura e para as parcelas seguintes de um pedido parcelado.
* A cobrança é recusada sem ser enviada ao banco. Para voltar a cobrar esse cartão, faça uma nova cobrança com o cliente presente; se ela for aprovada, as cobranças iniciadas pelo vendedor voltam a ser aceitas.

A tabela de [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) e o guia [Cobranças com cartão salvo](https://docs.barte.com/guias/pedidos-e-cobrancas/cobrancas-com-cartao-salvo-stored-credential) foram atualizados.

***

![10 Nov](https://img.shields.io/badge/10%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Cobranças com cartão salvo passam a declarar o uso do cartão

* O `storedCredential` do `POST /v2/orders` ganha o campo opcional `usage`: `FIRST` para a primeira cobrança, que estabelece a série, e `USED` para as cobranças que usam uma série já estabelecida. Sem `usage`, a Barte deriva o uso pela combinação de `initiator` e `reason`, como antes.
* O `reason` ganha o valor `CARD_ON_FILE`, para a compra com o cartão salvo e o portador presente.
* A resposta passa a trazer `charges[].storedCredential.usage`, com a classificação da Barte para a cobrança: `MERCHANT` vem sempre como `USED`, e `CARDHOLDER` vem como `FIRST` quando estabelece a série ou como `USED` na compra com o cartão salvo (`CARD_ON_FILE` ou `usage: USED`). O campo aparece também em cobranças criadas antes.
* `usage` fora da lista passa a retornar `400 PAYMENT-0500`. Antes, o campo era ignorado.
* `CARD_ON_FILE` só é aceito com `initiator` `CARDHOLDER` e sem `usage: FIRST`; nas outras combinações a API retorna `400 BAR-0500`.

O guia [Cobranças com cartão salvo](https://docs.barte.com/guias/pedidos-e-cobrancas/cobrancas-com-cartao-salvo-stored-credential) e a referência de [Criar Pedido](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido) foram atualizados.

***

![10 Nov](https://img.shields.io/badge/10%20Nov-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Documentação do storedCredential e do cartão salvo alinhada ao que a API faz

A API não mudou; a documentação passou a descrever o que ela faz hoje:

* O `storedCredential` (`initiator` e `reason`) aparece em `charges[]` na criação, na busca e na listagem de pedidos e na busca de cobrança.
* Com `card.cardToken`, o `cvv` é opcional: envie quando o portador está presente e não envie em cobrança `MERCHANT`.
* `RECURRING` é periodicidade fixa, com valor fixo ou variável, e não só cobrança de valor fixo.

As referências de [Criar Pedido](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido), [Buscar Pedido](https://docs.barte.com/api-reference/pedidos-e-cobrancas/buscar-pedido), [Listar Pedidos](https://docs.barte.com/api-reference/pedidos-e-cobrancas/listar-pedidos), [Criar Pedido com Token do Cartão](https://docs.barte.com/api-reference/tokenizacao-de-cartao-one-buy-click/criar-pedido-com-token-do-cartao) e [Buscar Cobrança](https://docs.barte.com/api-reference/pedidos-e-cobrancas/cobrancas/buscar-cobranca) e o guia de [pedido com cartão tokenizado](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-cartao-tokenizado) foram atualizados.

***

![06 Nov](https://img.shields.io/badge/06%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Cobrança com cartão salvo é recusada quando a primeira cobrança do cartão foi recusada

* Uma cobrança iniciada pelo vendedor com o cartão salvo passa a ser recusada com `BAR-7995`, "A primeira cobrança deste cartão foi recusada", quando a primeira cobrança daquele cartão para o mesmo comprador foi recusada pelo banco emissor e nenhuma outra foi aprovada depois. Isso vale para o pedido com `storedCredential.initiator` `MERCHANT`, para a renovação de assinatura e para as parcelas seguintes de um pedido parcelado.
* A cobrança é recusada sem ser enviada ao banco. Para voltar a cobrar esse cartão, refaça a primeira cobrança com o cliente.

A tabela de [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) foi atualizada.

***

![06 Nov](https://img.shields.io/badge/06%20Nov-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Plano de Taxas](https://img.shields.io/badge/Plano%20de%20Taxas-686E7A?style=flat\&color=686E7A)

#### Plano de taxas exige os canais de crédito online, POS e tap

A documentação de criar e atualizar plano de taxas passa a dizer o que a API já exigia. Não houve mudança de comportamento.

* Em `credit`, os três canais (`online`, `pos` e `tap`) são obrigatórios e cada um aparece uma única vez, mesmo que o vendedor não use POS ou tap. Para um canal sem uso, repita as taxas do `online`. Sem um dos canais, a requisição é recusada com `BAR-3011` "Canal obrigatório ausente".
* Com `receiptType` `TIMELINE`, o `delayForRedeem` de cada canal de crédito deve ser `30`. O exemplo da requisição trazia `1` no `online` e foi corrigido.

As referências de [Criar Plano de Taxas](https://docs.barte.com/api-reference/intermediador-de-pagamentos/plano-de-taxas-beta/criar-plano-de-taxas) e [Atualizar Plano de Taxas](https://docs.barte.com/api-reference/intermediador-de-pagamentos/plano-de-taxas-beta/atualizar-plano-de-taxas) foram atualizadas.

***

![05 Nov](https://img.shields.io/badge/05%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Terminais POS](https://img.shields.io/badge/Terminais%20POS-686E7A?style=flat\&color=686E7A)

#### Vendedor bloqueado ou sem permissão para transacionar não recebe mais terminal

* O `POST /physical-payments/payfac/v1/terminals/configure` passa a recusar o vínculo quando o vendedor informado está bloqueado ou sem permissão para transacionar (inativo ou em somente leitura). O serial volta em `errors` com `BAR-PP-23` e o terminal não é alterado: se já estava com outro vendedor, continua com ele.
* O `GET /physical-payments/payfac/v1/sellers` deixa de listar esses vendedores, e eles não entram em `totalElements`.

As referências de [Vincular Terminais a um Vendedor](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-terminais-pos/vincular-terminais) e [Listar Vendedores e Terminais Vinculados](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-terminais-pos/listar-vendedores-e-terminais) foram atualizadas.

***

![05 Nov](https://img.shields.io/badge/05%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Recusas de 3DS passam a dizer por que a autenticação não foi concluída

* Desafio que expira ou que o comprador cancela no banco passa a recusar com `BAR-7994`, "A autenticação 3DS não foi concluída a tempo", o mesmo código do pedido cancelado depois de 12 minutos. A `description` traz o motivo do banco, por exemplo `(transStatus: N, reason: EXPIRED_TIMEOUT)`. Antes, esses casos vinham como `BAR-7068`.
* Recusas `BAR-7068` sem `transStatus` passam a trazer o motivo na `description`: `AUTHENTICATION_TECHNICAL_FAILURE` para falha técnica ao autenticar e `SESSION_*` quando a sessão 3DS já foi usada ou não pertence ao pedido, por exemplo `(reason: SESSION_ALREADY_USED)`.

O guia de [pedido com 3DS](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-3ds-3d-secure) foi atualizado.

***

![05 Nov](https://img.shields.io/badge/05%20Nov-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Pedido cancelado por desafio 3DS não concluído passa a informar o motivo

Quando o comprador não conclui o desafio 3DS em 12 minutos, o pedido e a cobrança passam a `CANCELED`, como antes. Agora a cobrança cancelada traz o `failureReason` com o código `BAR-7994`, "A autenticação 3DS não foi concluída a tempo", no `GET /v2/orders/{uuid}` e na consulta da cobrança. Antes, o cancelamento vinha sem motivo. Cobranças canceladas por outros motivos continuam sem `failureReason`.

O guia de [pedido com 3DS](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-3ds-3d-secure) e [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) foram atualizados.

***

![04 Nov](https://img.shields.io/badge/04%20Nov-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Transações](https://img.shields.io/badge/Transa%C3%A7%C3%B5es-686E7A?style=flat\&color=686E7A)

#### Consulta de transações de um vendedor responde 503 quando está ocupada

O `GET /v2/seller/{sellerId}/transactions` passa a atender em fila as consultas que chegam ao mesmo tempo. Quando a espera na fila passa do limite, a API responde `503 BAR-3023` com o header `Retry-After`, em segundos. Antes, nesse cenário, a consulta podia terminar em `500` depois de cerca de 30 segundos.

* **503 BAR-3023**: aguarde o tempo do `Retry-After` e repita a mesma requisição.

A [referência do endpoint](https://docs.barte.com/api-reference/intermediador-de-pagamentos/financeiro/consultar-transacoes-de-um-vendedor) e [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) foram atualizados.

***

### Outubro, 2026

![30 Out](https://img.shields.io/badge/30%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Prazo de estorno de cartão no novo fluxo passa a ser de 365 dias

O `POST /v2/charges/{uuid}/refunds` passa a aceitar estorno de cartão de crédito, cartão de débito, Google Pay e Apple Pay até 365 dias após o pagamento. Antes, o limite era de 180 dias e o pedido fora dele recebia `400 BAR-0434`. O prazo do PIX continua em 90 dias.

A [referência do endpoint](https://docs.barte.com/api-reference/estorno/estorno-cobranca-novo-fluxo) e o guia de [estorno parcial de um pedido](https://docs.barte.com/guias/passo-a-passo-do-vendedor/3o-pos-pagamento/estorno-parcial-de-um-pedido) foram atualizados.

***

![29 Out](https://img.shields.io/badge/29%20Out-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Chave de idempotência reutilizada com outro pedido passa a responder 409

Ao repetir o `POST /v2/orders` com uma `x-idempotency-key` já usada, mas com valor, parcelas, meio de pagamento ou comprador diferentes, a API agora responde `409 BAR-0475`. Antes, ela devolvia o pedido antigo como se fosse o novo, e o pedido novo nunca era criado. Nada é cobrado.

* **409 BAR-0475**: use uma `x-idempotency-key` nova para criar um pedido diferente. Para repetir o mesmo pedido, mande os mesmos dados com a mesma chave.

A [referência do endpoint](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido) e [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) foram atualizados.

***

![28 Out](https://img.shields.io/badge/28%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Documentação de 3DS alinhada ao que a API devolve

A API não mudou; a documentação passou a descrever o que ela devolve hoje.

* **Nome do objeto de 3DS na resposta**: os guias citavam `threeDSResponse`, que a API não devolve. Na criação do pedido (`POST /v2/orders`) o objeto se chama `three3DSSecure`; na consulta (`GET /v2/orders/{uuid}`), `threeDSSecure`.
* **Sessão 3DS**: a resposta de sucesso é `200`, e o `providerType` passa a ser descrito como identificador interno, que a integração não deve usar.
* **Desafio 3DS**: não existe endpoint de desafio. A página passou a descrever o fluxo real: enviar o comprador ao `auth.stepUrl` com o `auth.token` no campo `JWT`, a volta ao `redirectURL` sem o resultado e a consulta pelo webhook ou pelo `GET` do pedido. Também documenta o cancelamento do desafio não concluído em 12 minutos (`order.canceled`).
* **Campos e erros**: só os campos de `threeDSecure.browser` são exigidos pela validação, `mpi.challenged` é booleano e os erros seguem os códigos `BAR-xxxx`.

Veja o [guia de pedido com 3DS](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-3ds-3d-secure).

***

![28 Out](https://img.shields.io/badge/28%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Recusas da autenticação 3DS passam a trazer o motivo na descrição

Os códigos não mudam; a `description` do erro ganha, entre parênteses no fim, o motivo da recusa.

* **BAR-1808 com campos apontados pelo provedor**: quando os dados da autenticação 3DS eram recusados e o provedor apontava os campos com problema em lista, o pedido respondia `500` com erro interno (`PAYMENT-9999`). Agora responde `400 BAR-1808`, com os campos na descrição, por exemplo `O banco emissor recusou os dados de autenticação 3DS enviados (formato inválido) (threeDSecure2.cardHolder.email is required)`. Corrija os campos indicados e tente novamente: repetir com os mesmos dados repete o erro.
* **BAR-7068 e BAR-1808 com o resultado da autenticação**: quando o emissor não autentica o cartão, a descrição passa a trazer o `transStatus` do 3DS (padrão EMV 3DS), por exemplo `Não foi possível validar a autenticação do cartão (transStatus: N)`. `N` é autenticação negada, `R` é recusa do emissor e `U` é autenticação indisponível. A descrição vale também para o `failureReason` da cobrança na consulta do pedido.

Os códigos estão no [guia de pedido com 3DS](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-3ds-3d-secure) e em [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro).

***

![27 Out](https://img.shields.io/badge/27%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Comprador com endereço incompleto passa a responder 400

Ao criar um comprador (`POST /v2/buyers`) com `address` sem `country`, `state`, `city`, `district` ou `street`, a resposta era `500 BAR-9999` ("Erro interno") e o comprador não era criado. Agora a resposta é `400 BAR-0500`, indicando o campo que faltou. O comprador continua não sendo criado; o que mudou é a resposta.

`zipCode`, `number` e `complement` seguem opcionais. O `address` inteiro também continua opcional.

A [referência do endpoint](https://docs.barte.com/api-reference/compradores/criar-comprador) passou a marcar os campos obrigatórios do endereço.

***

![27 Out](https://img.shields.io/badge/27%20Out-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Repetir a criação de pedido durante o processamento do cartão passa a responder 409

Ao repetir o `POST /v2/orders` com a mesma `x-idempotency-key` enquanto o pagamento com cartão da primeira requisição ainda está em processamento, a API agora responde `409 BAR-0472` na hora, em vez de aguardar a primeira terminar. Nada é cobrado de novo.

* **409 BAR-0472**: repita com a mesma `x-idempotency-key` em alguns segundos. Quando o processamento terminar, você recebe o pedido, em qualquer status.

A [referência do endpoint](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido) e [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) foram atualizados.

***

![27 Out](https://img.shields.io/badge/27%20Out-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Cancelar durante o processamento do cartão passa a responder BAR-0470

Ao cancelar um pedido (`DELETE /v2/orders/{uuid}`) ou uma cobrança (`DELETE /v2/charges/{uuid}`) enquanto o pagamento com cartão dela ainda está em processamento, a API agora responde `400 BAR-0470` e nada é alterado. Isso evita cancelar um pedido no mesmo instante em que o cartão está sendo cobrado.

* **BAR-0470**: o processamento leva poucos segundos. Tente cancelar de novo; se o cartão foi aprovado, o cancelamento responde conforme o novo status do pedido.

O código está em [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro) e nas referências de [Cancelar Pedido](https://docs.barte.com/api-reference/pedidos-e-cobrancas/cancelar-pedido) e [Cancelar Cobrança](https://docs.barte.com/api-reference/pedidos-e-cobrancas/cobrancas/cancelar-cobranca).

***

![22 Out](https://img.shields.io/badge/22%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Erro de dado na autenticação 3DS passa a responder BAR-1808

Quando o banco emissor recusa os dados da autenticação 3DS por formato inválido, antes de avaliar o cartão, o pedido respondia `400 BAR-7068` ("Não foi possível validar a autenticação do cartão"), o mesmo código de quando o banco não autentica o comprador. Agora esse caso responde `400 BAR-1808` ("Erro na autenticação 3DS"), e o BAR-7068 fica só para a recusa do banco.

* **BAR-1808**: confira os dados do navegador enviados em `threeDSecure.browser`. Repetir com os mesmos dados repete o erro.
* **BAR-7068**: o comprador pode refazer a autenticação com o banco ou usar outro cartão.

Os códigos estão no [guia de pedido com 3DS](https://docs.barte.com/guias/passo-a-passo-do-vendedor/2o-criando-pedidos-or-links-de-pagamento-or-assinaturas/pedidos/pedido-com-3ds-3d-secure) e em [Códigos de Erro](https://docs.barte.com/guias/inicio/codigos-de-erro).

***

![21 Out](https://img.shields.io/badge/21%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A)

#### Repetir a criação de pedido com a mesma chave devolve o pedido, mesmo durante o processamento

Ao repetir o `POST /v2/orders` com a mesma `x-idempotency-key` enquanto a primeira requisição ainda estava em processamento, a repetição esperava a primeira terminar e respondia `400 BAR-1600` ("Erro de integridade de dados"), mesmo com o pedido criado e pago. Agora ela devolve o pedido criado pela primeira requisição, sem nova cobrança. A cobrança nunca era feita duas vezes; o que mudou é a resposta.

* **Sem resposta (timeout ou erro de rede)**: repita com a mesma `x-idempotency-key`. Você recebe o pedido real, em qualquer status.
* **Chave nova** só para uma nova tentativa de pagamento, depois de uma falha definitiva. Repetir com chave nova cria outro pedido e pode cobrar de novo.
* **Tamanho**: a chave aceita até 36 caracteres. Recomendamos UUID v4.

A [referência do endpoint](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido) foi atualizada com a descrição do header.

***

![21 Out](https://img.shields.io/badge/21%20Out-212121?style=flat) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Webhook de pedido online passa a trazer o cartão em `cards`

Pedidos e assinaturas criados via API com o cartão informado em `payment.card` passam a enviar o cartão usado no campo `cards` do webhook de pedido, com titular, bin, últimos 4 dígitos, bandeira e validade. Antes o campo podia vir vazio (`[]`). O formato do webhook não muda.

A estrutura do campo está nos [campos do Webhook v2](https://docs.barte.com/guias/webhooks/webhooks-overview/webhook-v2-visao-geral/webhook-v2-campos), em `eventData.cards`.

***

![19 Out](https://img.shields.io/badge/19%20Out-212121?style=flat) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Webhook de pedido de maquininha passa a trazer o cartão em `cards`

Pedidos feitos na maquininha (POS) passam a enviar o cartão usado no campo `cards` do webhook de pedido, com titular, bin, últimos 4 dígitos e bandeira. Antes o campo vinha vazio (`[]`). A maquininha não informa a validade do cartão, então `expirationMonth` e `expirationYear` vêm como `""`. O formato do webhook não muda.

O [webhook de pedidos](https://docs.barte.com/guias/webhooks/pedidos-orders-e-assinaturas-subscriptions) ganhou um exemplo do campo `cards`.

No Webhook v2, o campo vem em `eventData.cards`. Os [campos do Webhook v2](https://docs.barte.com/guias/webhooks/webhooks-overview/webhook-v2-visao-geral/webhook-v2-campos) passaram a documentar o `cards`, com exemplo no pedido de maquininha.

***

![16 Out](https://img.shields.io/badge/16%20Out-212121?style=flat) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Cobranças](https://img.shields.io/badge/Cobran%C3%A7as-686E7A?style=flat\&color=686E7A)

#### `startDate` de pedidos e assinaturas é no horário de Brasília

O `startDate` do `POST /v2/orders` e do `POST /v2/subscriptions` é uma data no horário de Brasília (America/Sao\_Paulo). A data de hoje cobra na hora, e uma data futura agenda a cobrança. Se o seu sistema usa UTC por padrão, converta para o horário de Brasília antes de enviar: depois das 21h, a data UTC já é o dia seguinte e o pedido fica agendado em vez de cobrado. A regra não mudou: a documentação passou a deixar isso explícito.

* **Pedido**: para cobrar na hora, envie a data de hoje em Brasília ou não envie o campo.
* **Assinatura**: o `startDate` é obrigatório e define a data da primeira cobrança.

A [referência de criar pedido](https://docs.barte.com/api-reference/pedidos-e-cobrancas/criar-pedido) e os guias de pedido e assinatura foram atualizados.

***

![14 Out](https://img.shields.io/badge/14%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Pedido com pré-captura só fica pré-autorizado depois da autorização

Pedidos criados com `capture: false` passam a nascer com status `SENT` e vão para `PRE_AUTHORIZED` quando a cobrança é de fato pré-autorizada. Antes, o pedido já nascia `PRE_AUTHORIZED` e o webhook `order.pre_authorized` podia chegar antes da autorização: no 3DS com desafio, a captura falhava e nenhum webhook avisava quando a pré-autorização ficava disponível.

* **Webhooks**: o pedido passa a gerar `order.sent` na criação, seguido de `order.pre_authorized` quando a cobrança é pré-autorizada, igual ao fluxo com `capture: true` (`order.sent` seguido de `order.paid`).
* **3DS com desafio**: o `order.pre_authorized` só é enviado depois que o comprador conclui a autenticação. Enquanto isso, o pedido fica `SENT` e pode ser cancelado.
* **Desafio concluído depois do cancelamento automático**: se o pedido foi cancelado por desafio não concluído e o comprador conclui a autenticação depois, a cobrança fica pré-autorizada e o pedido volta para `PRE_AUTHORIZED`, com um novo `order.pre_authorized`. Capture ou cancele a pré-autorização normalmente.
* **Resposta da criação**: sem desafio, o `POST /v2/orders` continua retornando o pedido `PRE_AUTHORIZED`.

A [explicação da pré-captura](https://docs.barte.com/guias/pedidos-e-cobrancas/como-funciona-a-pre-captura) foi atualizada.

***

![13 Out](https://img.shields.io/badge/13%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Atualizar vendedor aceita o domínio CHARGE nos webhooks

O `PATCH /v2/seller` passa a aceitar `CHARGE` (Transação) em `webhooks[].domains`, para receber os eventos `charge.refund.*` do novo fluxo de estorno. Os domínios aceitos são `ORDER`, `SUBSCRIPTION` e `CHARGE`, e `CHARGE` exige `version` `"2.0"`.

Também mudou o tratamento de erro:

* **Domínio inválido** passa a retornar HTTP 400. Antes, na criação, o domínio era descartado sem aviso.
* **Webhook que não pôde ser salvo** passa a aparecer como erro na resposta. Antes a resposta podia vir com sucesso trazendo os dados antigos.

A [referência do endpoint](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-vendedores/atualizar-conta-e-webhooks-de-um-vendedor) foi atualizada com o campo `domains`.

***

![01 Out](https://img.shields.io/badge/01%20Out-212121?style=flat) ![Fix](https://img.shields.io/badge/Fix-F59E0B?style=flat\&color=F59E0B) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Cobranças](https://img.shields.io/badge/Cobran%C3%A7as-686E7A?style=flat\&color=686E7A)

#### Captura de pré-autorização devolve o resultado real em mais casos

A captura (`POST /v2/charges/{uuid}/capture`) continua respondendo HTTP 200 e informando o resultado em `status` e `retryable`. Dois casos passam a refletir o que de fato aconteceu:

* **Autorização expirada na adquirente**: a cobrança passa a voltar `CANCELED` com `retryable: false`. Antes voltava `PRE_AUTHORIZED` com `retryable: true`, e novas tentativas falhavam de novo.
* **Cobrança já capturada**: quando uma tentativa anterior já tinha capturado o valor, a resposta passa a ser `PAID` com `retryable: false`. Antes voltava `PRE_AUTHORIZED`.
* **Pagamento já cancelado**: quando a pré-autorização já tinha sido cancelada no provedor, a resposta passa a ser `CANCELED` com `retryable: false`. Antes voltava `PRE_AUTHORIZED` com `retryable: true`.

Os campos e os códigos HTTP não mudam. A [descrição das respostas possíveis](https://docs.barte.com/guias/pedidos-e-cobrancas/como-funciona-a-pre-captura) foi atualizada.

***

### Setembro, 2026

![28 Set](https://img.shields.io/badge/28%20Set-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Transações](https://img.shields.io/badge/Transa%C3%A7%C3%B5es-686E7A?style=flat\&color=686E7A)

#### Busca de pedido informa o motivo da recusa e recusas 3DS ganham código próprio

A busca de pedido (`GET /v2/orders/{uuid}`) passou a devolver `failureReason` em cada cobrança com `status` `FAILED`, com o mesmo conteúdo que a busca de cobrança (`GET /v2/charges/{uuid}`) já devolve:

```json
{
  "charges": [{
    "status": "FAILED",
    "failureReason": {
      "code": "BAR-7068",
      "title": "three_ds_authentication_failed",
      "description": "Não foi possível validar a autenticação do cartão",
      "action": "Refaça a autenticação com seu banco ou utilize outro cartão"
    }
  }]
}
```

Além disso, três motivos de recusa que antes caíam em `BAR-7005` (erro genérico) passam a ter código próprio na tabela de [Códigos de Erro](https://github.com/barte-project/barte-docs/tree/main/guides/inicio/codigos-de-erro.md), tanto no erro 400 da criação quanto no `failureReason` das buscas:

* comprador não passou na autenticação 3DS → `BAR-7068`
* autenticação 3DS indisponível para o cartão → `BAR-7951` (novo)
* cartão que não aceita transação internacional → `BAR-7021`

O campo é adicionado à response e não altera nada de quem já integra. Nenhum código existente muda de significado ou de mensagem.

***

![24 Set](https://img.shields.io/badge/24%20Set-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Transações](https://img.shields.io/badge/Transa%C3%A7%C3%B5es-686E7A?style=flat\&color=686E7A)

#### Novos códigos de erro para cobranças de cartão

Adicionamos 8 códigos novos à tabela de [Códigos de Erro](https://github.com/barte-project/barte-docs/tree/main/guides/inicio/codigos-de-erro.md): `BAR-7068` (autenticação 3DS, já em produção e agora documentado) e `BAR-7922`, `BAR-7930`, `BAR-7945`, `BAR-7970`, `BAR-7991`, `BAR-7992` e `BAR-7993`, que cobrem motivos de recusa que antes caíam em `BAR-7005` (erro genérico).

Nenhum código existente muda de significado ou de mensagem — esta é uma adição pura ao catálogo público.

***

![10 Set](https://img.shields.io/badge/10%20Set-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Assinatura de Webhook com HMAC-SHA256

Os webhooks da Barte passam a suportar assinatura digital via HMAC-SHA256. O recurso é opcional e retrocompatível — quem não configurar continua recebendo webhooks normalmente.

Para ativar, basta informar `generateSecret: true` (geração automática) ou um `secret` próprio de 32 a 64 caracteres no cadastro do webhook via `POST /v2/seller`. Quando configurado, cada entrega passa a incluir três novos headers: `X-Webhook-Timestamp`, `X-Webhook-Nonce` e `X-Webhook-Signature`, que permitem verificar a autenticidade e integridade do payload recebido.

O secret é exibido uma única vez, no momento da criação. Nas consultas subsequentes, a API retorna apenas um preview com os 5 primeiros caracteres.

Veja como implementar a verificação no seu sistema: [Assinatura de Webhook (HMAC-SHA256)](https://docs.barte.com/guias/webhooks/assinatura-de-webhook)

***

![09 Set](https://img.shields.io/badge/09%20Set-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Estorno](https://img.shields.io/badge/Estorno-686E7A?style=flat\&color=686E7A)

#### Novo endpoint de estorno de cobrança

O estorno de cobrança passou a ter um endpoint próprio, que atende **cartão de crédito e PIX**, aceita estorno **total ou parcial** e processa de forma **assíncrona**: o `202 Accepted` confirma que a Barte aceitou o pedido, não que o dinheiro já voltou ao comprador.

A resposta devolve o estorno recém-criado, com o `uuid` que identifica aquele estorno específico nos webhooks e no array `refunds[]` da cobrança — o que importa quando há vários estornos parciais na mesma cobrança.

A criação aceita o header opcional `x-idempotency-key`: reenviar a mesma chave para a mesma cobrança devolve o estorno já criado em vez de duplicar. Recomendado para proteger contra retentativas de rede.

Detalhes, códigos de erro e exemplos em [Estornar Cobrança](https://docs.barte.com/api-reference/estorno/estorno-cobranca-novo-fluxo).

***

![09 Set](https://img.shields.io/badge/09%20Set-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Cobranças](https://img.shields.io/badge/Cobran%C3%A7as-686E7A?style=flat\&color=686E7A) ![Webhooks](https://img.shields.io/badge/Webhooks-686E7A?style=flat\&color=686E7A)

#### Estornos agora são identificáveis na consulta de cobrança e no webhook

Cada item de `refunds` na consulta de cobrança passou a informar:

* `uuid` — identificador do estorno, o mesmo que aparece no webhook, para correlacionar os dois;
* `createdAt` — data e hora de criação do estorno, em UTC;
* `idempotencyKey` — a chave enviada no header `x-idempotency-key` ao criar o estorno, quando houver.

O objeto de estorno do webhook v2 de cobrança também passou a trazer o `idempotencyKey`, permitindo reconciliar o evento com o pedido que originou a operação sem depender de identificador nosso.

Os campos são adicionais e nenhum comportamento existente mudou. Uma observação sobre o campo `date`, que continua igual: ele informa a **última atualização** do estorno e muda quando ele sai de `PROCESSING` — para a data em que o estorno foi criado, use `createdAt`.

Estornos criados antes de o identificador existir não trazem `uuid`, e estornos criados sem chave de idempotência não trazem `idempotencyKey` — em ambos os casos o campo é omitido, nunca nulo.

***

### Agosto, 2026

![31 Ago](https://img.shields.io/badge/31%20Ago-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Cobranças](https://img.shields.io/badge/Cobran%C3%A7as-686E7A?style=flat\&color=686E7A)

#### Consulta de cobrança agora informa o motivo da recusa

A busca de cobrança (`GET /v2/charges/{uuid}`) passou a devolver o campo `failureReason` quando a cobrança está com `status` `FAILED`, com o motivo da recusa informado pelo provedor:

```json
{
  "status": "FAILED",
  "failureReason": {
    "code": "BAR-7006",
    "title": "insufficient_funds",
    "description": "Saldo Insuficiente",
    "action": "Verifique com seu banco emissor se há limite suficiente no cartão. Após, tente novamente"
  }
}
```

O conteúdo é o mesmo que a criação de cobrança já devolve no erro 400, então quem trata recusa nos dois fluxos passa a ler a mesma informação em ambos.

Antes, recusas confirmadas de forma assíncrona — caso típico de cartão com autenticação 3DS, em que a recusa chega depois da resposta da criação — só informavam `status: FAILED`, sem motivo. Com isso dá para distinguir saldo insuficiente de suspeita de fraude, cartão inválido ou falha na autenticação, e decidir se vale retentar, pedir outro cartão ou orientar o cliente final.

O campo é adicionado à response e não altera nada de quem já integra. Ele é omitido quando a cobrança não está recusada, e também quando a tentativa recusada não tem motivo informado pelo provedor.

***

### Julho, 2026

![17 Jul](https://img.shields.io/badge/17%20Jul-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Pedidos](https://img.shields.io/badge/Pedidos-686E7A?style=flat\&color=686E7A)

#### Campo title de pedidos agora aceita 255 caracteres

O campo `title` da criação de pedidos (`POST /v2/orders`) passou a aceitar até **255 caracteres**. O limite anterior era de 60.

A mudança já está disponível em Sandbox e Produção e não exige nenhuma ação de quem já integra: títulos com até 60 caracteres continuam funcionando exatamente como antes.

Com isso, sellers que enviam nomes de produto padronizados — e-commerces e marketplaces, por exemplo — deixam de ter pedidos recusados por exceder o limite do campo. O novo tamanho também vale para o `title` retornado nas responses de pedidos e cobranças.

***

### Março, 2026

![02 Mar](https://img.shields.io/badge/02%20Mar-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-20B356?style=flat\&color=20B356) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Sellers](https://img.shields.io/badge/Sellers-686E7A?style=flat\&color=686E7A)

#### Atualização importante sobre Webhooks na API de Sellers

Clientes que utilizam o campo `webhook` devem iniciar a migração para o novo array `webhooks`.

O campo `webhook` foi oficialmente depreciado e será mantido temporariamente apenas para não quebrar integrações existentes. A nova estrutura permite múltiplos webhooks por seller, com controle de eventos (`domains`), status (`active`) e identificador único (`uuid`).

As responses de `POST`, `GET` e `PATCH` já retornam o array `webhooks` em Sandbox e Produção.

Novas integrações devem utilizar exclusivamente `webhooks`. O campo `webhook` poderá ser removido em versões futuras da API. Veja mais detalhes em: [Alterações nos Endpoints de Sellers – Sandbox e Produção](https://docs.barte.com/guias/alteracoes/alteracoes-nos-endpoints-de-sellers-sandbox-e-producao.md)

***

### Janeiro, 2026

![03 Fev](https://img.shields.io/badge/03%20Fev-212121?style=flat) ![Breaking Change](https://img.shields.io/badge/Breaking%20Change-E11D48?style=flat\&color=E11D48) ![API](https://img.shields.io/badge/API-686E7A?style=flat\&color=686E7A) ![Transações](https://img.shields.io/badge/Transa%C3%A7%C3%B5es-686E7A?style=flat\&color=686E7A)

#### Atualização importante sobre Early Buyer

Clientes que utilizam o recebimento no fluxo de tempo (timeline) não podem mais realizar transações via Early Buyer.

O Early Buyer é um produto baseado em cálculo de juros e antecipação, o que não se aplica a operações em timeline.\
Manter esse cruzamento gerava inconsistências operacionais.

Tentativas de uso do Early Buyer na API de sellers em operações com timeline resultarão em erro.\
Não há impacto para clientes que já operam fora do fluxo de timeline.

***

### Dezembro, 2025

![17 Dez](https://img.shields.io/badge/17%20Dez-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-22c55e?style=flat\&logoColor=white\&color=22c55e) ![API](https://img.shields.io/badge/API-6B7280?style=flat) ![Extrato](https://img.shields.io/badge/Extrato-6B7280?style=flat\&logoColor=white\&color=6B7280)

#### Atualização – API de Extrato

A partir de **17/12/2025**, o endpoint **GET /v2/report/statement** passará a incluir um novo campo - uuid - em cada objeto retornado no array de resposta. Esse identificador único foi adicionado para facilitar o tratamento individual dos itens do extrato. [Ver mais detalhes](https://docs.barte.com/guias/alteracoes/api-de-extrato-nova-propriedade-uuid.md).

***

### Outubro, 2025

![29 Out](https://img.shields.io/badge/29%20Out-212121?style=flat) ![Feature](https://img.shields.io/badge/Feature-22c55e?style=flat\&logoColor=white\&color=22c55e) ![API](https://img.shields.io/badge/API-6B7280?style=flat)

#### Novos campos no objeto de Cobranças (Charges)

A partir do dia **29 de outubro de 2025**, dois novos campos "acquirerAuthorizationCode" e "acquirerAuthorizationNsu" serão retornados no objeto da cobrança (Charge) em ambiente de Sandbox. Veja mais informações sobre os endpoints afetados: [Ver mais detalhes](https://docs.barte.com/guias/alteracoes/codigo-de-autorizacao-e-codigo-nsu.md).

***

![15 Out](https://img.shields.io/badge/15%20Out-212121?style=flat) ![Refactor](https://img.shields.io/badge/Refactor-22c55e?style=flat\&logoColor=white\&color=22c55e) ![API](https://img.shields.io/badge/API-6B7280?style=flat) ![Sellers](https://img.shields.io/badge/Sellers-6B7280?style=flat\&logoColor=white\&color=6B7280)

#### Atualização na API de Vendedores

No dia 15/10/2025, os endpoints da Sellers API v2 (POST, GET e PATCH) passaram a exigir novos campos obrigatórios.\
As alterações já estão em vigor nos ambientes de Sandbox e Produção. Veja mais na referência de cada um: [Criar Vendedor](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-vendedores/criar-vendedor.md) | [Buscar Vendedor](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-vendedores/buscar-vendedores.md) | [Atualizar dados bancários do Vendedor](https://docs.barte.com/api-reference/intermediador-de-pagamentos/gerencie-seus-vendedores/atualizar-conta-e-webhooks-de-um-vendedor.md)

***

### Setembro, 2025

<div align="left"><img src="https://img.shields.io/badge/25%20Set-212121?style=flat" alt=""> <img src="https://img.shields.io/badge/Feature-22c55e?style=flat&#x26;logoColor=white&#x26;color=22c55e" alt=""> <img src="https://img.shields.io/badge/Portal%20do%20Intermediador-6B7280?style=flat" alt=""> <img src="https://img.shields.io/badge/Estorno-6B7280?style=flat&#x26;logoColor=white&#x26;color=6B7280" alt=""></div>

#### Transações elegíveis para estorno

Agora, o usuário poderá consultar se uma transação é elegível ou não para um estorno parcial ou total acessando seus detalhes no portal do intermediador. Para saber mais, acesse o Portal do Intermediador.

***

<div align="left"><img src="https://img.shields.io/badge/25%20Set-212121?style=flat" alt=""> <img src="https://img.shields.io/badge/Feature-22c55e?style=flat&#x26;logoColor=white&#x26;color=22c55e" alt=""> <img src="https://img.shields.io/badge/SDK%20Web-6B7280?style=flat" alt=""> <img src="https://img.shields.io/badge/Wallet%20-%20Google%20e%20Apple%20Pay-6B7280?style=flat&#x26;logoColor=white&#x26;color=6B7280" alt=""></div>

#### Melhoria na lógica com o SDK Web

Antes, era preciso fazer as ações separadamente, como criar sessão, comprador (buyer) e pedido (order). Com essa nova alteração, esse fluxo foi abstraído em uma única chamada, centralizando a lógica e simplificando a integração. Veja mais dentro da seção de SDK.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.barte.com/changelog/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
