Cobrança Direta

post

https://api.iugu.com/v1/charge

Cobrança simples via boleto ou cartão de crédito. Para mais informações sobre cobrança direta

Body Params

method

string

Apenas suporta "bank_slip", que é boleto bancário. Não é preenchido se enviar parâmetro token

token

string

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.

customer_payment_method_id

string

ID da Forma de Pagamento do Cliente. 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")

restrict_payment_method

boolean

Se true, restringe o método de pagamento da cobrança para o definido em method, que no caso será apenas bank_slip.

customer_id

string

ID do Cliente. Utilizado para vincular a Fatura a um Cliente

invoice_id

string

ID da Fatura a ser utilizada para pagamento

string

E-mail do Cliente (não é preenchido caso seja enviado um "invoice_id")

months

int32

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.

discount_cents

int32

Valor de desconto, em centavos, aplicado sobre os itens criados em caso de não haver fatura vinculada à chamada.

bank_slip_extra_days

int32

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.

keep_dunning

boolean

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.

items

array of objects

Itens de cobrança da Fatura que será gerada. "price_cents" valor mínimo 100. Limite de 30 items

items

payer

object

Informações do cliente, obrigatórias para a emissão de boletos registrados ou necessárias para seu sistema de antifraude.

order_id

string

Número único que identifica o pedido de compra. Opcional, ajuda a evitar o pagamento da mesma fatura.

soft_descriptor_light

string

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.

Responses

200200

400400

422422