PayZu GatewayCobranças

Consultar faturas


Nesta páginaConsulte a faturaStatus da tentativaListe as faturasErros desta operação

Confira o status e as tentativas de uma fatura, ou liste as faturas para conciliar as vendas e os ciclos de assinatura.

Consulte a fatura

bash
curl "https://api.sandbox.payzu.dev/v1/invoices/in_7Kd2QmXvB9LtYc4WnRz8Hs" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Consultar uma fatura

CampoO que traz
urlA página de pagamento da fatura. Vem em toda fatura e não muda nem vence.
amountssubtotal é o valor cheio, discount o desconto e total o valor a pagar. paid soma tudo o que entrou e refunded tudo o que foi devolvido, em centavos.
billingO vencimento (due_at), o limite para pagar (expires_at) e a data de cada mudança de status. cycle_number é o ciclo da assinatura, com a adesão no ciclo 0.
customerO cliente da fatura. Vem null na fatura criada sem cliente, até a primeira tentativa na página.
subscription, payment_linkDe onde a fatura veio: a assinatura ou a compra pelo link de pagamento.
paymentsAs tentativas de pagamento, da mais nova para a mais antiga. payments[0] é a última.
refundsOs estornos, com status requested, confirmed ou failed.
cancellationNa fatura canceled, o motivo em reason (merchant_request ou subscription_cancellation) e a sua note.
chargebackNa fatura contestada, o id e o status da contestação, como em Consultar uma contestação.

Status da tentativa

StatusO que significa
pendingPix aguardando pagamento, com o QR Code em pix.
processingCartão ou Pix sem resposta da adquirente. No Pix, passa a pending, com o QR Code, quando a cobrança aparece.
paidPaga.
failedRecusada, com o motivo em failure.
expiredO QR Code do Pix venceu sem pagamento.
refund_requestedEstorno pedido e ainda não confirmado.
refundedEstornada.
chargedbackContestada.

Um pagamento confirmado numa fatura que já estava paga é devolvido sozinho: a tentativa passa a refunded, o estorno entra em refunds, e o status da fatura não muda. Veja Pagamento em duplicidade. Os status da fatura estão em Cobranças.

Liste as faturas

bash
curl "https://api.sandbox.payzu.dev/v1/invoices?customer_id=cus_bdQT0ls1QMIXVuhngvhbwC&status=paid" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Listar as faturas

A lista traz items e next_cursor, da fatura mais nova para a mais antiga, com cada item igual à consulta, inclusive payments e refunds. A paginação é por cursor, como em Paginação.

FiltroO que traz
statusAs faturas nesse status.
payment_methodAs faturas cuja última tentativa foi nesse meio.
customer_id, subscription_id, payment_link_idAs faturas do cliente, da assinatura ou do link de pagamento.
external_referenceAs faturas com essa referência.
searchBusca na descrição, na referência, no código da assinatura e no nome, no e-mail ou no documento do cliente.
due_from, due_toO dia do vencimento.
paid_from, paid_toO dia do pagamento.
created_from, created_toO dia da criação.
updated_fromAs faturas alteradas a partir desse dia.

Os dias vão no formato AAAA-MM-DD, no fuso de São Paulo. Na fatura em aberto, updated_at muda a cada tentativa, por isso updated_from serve para sincronizar o seu sistema.

Erros desta operação

CódigoHTTPMensagem
-404Fatura não encontrada para o id informado.

Os erros de autenticação e de validação estão no Catálogo de erros.