Antecipa imediatamente a cobrança de uma fatura através do ID.

post https://app.vindi.com.br/api/v1/bills/{id}/charge

Utilize este método para antecipar imediatamente a cobrança de uma fatura agendada (status=scheduled) ou então para cobrar um saldo devedor. Uma nova cobrança será emitida automaticamente.

Responses

Response body

object

int32

required

ID da fatura

code

string

Código externo para referência via API

amount

number

required

Valor da fatura

installments

int32

required

Número de parcelas

status

string

required

Status da fatura

review pending paid canceled scheduled

seen_at

string

required

Última visualização da fatura

billing_at

string

Data opcional de emissão da cobrança

due_at

string

Data de vencimento da fatura

url

string

required

URL para pagamento da fatura

created_at

string

required

Data e hora da geração da fatura

updated_at

string

required

Data e hora da última atualização da fatura

bill_items

array of objects

Itens da fatura.
Este atributo exibe os primeiros 25 itens.
Para os demais, consulte o método GET /bills/:id/bill_items

bill_items

object

int32

required

ID do item da fatura

amount

number

required

Valor do item da fatura

quantity

int32

Quantidade do item da fatura

pricing_range_id

int32

ID da faixa de precificação usada no cálculo do preço, se aplicável

description

string

Descrição opcional do item da fatura

pricing_schema

object

product

object

required

product_item

object

discount

object

charges

array of objects

Cobranças da fatura

charges

object

int32

required

ID da cobrança

amount

number

required

Valor da cobrança

status

string

required

Status da cobrança

pending paid canceled processing fraud_review

due_at

string

required

Data do vencimento da cobrança

paid_at

string

Data do pagamento da cobrança, apenas se a cobrança já foi paga

installments

int32

required

Número de parcelas da cobrança. Valores acima de 1 são usados apenas para parcelamento através da administradora do cartão de crédito

attempt_count

int32

Número de tentativas automáticas de cobrança já realizadas

next_attempt

int32

Data da próxima tentativa automática de cobrança

print_url

string

URL para impressão da cobrança. Usado apenas para boletos

created_at

string

required

Data e hora da geração da cobrança

updated_at

string

required

Data e hora da última atualização da cobrança

last_transaction

object

required

payment_method

object

required

bill_affiliates

array of objects

Lista de participantes da fatura. Este campo é exclusivo para transaçõesque contenham participantes ativos. Os participantes dividem o valorda fatura com a empresa

bill_affiliates

object

affiliate_id

int32

ID do participante

amount

number

Valor da fatura

amount_type

int32

Tipo de valor da fatura

customer

object

int32

required

ID do cliente

name

string

required

Nome do cliente

string

E-mail do cliente

code

string

Código opcional para referência via API

period

object

int32

required

ID do período

billing_at

string

Data para geração automática da cobrança do período

cycle

int32

required

Ciclo do período

start_at

string

required

Data e hora do início do período

end_at

string

required

Data e hora do término do período

duration

int32

required

Duração do período em número de segundos

subscription

object

int32

required

ID da assinatura

code

string

Código externo para referência via API

plan

object

required

customer

object

required

metadata

object

Metadados da fatura

payment_profile

object

int32

required

ID do perfil de pagamento

holder_name

string

Nome do titular/portador do perfil de pagamento

registry_code

string

CPF ou CNPJ do titular/portador

bank_branch

string

Agência da conta bancária

bank_account

string

Número da conta bancária

card_expiration

string

Validade do cartão de crédito no formato MM/AA

allow_as_fallback

string

Permite utilizar o perfil de pagamento em retentativas de cobranças não pagas.

card_number_first_six

string

Primeiros 6 dígitos do cartão de crédito (BIN/IIN)

card_number_last_four

string

Últimos 4 dígitos do cartão de crédito

renewed_card

object

card_renewed_at

string

Data da renovação do cartão de crédito renovado

token

string

required

Token interno para referência do perfil de pagamento

created_at

string

required

Data e hora do cadastro do perfil de pagamento

payment_company

object

required

payment_condition

object

penalty_fee_value

number

required

Valor da multa

penalty_fee_type

string

required

Tipo da multa

daily_fee_value

number

required

Valor dos juros ao dia

daily_fee_type

string

required

Tipo dos juros ao dia

after_due_days

int32

required

Prazo para pagamento após vencimento

payment_condition_discounts

array of objects

required

Desconto de pontualidade

payment_condition_discounts*

object

value

number

required

Valor

value_type

string

required

Tipo

percentage amount

days_before_due

int32

required

Dias antes do vencimento

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://app.vindi.com.br/api/v1/bills/id/charge \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
199
}
1
{
2
  "id": 0,
3
  "code": "string",
4
  "amount": 0,
5
  "installments": 0,
6
  "status": "review",
7
  "seen_at": "string",
8
  "billing_at": "string",
9
  "due_at": "string",
10
  "url": "string",
11
  "created_at": "string",
12
  "updated_at": "string",
13
  "bill_items": [
14
    {
15
      "id": 0,
16
      "amount": 0,
17
      "quantity": 0,
18
      "pricing_range_id": 0,
19
      "description": "string",
20
      "pricing_schema": {
21
        "id": "string",
22
        "short_format": "string",
23
        "price": 0,
24
        "minimum_price": 0,
25
        "schema_type": "flat",

200Fatura antecipada com sucesso.

400Erro de sintaxe JSON no corpo do request.

404Fatura não encontrada.

422Parâmetros inválidos. Verificar erro na resposta.