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.
| Status | Significado | Final |
|---|---|---|
CREATED | A transação foi criada. | Não |
READY_TO_PROCESS | A transação está pronta para processamento. | Não |
PENDING | A transação aguarda uma ação ou uma verificação. | Não |
PROCESSING | A transação está sendo processada. | Não |
EXCHANGING | A conversão de moeda está em andamento. | Não |
COMPLETED | A transação foi concluída. | Sim |
CANCELLING | O cancelamento está em andamento. | Não |
CANCELED | A transação foi cancelada. | Sim |
REFUNDING | O reembolso está em andamento. | Não |
REFUNDED | A 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.
| Status | Significado | Ação recomendada |
|---|---|---|
CREATED | A fatura foi criada. A Volet.com ainda não terminou de processar um pagamento para ela. | Mantenha o pedido pendente. |
PROCESSING | A Volet.com está processando o pagamento. | Mantenha o pedido pendente. |
COMPLETED | O pagamento foi concluído e os fundos foram creditados na sua conta. Status final. | Marque o pedido como pago e entregue-o. |
FAILED | O 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.
| Status | Significado |
|---|---|
NEW | A fatura foi criada e nenhum pagamento foi recebido ainda. |
RECEIVED | Uma 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. |
EXCHANGING | A Volet.com está convertendo as criptomoedas recebidas para a moeda do recebedor. |
COMPLETED | A fatura foi processada e os fundos foram creditados na sua conta. |
REFUND_CONFIRMATION | Um reembolso do pagamento aguarda confirmação. |
REFUND_REQUESTED | Um reembolso foi solicitado. |
REFUNDED | O pagamento foi devolvido ao cliente. |
CLOSED | A 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 quesenderAmount.OVERPAYMENT— o cliente enviou mais quesenderAmount. 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.
Relacionados
- Erros — formato dos erros e como tratá-los
- Integração por API para receber pagamentos — o fluxo de pagamento completo
- Integração por API para pagamentos em massa — o fluxo de pagamentos completo