v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB

charges

Retorna uma lista de cobranças.

Utilize este método para listar as cobranças associadas à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.

Atributos para busca

<code>id</code>, <code>customer_id</code>, <code>bill_id</code>, <code>amount</code>, <code>payment_method_id</code>, <code>due_at</code>, <code>paid_at</code>, <code>installments</code>, <code>attempt_count</code>, <code>next_attempt</code>, <code>status</code>, <code>created_at</code> e <code>updated_at</code>.

get/v1/charges

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'created_at' | 'updated_at' | 'due_at' | 'paid_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da cobrança

amountnumber required

Valor da cobrança

status'pending' | 'paid' | 'canceled' | 'processing' | 'fraud_review' required

Status da cobrança

due_atstring required

Data do vencimento da cobrança

paid_atstring

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

installmentsinteger 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_countinteger

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

next_attemptinteger

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

print_urlstring

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

created_atstring required

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

updated_atstring required

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