Pular para o conteúdo principal
Nesta página

Campanhas de parcelamento transformam as regras do comerciante em opções de pagamento que a DEUNA pode exibir para um pedido específico e cartão. Uma campanha não cobra o cliente diretamente. Ela define os termos elegíveis; o checkout recupera esses termos e o pedido envia a opção exata selecionada pelo cliente.

O que é uma campanha de parcelamento?#

Uma campanha é um conjunto de regras de elegibilidade e preços, definido pelo comerciante. No DEUNA Admin, você escolhe o tipo de campanha, a moeda, o período de validade, os provedores de pagamento, os termos de parcelamento e as regras de marca de cartão. Cada regra de marca de cartão pode definir um valor mínimo e máximo por parcela e a taxa ou custo do comerciante aplicável.

No checkout, a DEUNA combina a campanha com o contexto de pagamento em tempo real. Uma opção é retornada somente quando as condições relevantes forem atendidas.

Contexto da campanha ou pagamentoComo isso afeta o resultado
Comerciante, loja, status e datasA campanha deve pertencer ao comerciante, aplicar-se à loja do pedido, estar ativa e estar dentro do seu período de validade. Uma campanha sem sobreposição de loja aplica-se a all.
MoedaA moeda da opção da campanha deve corresponder à moeda do pedido.
Marca do cartãoA DEUNA determina a marca a partir do BIN fornecido ou armazenado e aplica a regra de marca correspondente.
Faixa de valores por parcelaO valor calculado de cada parcela deve atender ao mínimo e, opcionalmente, ao máximo configurados para esse período e marca.
Provedor de pagamentoPelo menos um processador configurado na campanha deve ser elegível para o pagamento.
Restrições de roteamentoO roteamento inteligente ou dinâmico pode remover processadores ou termos de parcelamento que não são válidos para a rota selecionada.

De campanha para pagamento#

Diagrama de sequência
1Merchant in DEUNAAdmin2Merchant checkout3DEUNA4ShopperConfigure and activate MSI or MCIcampaignGet installments for order+ BIN or card IDMatch campaign, card,amount, provider, androuteApplicable options withplan_option_idShow returned labels and amountsSelect one optionPurchase with installments+ exact plan_option_id
DEUNAComerciante ou cliente

Para DEUNA Widgets, a experiência de checkout suportada recupera e apresenta as opções aplicáveis. Para uma integração direta via API, seu checkout recupera, exibe os valores retornados e envia a seleção com o Purchase V2.

1. Configure uma campanha#

Abra Configuração de parcelas no DEUNA AdminUm usuário precisa ter permissão para visualizar campanhas de parcelamento; criar, editar, ativar ou desativar requer a permissão correspondente de edição.

  1. Escolha MSI ou MCINomeie a campanha e confirme sua moeda.
  2. Defina uma data de início e fim opcional, ou deixe a campanha sem um período de validade fixo.
  3. Selecione um ou mais provedores de pagamento compatíveis.
  4. Adicione os termos de parcelamento à oferta.
  5. Para cada termo, habilite as marcas de cartão e configure o intervalo e a taxa ou o custo por parcela.
  6. Salve e ative a campanha.

O suporte do provedor, os acordos comerciais e a configuração da conta determinam quais processadores aparecem. Confirme os requisitos não suportados ou específicos do mercado com seu Gerente de Contas Técnico da DEUNA (TAM).

2. Obtenha as opções aplicáveis#

Use o token de pedido e um BIN de cartão para obter as opções para um novo cartão. Um fluxo de cartão armazenado pode usar seu identificador de cartão suportado. Como a elegibilidade depende do pedido, uma jornada API direta que exibe parcelamentos antes do pagamento precisa de um token de pedido.

curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/transactions/orders/ORDER_TOKEN/installments?bin=411111' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: YOUR_MERCHANT_ID'

Veja Listar opções de parcelamento para o contrato completo.

A opção retornada contém os valores que o checkout deve exibir e preservar:

JSON
{
  "installments": [
    {
      "installments": 6,
      "installments_amount": 16667,
      "display_installments_amount": "MXN 166.67",
      "installment_rate": 0,
      "display_installment_label": "6 payments of MXN 166.67 without interest",
      "plan_option_id": "a4756a5f-7f9b-414d-8712-e3a9da2be337",
      "installment_total_amount": 100000,
      "display_installment_total_amount": "MXN 1,000.00"
    }
  ]
}

Os valores são expressos na menor unidade da moeda. Use os campos de exibição para a comunicação com o cliente quando forem retornados, e mantenha os campos numéricos para cálculos e reconciliação.

3. Envie a opção selecionada#

Enviar tanto valores do mesmo item de resposta:

  • payment_source.card_info.installments: o número de parcelas selecionado.
  • payment_source.card_info.installment.plan_option_id: o ID exato dessa opção selecionada.
JSON
{
  "order_token": "ORDER_TOKEN",
  "payer_info": {
    "email": "customer@example.com"
  },
  "payment_source": {
    "method_type": "credit_card",
    "card_info": {
      "card_id": "CARD_ID",
      "installments": 6,
      "installment": {
        "plan_option_id": "a4756a5f-7f9b-414d-8712-e3a9da2be337"
      }
    }
  }
}

O número e o ID devem descrever a mesma opção. A DEUNA usa o ID da opção para recuperar o plano resolvido e os processadores elegíveis, e usa a contagem de parcelas no pedido enviado através da conexão selecionada.

Continuar com Criar pagamento para o contrato completo de Compra V2.

Lista de verificação de implementação#

  • Mostre apenas as opções retornadas para o contexto de pedido e cartão atual.
  • Preserve plan_option_id com seu valor correspondente installments value.
  • Para MCI, mostre o total financiado e o valor da parcela antes da confirmação.
  • Recupere as opções novamente quando o valor do pedido, a moeda, o cartão ou o contexto de pagamento relevante mudarem.
  • Trate uma lista de opções vazia como "nenhuma opção de campanha elegível", e não como uma falha de pagamento.
  • Teste com cartões e provedores de pagamento aprovados para a campanha configurada.

Nesta seção