Pular para o conteúdo principal

Status das Transações

Esta página apresenta a lista de todos os possíveis status das transações da API Cobranças Efí.


O fluxo de Transações da Efí funciona da seguinte forma:

banner

Fluxo de transações Efí- API


TRANSAÇÕES (BOLETO BANCÁRIO E CARTÃO DE CRÉDITO)

A seguir, confira a tabela contendo a relação de todos os possíveis status de uma transação:

StatusDescrição
new Cobrança gerada, aguardando definição da forma de pagamento. O termo "new" equivale a "novo".
waiting Forma de pagamento selecionada, aguardando a confirmação do pagamento. O termo "waiting" equivale a "aguardando".
identified Pagamento identificado. O termo "identified" equivale a "identificado". Indica que o pagamento foi efetuado antes do dinheiro ser creditado.
approved Pagamento aprovado. O termo "approved" equivale a "aprovado". Indica que o pagamento foi aprovado pela operadora do cartão mas ainda não foi creditado.
paid Pagamento confirmado. O termo "paid" equivale a "pago".
unpaid Não foi possível confirmar o pagamento da cobrança. O termo "unpaid" equivale a "não pago".
refunded Pagamento devolvido pelo lojista ou pelo intermediador Efí. O termo "refunded" equivale a "devolvido".
contested Pagamento em processo de contestação. O termo "contested" equivale a "contestado".
canceled Cobrança cancelada pelo vendedor ou pelo pagador. O termo "canceled" equivale a "cancelado".
settled Cobrança foi confirmada manualmente. O termo "settled" equivale a "marcar como pago".
link Status aplicável a Link de Pagamento. Este status indica que trata-se de uma cobrança que está associada a um link de pagamento. O termo "link" equivale a "link".
expired Status aplicável a Link de Pagamento. Um link de pagamento receberá este status ao atingir a data de vencimento definida no campo expire_at ao consumir o endpoint /charge/:id/link. O termo "expired" equivale a "expirado".

ASSINATURAS

A seguir, confira a tabela contendo a relação de todos os possíveis status de uma assinatura:

StatusDescrição
new Assinatura criada, porém nenhuma cobrança foi paga. O termo "new" equivale a "nova".
active Assinatura ativa. Todas as cobranças estão sendo geradas. O termo "active" equivale a "ativa".
new_charge Assinatura ativa e gerando novas transações. O termo "new_charge" aparece sempre que uma nova cobranças da assinatura é criada.
canceled Assinatura foi cancelada pelo vendedor ou pelo pagador. O termo "canceled" equivale a "cancelada".
expired Assinatura expirada. Todas as cobranças configuradas para a assinatura já foram emitidas. O termo "expired" equivale a "expirada".

CARNÊS

A seguir, confira a tabela contendo a relação de todos os possíveis status de um carnê:

StatusDescrição
up_to_date Carnê encontra-se em dia, não há nenhuma parcela inadimplente. Assim que o carnê é criado, ele também recebe este status up_to_date. O termo "up_to_date" equivale a "em dia".
unpaid Carnê encontra-se inadimplente. Se identificarmos a inadimplência de pelo menos uma parcela, o status do carnê é alterado para unpaid. O termo "unpaid" equivale a "não pago".
finished Carnê está finalizado, ou seja, todas as parcelas foram resolvidas e possuem um status final. A partir desse momento, o status do carnê nunca mais muda. O termo "finished" equivale a "finalizado".

Cobranças resolvidas

Por cobrança resolvida, entende-se que é toda cobrança que atingiu um status final. Ela não sai mais desse status a não ser para outro status também final. São eles:

  • paid
  • contested
  • refunded
  • settled
  • canceled