Pular para o conteúdo
Criar conta ou Entrar
O logotipo da documentação da Stripe
/
Criar contaLogin
Visão geralAtualize sua integração
Pagamentos online
Visão geralEncontre seu caso de usoUsar o Managed Payments
Pagamentos presenciais
Formas de pagamento
Cenários de pagamento
Muito mais que pagamentos

Aceitar um pagamento OXXO

Veja como aceitar OXXO, uma forma de pagamento comum no México.

Cuidado

A Stripe pode apresentar automaticamente as formas de pagamento relevantes aos seus clientes avaliando moedas, restrições de formas de pagamento e outros parâmetros.

  • Siga o guia Aceitar um pagamento para elaborar uma integração de checkout que usaformas de pagamento dinâmicas.
  • Se você não quiser usar o formas de pagamento dinâmico, siga as etapas abaixo para configurar manualmente as formas de pagamento em sua integração de checkout.

O OXXO é uma forma de pagamento de uso único, que exige que o cliente siga instruções adicionais para finalizar o pagamento. Os clientes pagam em dinheiro apresentando uma guia OXXO com um número gerado em uma loja de conveniência OXXO.

Verificar a compatibilidade

Uma sessão do Checkout precisa cumprir todas as condições a seguir para aceitar pagamentos com OXXO:

  • Os preços de todos os produtos incluídos no checkout precisam estar na mesma moeda. Se você tiver produtos em moedas diferentes, crie sessões do Checkout separadas para cada moeda.
  • Adicione apenas itens de linha cujas vendas sejam avulsas (isto é, não são aceitos planos de assinatura recorrentes).

Aceitar um pagamento

Nota

Crie uma integração para aceitar um pagamento com o Checkout antes de usar este guia.

Isto orienta você na ativação da OXXO e mostra as diferenças entre aceitar pagamentos usando formas de pagamento dinâmicas e configurar manualmente as formas de pagamento.

Habilitar OXXO como forma de pagamento

Ao criar uma sessão do Checkout, é preciso:

  1. Acrescentar oxxo à lista de payment_method_types.
  2. Verifique se todos os line_items usam a moeda mxn.
Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price_data][currency]"=mxn \
  -d "line_items[0][price_data][product_data][name]"=T-shirt \
  -d "line_items[0][price_data][unit_amount]"=2000 \
  -d "line_items[0][quantity]"=1 \
  -d mode=payment \
  -d "payment_method_types[0]"=card \
  -d "payment_method_types[1]"=oxxo \
  --data-urlencode success_url="https://example.com/success"

Outras opções de forma de pagamento

Você pode especificar o parâmetro opcional expires_after_days nas opções da forma de pagamento para o Session, definindo o número de dias corridos após os quais uma guia OXXO vence. Por exemplo: se você criar uma guia OXXO na segunda-feira e a configuração de expires_after_days for 2, a guia vencerá na quarta-feira, às 23h59, horário da América/Mexico_City (UTC-6). O parâmetro expires_after_days pode ser de 1 a 7 dias. O padrão é 3 dias.

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "line_items[0][price_data][currency]"=mxn \
  -d "line_items[0][price_data][product_data][name]"=T-shirt \
  -d "line_items[0][price_data][unit_amount]"=2000 \
  -d "line_items[0][quantity]"=1 \
  -d mode=payment \
  -d "payment_method_options[oxxo][expires_after_days]"=2 \
  -d "payment_method_types[0]"=card \
  -d "payment_method_types[1]"=oxxo \
  --data-urlencode success_url="https://example.com/success"

Redirecionar para a interface de guias da Stripe

Depois de enviar corretamente o formulário do Checkout, o cliente é redirecionado para hosted_voucher_url. O cliente pode encontrar o código de barras ou imprimir a guia OXXO nessa página. O hosted_voucher_url fica em payment_intent.next_action.oxxo_display_details.

A Stripe permite personalizar as IUs exibidas para seus clientes na página Configurações da marca. As seguintes definições de marca podem ser aplicadas à guia:

  • Ícone: a imagem de sua marca e nome fantasia da empresa
  • Cor de destaque: usada como a cor do botão Imprimir
  • Cor da marca: usada como cor de fundo

Executar seus pedidos

Como o OXXO é uma forma de pagamento de notificação posterior, é preciso usar um método como webhooks para monitorar o status do pagamento e gerenciar a execução de pedidos. Saiba como configurar webhooks e executar pedidos.

Os seguintes eventos são enviados quando há mudança no status do pagamento:

Nome do eventoDescriçãoPróximas etapas

checkout.session.completed

O cliente enviou o formulário do Checkout. A Stripe gerou a guia OXXO.

Você pode enviar o link do hosted_voucher_url por e-mail, para o caso de o cliente perder a guia OXXO.

Espere que o cliente pague a guia OXXO.

checkout.session.async_payment_succeededO cliente pagou a guia OXXO corretamente. O status do PaymentIntent muda para succeeded.Execute o pedido de mercadorias ou serviços do cliente.
checkout.session.async_payment_failedA guia OXXO venceu ou o pagamento não foi concluído. O PaymentIntent retorna para o status de requires_payment_method.Entre em contato com o cliente por e-mail e solicite a realização de um novo pedido.

Teste sua integração

Para testar a integração do Checkout, selecione OXXO como forma de pagamento e clique em Pagar.

E-mailDescrição

{any_prefix}@{any_domain}

Simula uma guia OXXO paga pelo cliente depois de 3 minutos, com o webhook payment_intent.succeeded recebido depois de cerca de 3 minutos. Em produção, este webhook chega em 1 dia útil.

Exemplo: fulano@test.com

{any_prefix}succeed_immediately@{any_domain}

Simula uma guia OXXO paga imediatamente pelo cliente, com o webhook payment_intent.succeeded recebido depois de alguns segundos. Em produção, este webhook chega em 1 dia útil.

Exemplo: succeed_immediately@test.com

{any_prefix}expire_immediately@{any_domain}

Simula uma guia OXXO que vence sem ser paga pelo cliente, com o webhook payment_intent.payment_failed recebido depois de alguns segundos.

O campo expires_after em next_action.oxxo_display_details está configurado para o horário atual, independente da configuração do parâmetro expires_after_days em opções de forma de pagamento.

Exemplo: expire_immediately@test.com

{any_prefix}expire_with_delay@{any_domain}

Simula uma guia OXXO que vence sem ser paga pelo cliente, com o webhook payment_intent.payment_failed recebido depois de 3 minutos.

O campo expires_after em next_action.oxxo_display_details está configurado para 3 minutos no futuro, independente da configuração do parâmetro expires_after_days em opções de forma de pagamento.

Exemplo: expire_with_delay@test.com

{any_prefix}fill_never@{any_domain}

Simula uma guia OXXO que expira sem ser paga pelo cliente, com o webhook payment_intent.payment_failed recebido depois de 1 dia e 2 dias corridos. Em produção, este webhook chega no mesmo momento que no modo de teste.

Exemplo: fill_never@test.com

OpcionalEnviar e-mails de instruções de pagamento

Você pode habilitar e-mails com instruções de pagamento OXXO na página Configurações de e-mail no Dashboard. Após a habilitação, a Stripe envia e-mails com instruções de pagamento após a confirmação do PaymentIntent. Os e-mails contêm o número OXXO e um link para a página da guia hospedada na Stripe.

Nota

Em ambientes de teste, os e-mails de instruções só são enviados para endereços de e-mail vinculados à conta Stripe.

Veja também