v1
latestOpenAPI 3.1.02026-07-261420929.5 KBCobrança Direta
Cobrança simples via boleto ou cartão de crédito. Para mais informações sobre cobrança direta
Request body
Apenas suporta "bank_slip", que é boleto bancário. Não é preenchido se enviar parâmetro token
ID do Token. Não é preenchido caso o método de pagamento seja bank_slip. O token é de uso único — Se já tiver sido utilizado numa cobrança, mesmo que a chamada tenha sido mal sucedida, deve-se criar um novo token. Em caso de Marketplace, é possível enviar um token criado pela conta mestre.
<a href="https://dev.iugu.com/reference#criar-forma-de-pagamento">ID da Forma de Pagamento do Cliente</a>. Em caso de Marketplace, é possível enviar um "customer_payment_method_id" de um Cliente criado pela conta mestre (não é preenchido caso Método de Pagamento seja "bank_slip" ou utilize "token")
Se true, restringe o método de pagamento da cobrança para o definido em method, que no caso será apenas bank_slip.
ID do Cliente. Utilizado para vincular a Fatura a um Cliente
ID da Fatura a ser utilizada para pagamento
E-mail do Cliente (não é preenchido caso seja enviado um "invoice_id")
Número de Parcelas (2 até 12), não é necessário passar 1. Não é preenchido caso o método de pagamento seja "bank_slip". O valor mínino de cada parcela é de R$5,00.
Valor de desconto, em centavos, aplicado sobre os itens criados em caso de não haver fatura vinculada à chamada.
Define o prazo em dias para o pagamento do boleto. Caso não seja enviado, aplica-se o prazo padrão de 3 dias corridos.
Por padrão, a fatura é cancelada caso haja falha na cobrança, a não ser que este parâmetro seja enviado como "true". Obs: Funcionalidade disponível apenas para faturas criadas no momento da cobrança.
Informações do cliente abaixo "payer" são obrigatórias para a emissão de boletos ou necessárias para seu sistema de antifraude.
Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura.
Altera a descrição da cobrança no cartão de crédito do cliente final (Até 12 caracteres). Caso não seja enviado, será utilizada a descrição configurada na conta.
Response
200