Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en/tutorials/payments/payment-settings/mode-off-faq.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'Mode-Off: FAQ'
title: 'Contingency Mode'
id: 6hbd7PuvoxuRbPCvTqjxeB
status: PUBLISHED
createdAt: 2021-01-21T17:29:10.793Z
updatedAt: 2024-04-11T19:26:47.407Z
updatedAt: 2026-05-25T00:00:00.000Z
publishedAt: 2024-04-11T19:22:34.569Z
firstPublishedAt: 2021-01-21T17:54:12.941Z
contentType: tutorial
Expand All @@ -15,6 +15,8 @@ locale: en
subcategoryId: 3tDGibM2tqMyqIyukqmmMw
---

>>>WIP Localization>>>

Mode-off is a feature of the VTEX [Payment Provider Protocol](https://developers.vtex.com/vtex-developer-docs/docs/payment-provider-protocol).

This feature allows VTEX to track their payment partners’ health and stability, ensuring that the system will not cancel orders due to instabilities.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'Mode-Off: FAQ'
title: 'Contigency Mode'
id: 6hbd7PuvoxuRbPCvTqjxeB
status: PUBLISHED
createdAt: 2021-01-21T17:29:10.793Z
updatedAt: 2024-04-11T19:26:47.407Z
updatedAt: 2026-05-25T00:00:00.000Z
publishedAt: 2024-04-11T19:22:34.569Z
firstPublishedAt: 2021-01-21T17:54:12.941Z
contentType: tutorial
Expand All @@ -15,6 +15,8 @@ locale: es
subcategoryId: 3tDGibM2tqMyqIyukqmmMw
---

>>>WIP Localization>>>

Mode-off es una funcionalidad del [Payment Provider Protocol](https://developers.vtex.com/vtex-developer-docs/docs/payment-provider-protocol) - protocolo de integración para pagos de VTEX.

Esta funcionalidad permite que VTEX controle la salud y la estabilidad de sus partners de pagos, garantizando que no se cancelen pedidos debido a inestabilidades.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: 'Mode-Off: FAQ'
title: 'Contigency Mode'
id: 6hbd7PuvoxuRbPCvTqjxeB
status: PUBLISHED
createdAt: 2021-01-21T17:29:10.793Z
updatedAt: 2024-04-11T19:26:47.407Z
updatedAt: 2026-05-25T00:00:00.000Z
publishedAt: 2024-04-11T19:22:34.569Z
firstPublishedAt: 2021-01-21T17:54:12.941Z
contentType: tutorial
Expand All @@ -15,67 +15,196 @@ locale: pt
subcategoryId: 3tDGibM2tqMyqIyukqmmMw
---

O mode-off é um recurso do [Payment Provider Protocol](https://developers.vtex.com/vtex-rest-api/docs/payments-integration-payment-provider-protocol), o protocolo de integração para pagamentos da VTEX.
O **Contingency Mode** (anteriormente conhecido como **Mode-off**) é um recurso de resiliência do VTEX Payments que ajuda a proteger transações elegíveis durante instabilidades temporárias em provedores de pagamento.

Essa funcionalidade permite que a VTEX acompanhe a saúde e a estabilidade dos seus parceiros de pagamentos, garantindo que pedidos não sejam cancelados por conta de instabilidades.
Este artigo explica:

O mode-off funciona da seguinte forma: quando a VTEX identifica algum tipo de erro consecutivo nas integrações dos parceiros de pagamento, o status mode-off é ativado para represar as transações de cartão de crédito.
- [Como o **Contingency Mode** funciona](#como-o-contingency-mode-funciona)
- [O impacto nas transações](#impacto-nas-transações)
- [Quais meios e fluxos de pagamento podem ser afetados](#meios-de-pagamento-afetados)
- [Como funcionam a recuperação do conector e as retentativas](#recuperação-e-comportamento-de-retentativas)
- [Como identificar o **Contingency Mode**](#como-identificar-o-contingency-mode)
- [O que fazer quando o **Contigency Mode** está ativo](#o-que-fazer-quando-o-contingency-mode-está-ativo)
- [Orientações para provedores de pagamento](#orientação-para-provedores-de-pagamento)

Assim que a integração ou o parceiro apresentarem estabilidade novamente, o status mode-off é desativado e o nosso sistema começa a fazer as retentativas de processamento das transações que foram represadas.
> ℹ️ Os lojistas não precisam configurar nem ativar o **Contingency Mode** manualmente. A VTEX gerencia automaticamente a ativação, a recuperação e as retentativas de transações.

Neste artigo, reunimos as principais dúvidas sobre o funcionamento do mode-off.
## Como o Contingency Mode funciona

Confiras as questões a seguir.
O **Contingency Mode** é um mecanismo de proteção automática para conectores de pagamento. Quando a VTEX identifica falhas técnicas recorrentes em um conector, o sistema ativa esse modo para reduzir o impacto da instabilidade no processamento de pagamentos.

## Todos os parceiros têm essa funcionalidade habilitada?
Durante esse período:

Sim, todos os parceiros de pagamentos da VTEX têm o mode-off habilitado.
- Novas autorizações elegíveis deixam de ser enviadas temporariamente ao provedor.
- Novas transações elegíveis podem ser adiadas para processamento posterior.
- Transações já adiadas seguem um fluxo independente de retentativas agendadas.

## O mode-off funciona para quais meios de pagamento?
Essa proteção se aplica ao conector afetado, não à loja como um todo. Outros provedores de pagamento ou meios de pagamento que não foram afetados pela instabilidade podem continuar operando normalmente.

Apenas para os meios de pagamento que podem ser processados de forma assíncrona. Ou seja, cartão de crédito.
O ciclo de ativação e recuperação do **Contingency Mode** é separado do ciclo de retentativa das transações adiadas. Isso significa que um conector já pode ter saído de **Contingency Mode** enquanto determinadas transações ainda aguardam a próxima janela de retentativa configurada.

## O mode-off funciona para os meios de pagamento boleto, QR code ou redirect?
### Ativação

Não, esses meios de pagamento demandam uma resposta on-line e não podem ser processados de forma assíncrona.
O **Contingency Mode** é ativado quando a VTEX detecta 5 erros técnicos qualificáveis em 5 minutos para o mesmo conector.

Desse modo, para esses meios de pagamento, as transações não serão reprocessadas.
Erros técnicos qualificáveis podem incluir:

## Qual a regra atual para ligar o mode-off?
- Timeouts de requisição.
- Falhas de conexão.
- Requisições canceladas por instabilidade técnica.
- Respostas HTTP `408` de timeout.
- Erros HTTP `5xx` do provedor, como `500`, `502`, `503` ou `504`.

O mode-off é ligado quando o parceiro ou a integração apresentam instabilidade identificada a partir do retorno de mensagens de erro do tipo: 500, 408 ou timeout maior que 30 segundos nos últimos cinco minutos. Essa regra é válida para todos os meios de pagamento que ele processa.
> ℹ️ Retornos esperados do processo de autorização não ativam o **Contingency Mode**. Por exemplo, saldo insuficiente, cartão inválido, cartão expirado e pagamento não autorizado fazem parte do fluxo normal de autorização e não são considerados instabilidade do conector.

> ⚠️ Vale lembrar que os meios de pagamento síncronos **não** poderão ser reprocessados. Porém, entram na contagem de erros para identificarmos se um parceiro está instável ou não.
### Ciclo do Contingency Mode

## Qual a regra para o mode-off ser desligado?
Quando o **Contingency Mode** está ativo:

As transações serão liberadas normalmente quando o parceiro parar de apresentar a mesma taxa de cinco erros nos últimos cinco minutos.
- A VTEX marca o conector afetado como temporariamente indisponível.
- Novas requisições de autorização elegíveis não são enviadas ao provedor.
- Novas transações elegíveis podem ser adiadas para uma retentativa posterior.
- O conector permanece temporariamente indisponível até o término do período automático de recuperação.
- Os lojistas podem ver uma indicação de **Contingency Mode** nos detalhes da transação ou nos logs de pagamento.

## Por quanto tempo a VTEX faz a retentativa de processamento das transações represadas?
Esse comportamento ajuda a evitar novas chamadas a um conector instável enquanto o provedor se recupera.

O tempo entre retentativas de processamento da transação (_retries_) pode ser definido pelo parceiro no momento do envio das informações de pagamento. Ao configurar o tempo para cancelamento do pagamento (campo `delayToCancel`) para um período menor que 1 dia, as retentativas serão realizadas a cada 1 hora. Se o tempo para cancelar o pagamento for definido como igual ou maior que 1 dia, as retentativas serão realizadas a cada 4 horas. Para mais informações, acesse [Create Payment endpoint](https://developers.vtex.com/docs/api-reference/payment-provider-protocol?endpoint=post-/payments).
O diagrama a seguir mostra o ciclo de ativação e recuperação do Contingency Mode para novas autorizações:

> ℹ️ Caso o pagamento seja realizado por [PIX](/pt/docs/tutorials/configurar-pix-como-meio-de-pagamento) ou o tempo para cancelamento do pagamento seja configurado entre 5 minutos e 1 hora, as chamadas de retry ocorrerão a cada 5 minutos.
```mermaid
flowchart LR
A["Nova tentativa\nde autorização"] --> B["VTEX inicia o processo\nde autorização"]
B --> C{"Conector está em\nContingency Mode?"}
C -- "Sim" --> D["Encaminha para o fluxo\nde autorização agendada"]
C -- "Não" --> E["VTEX envia o pagamento\nao conector"]
E --> F{"Conector retornou\nerro qualificável?"}
F -- "Não" --> G["Fluxo normal\nde autorização"]
F -- "Sim" --> H["Erro qualificável\né acumulado"]
H --> I{"5 erros qualificáveis\nnos últimos 5 minutos?"}
I -- "Sim" --> J["Contingency Mode é \nativado por cerca de \n5 minutos"]
J --> K["Novas autorizações \nelegíveis deixam de ser \nenviadas ao conector"]
K --> L["Após cerca de 5 minutos,\nContingency Mode\né desativado"]
L --> M["Novas autorizações voltam\n na ser avaliadas\nnormalmente"]
```

## Como identificar o mode-off e o que fazer quando ele estiver ligado?
## Impacto nas transações

O parceiro de pagamentos passa a enxergar uma alta taxa de erros e redução no volume de pagamentos feitos com cartão.
O **Contingency Mode** não cancela pedidos por si só. As transações afetadas pelo **Contingency Mode** podem ser adiadas para uma retentativa automática posterior.

Nesse momento, é importante trabalhar para corrigir a instabilidade e tranquilizar os clientes de que os pagamentos serão processados assim que o sistema recuperar sua estabilidade.
> ℹ️ O **Contingency Mode** não substitui as regras normais de expiração e cancelamento de pagamento. Se o pagamento não puder ser autorizado antes do prazo aplicável, o pedido ainda poderá ser cancelado conforme o fluxo normal do pedido.

## Como o lojista identifica esse comportamento de instabilidade e o que ele precisa fazer?
Os clientes podem ver o pagamento como em processamento ou pendente enquanto a VTEX aguarda a próxima retentativa da autorização.

O lojista vai notar diversos pagamentos no cartão de crédito com o status de pendente, não processados.
Os lojistas devem evitar pedir aos clientes que façam um novo pedido imediatamente, a menos que o pedido original já tenha sido cancelado ou que o meio de pagamento exija uma nova ação do cliente.

O log da transação retornará o label "mode-off".
## Meios de pagamento afetados

## Uma vez que o mode-off for ligado, o lojista precisa fazer algo?
O **Contingency Mode** aplica-se a fluxos de pagamento que podem ser processados de forma assíncrona e retentados com segurança após uma instabilidade temporária no provedor.

Do lado da VTEX, não, apenas aguardar o retry.
Meios ou fluxos de pagamento que exigem uma resposta online imediata, redirecionamento do cliente ou uma nova ação do cliente podem não ser adiados e retentados da mesma forma. Nesses casos, a transação segue o comportamento padrão desse meios de pagamento.

Caso deseje, o lojista pode também entrar em contato com seu parceiro de pagamentos para entender o cenário de instabilidade.
> ℹ️ Se você não tiver certeza de que um meio de pagamento específico é elegível para o **Contingency Mode**, entre em contato com o [Suporte VTEX](https://supporticket.vtex.com/support) ou com seu provedor de pagamento.

## Onde consigo mais detalhes técnicos sobre o funcionamento do mode-off?
## Recuperação e comportamento de retentativas

Para obter informações técnicas sobre o funcionamento do mode-off, confira nossa documentação no [Developer Portal](https://developers.vtex.com/vtex-rest-api/docs/payments-integration-purchase-flows#mode-off).
A recuperação do conector é automática. Após aproximadamente 5 minutos desde o último erro qualificável, a VTEX remove o conector do **Contingency Mode** e novas autorizações elegíveis podem voltar a ser enviadas normalmente ao provedor.

A saída do **Contingency Mode** afeta apenas novas tentativas de autorização. Transações previamente adiadas seguem seu próprio fluxo de retentativa agendada.

### Retentativa de transações adiadas

Transações adiadas durante o **Contingency Mode** não são necessariamente retentadas imediatamente após a recuperação do conector.

Essas transações seguem um fluxo independente de retentativa baseado:

- Nas regras de retry do meio de pagamento.
- No tempo de cancelamento do pagamento (`delayToCancel`).
- Nas informações retornadas pelo provedor.
- Em outras condições operacionais do fluxo de pagamento.

O diagrama a seguir mostra o comportamento das autorizações agendadas:

```mermaid
flowchart LR
A[Autorização chega \nenquanto o conector \nestá em Contingency Mode] --> B[VTEX não chama o conector]
B --> C[Pagamento é enviado \npara uma fila de \nreprocessamento]
C --> D[Pagamento fica como \nautorização agendada]
D --> E[VTEX realiza automaticamente uma nova tentativa de autorização]
E --> F[VTEX inicia novamente \no processo de autorização]
F --> G{Conector está em \nContingency Mode no \nmomento da retentativa?}
G -- Sim --> C
G -- Não --> H[Pagamento segue para \no fluxo normal de \nautorização]
```

O período de recuperação do **Contingency Mode** e o intervalo de retentativa das transações são processos independentes. Assim:

- O conector pode sair do **Contingency Mode** após aproximadamente 5 minutos.
- As transações adiadas podem continuar aguardando a próxima janela de retentativa configurada para aquele fluxo de pagamento.

Esse comportamento evita novas chamadas imediatas a conectores ainda instáveis, ao mesmo tempo em que preserva as transações elegíveis para reprocessamento automático posterior.

O intervalo entre retentativas pode variar conforme:

- O meio de pagamento.
- As informações retornadas pelo provedor.
- O tempo de cancelamento do pagamento (`delayToCancel`).
- As condições operacionais do fluxo de pagamento.

Esses fatores determinam por quanto tempo a transação ainda pode ser reprocessada e qual intervalo deve ser respeitado entre uma tentativa e outra. Por isso, o tempo até a próxima retentativa não é fixo para todos os pagamentos e pode variar conforme a configuração e o contexto de cada transação.

Em geral:
Comment thread
ricardoaerobr marked this conversation as resolved.

Quando `delayToCancel` é menor que 1 dia, as retentativas geralmente ocorrem a cada 1 hora.
Quando `delayToCancel` é igual ou maior que 1 dia, as retentativas geralmente ocorrem a cada 4 horas.

Para mais informações, consulte o [Create Payment](https://developers.vtex.com/docs/api-reference/payment-provider-protocol?endpoint=post-/payments) endpoint.

> ℹ️ Embora pagamentos via [PIX](https://help.vtex.com/pt/docs/tutorials/configurar-pix-como-meio-de-pagamento) não sejam afetados pelo **Contingency Mode**, ou seja, não haja bloqueio de transações realizadas por esse meio, outros problemas podem interromper o processamento do pagamento. Nesses casos, quando o campo `delayToCancel` está configurado entre 5 minutos e 1 hora, as tentativas de retry geralmente ocorrem a cada 5 minutos.

> ⚠️ O tempo de retry pode variar conforme o meio de pagamento, as configurações da conta e as condições operacionais. A VTEX gerencia esse processo automaticamente para que as retentativas ocorram no menor intervalo possível, reduzindo o tempo de processamento da fila de transações pendentes.

## Como identificar o Contingency Mode

Os lojistas podem notar o **Contingency Mode** quando há instabilidade em um provedor de pagamento que afeta um conector específico.

Indicadores comuns incluem:

- Um número incomum de pagamentos pendentes de autorização ou processamento para o mesmo provedor.
- Logs de transação indicando **Contingency Mode** no conector afetado.
- Uma redução temporária no volume de pagamentos aprovados para um meio de pagamento ou provedor específico.
- Autorizações elegíveis sendo adiadas para retentiva posterior.

Os provedores de pagamento também podem observar mais indicadores de instabilidade na integração, como:

- Timeouts.
- Falhas de conexão.
- Erros HTTP `5xx`.

## O que fazer quando o Contingency Mode está ativo

Na maioria dos casos, nenhuma ação é necessária por parte do lojista. A VTEX protege automaticamente o fluxo de transações, reabilita o conector quando a instabilidade diminui e processa as transações elegíveis conforme as regras automáticas de retentativa.

Ações recomendadas:

1. Monitore as transações afetadas no Admin VTEX.
2. Verifique se o problema está concentrado em um provedor ou meio de pagamento específico.
3. Entre em contato com o provedor de pagamento se a instabilidade persistir ou se ele precisar investigar a integração.
4. Entre em contato com o [Suporte VTEX](https://supporticket.vtex.com/support) se as transações permanecerem pendentes por mais tempo do que o esperado ou se os clientes relatarem problemas recorrentes de pagamento.

> ⚠️ Evite cancelar ou recriar pedidos manualmente, a menos que haja uma razão comercial clara para isso, como solicitação do cliente, expiração do pedido ou confirmação de que o pagamento não pode ser concluído.

## Orientação para provedores de pagamento

Os provedores de pagamento devem investigar e resolver a instabilidade que causou as falhas técnicas recorrentes.

Verificações comuns incluem:

- Disponibilidade dos endpoints de autorização.
- Tempo de resposta e comportamento de timeout.
- Erros HTTP `5xx`.
- Conectividade de rede.
- Deploys recentes ou mudanças na infraestrutura.

Depois que o provedor se estabilizar, a VTEX remove automaticamente o conector do **Contingency Mode** e novas autorizações elegíveis podem voltar a ser enviadas normalmente.

> ℹ️ Transações previamente adiadas continuam seguindo suas regras configuradas de retentativa.
Loading