Habilitar métodos de pagamento via API

📘

O que você vai aprender com este artigo?

  • Métodos de pagamento disponíveis na iugu e suas características
  • Passo a passo para habilitar métodos de pagamento via painel ou API
  • Configurações avançadas para cada método, incluindo parâmetros específicos
  • Bandeiras de cartão de crédito aceitas e restrições importantes

Quais são os métodos disponíveis na iugu?

Aceitamos 3 métodos:

  • Cartão de Crédito
  • Boleto Bancário e
  • Pix

🚧

Bandeiras suportadas

As bandeiras que a iugu suporta são:

  • American Express
  • Diners
  • Elo
  • MasterCard
  • Visa

Como habilitar métodos de pagamento?

Há duas formas para isso:

  1. Via Painel
  2. Via API

Painel — passo a passo

  1. Acesse alia.iugu.com
  2. Configurações > na seção Recebimento escolha o método desejado
  3. Marque a caixa de seleção "Ativo"

API

Para cada método utilize os endpoints e seus respectivos parâmetros listados abaixo:

MétodoEndpointObjetoParâmetroInformar
Boleto BancárioConfigurar Contav1/accounts/configurationbank_slipactivetrue
Cartão de CréditoConfigurar Contav1/accounts/configurationcredit_cardactivetrue
PixConfigurar Pagamentos Pixv1/payments/pixN/Aenabletrue

📘

Chave EVP

A primeira ativação do método Pix criará uma chave EVP no Banco Central


Recursos de cada método

Cada método de pagamento conta com suas próprias características e recursos. Saiba como configurar cada um desses recursos.

Cartão de Crédito

No endpoint Configurar Contav1/accounts/configuration, com o método credit_card ativado, é possível ativar os seguintes recursos

ParâmetroDescrição
soft_descriptor*Descrição quer aparecerá na Fatura. Limitação
de 12 a 22 caracteres (a depender da adquirente)
installmentsParcelas
max_installmentsNúmero máximo de parcelas (1 a 12x)
max_installments_without_interestNúmero máximo de parcelas
sem juros
two_step_transactionTransação em Duas Etapas
installments_pass_interest*Repasse de Juros de Parcelamento

🚧

Importantes

  • installments_pass_interest: disponível para contas antigas
  • soft_descriptor: não é permitido utilizar caracteres especiais

Boleto Bancário

No endpoint Configurar Contav1/accounts/configuration, com o método bank_slip ativado, é possível ativar os seguintes recursos

DescriçãoParâmetro
Dias de Vencimento Extrasextra_due
2ª Via — Dias de Vencimento Extrasreprint_extra_due