Pular para o conteúdo principal

Status

A Merchant API usa três conjuntos de status: status de transações para pagamentos, transferências e outras transações; status de pagamentos para pedidos pagos com faturas cripto; e status de faturas, que descrevem um pagamento cripto com mais detalhes.

Status das transações​

Retornados por Consulta de transação e Consulta do histórico de transações.

StatusSignificadoFinal
CREATEDA transação foi criada.Não
READY_TO_PROCESSA transação está pronta para processamento.Não
PENDINGA transação aguarda uma ação ou uma verificação.Não
PROCESSINGA transação está sendo processada.Não
EXCHANGINGA conversão de moeda está em andamento.Não
COMPLETEDA transação foi concluída.Sim
CANCELLINGO cancelamento está em andamento.Não
CANCELEDA transação foi cancelada.Sim
REFUNDINGO reembolso está em andamento.Não
REFUNDEDA transação foi reembolsada.Sim

Considere um pagamento concluído somente quando o status for COMPLETED. Acompanhe a transação até ela chegar a um status final.

Um status final ainda pode mudar se um reembolso for feito depois: uma transação COMPLETED passa então para REFUNDING e REFUNDED.

Status dos pagamentos​

Retornados em paymentStatus por Consulta de pedido de pagamento.

StatusSignificadoAção recomendada
CREATEDA fatura foi criada. A Volet.com ainda não terminou de processar um pagamento para ela.Mantenha o pedido pendente.
PROCESSINGA Volet.com está processando o pagamento.Mantenha o pedido pendente.
COMPLETEDO pagamento foi concluído e os fundos foram creditados na sua conta. Status final.Marque o pedido como pago e entregue-o.
FAILEDO pagamento falhou ou a transação dele foi cancelada. Status final.Não entregue o pedido.

paymentStatus não tem um valor para reembolsos. Um reembolso aparece em transaction.status e em invoice.invoiceStatus.

Quando a fatura expira, paymentStatus não muda para FAILED sozinho: o cliente ainda pode enviar um pagamento depois do prazo.

Status das faturas​

Retornados em invoice.invoiceStatus por Consulta de pedido de pagamento. Use-os para explicar um pagamento com problema, não para decidir se o pedido está pago.

StatusSignificado
NEWA fatura foi criada e nenhum pagamento foi recebido ainda.
RECEIVEDUma transação da blockchain para a fatura foi recebida. As verificações ainda podem estar em andamento, então os fundos ainda não foram creditados.
EXCHANGINGA Volet.com está convertendo as criptomoedas recebidas para a moeda do recebedor.
COMPLETEDA fatura foi processada e os fundos foram creditados na sua conta.
REFUND_CONFIRMATIONUm reembolso do pagamento aguarda confirmação.
REFUND_REQUESTEDUm reembolso foi solicitado.
REFUNDEDO pagamento foi devolvido ao cliente.
CLOSEDA fatura foi encerrada.

invoice.penalties mostra em que o pagamento recebido difere da fatura. A lista fica vazia quando o pagamento corresponde à fatura:

  • UNDERPAYMENT — o cliente enviou menos que senderAmount.
  • OVERPAYMENT — o cliente enviou mais que senderAmount. Um pagamento a maior pequeno, dentro da tolerância permitida, não é sinalizado.
  • EXPIRED — o pagamento chegou depois que a fatura expirou. Esse pagamento não é creditado automaticamente.

invoice.externalStatus combina invoiceStatus e penalties em um único valor, por exemplo UNDERPAYMENT_RECEIVED ou EXPIRED_PAYMENT_REFUNDED. PAYMENT_RECEIVED não significa que os fundos foram creditados. Use externalStatus apenas para exibição.