Skip to main content

Statuses

The Merchant API uses three sets of statuses: transaction statuses for payouts, transfers, and other transactions; payment statuses for orders paid through crypto invoices; and invoice statuses that describe a crypto payment in more detail.

Transaction statuses​

Returned by Get transaction and Get transaction history.

StatusMeaningFinal
CREATEDThe transaction has been created.No
READY_TO_PROCESSThe transaction is ready for processing.No
PENDINGThe transaction is waiting for an action or a check.No
PROCESSINGThe transaction is being processed.No
EXCHANGINGCurrency conversion is in progress.No
COMPLETEDThe transaction has been completed.Yes
CANCELLINGCancellation is in progress.No
CANCELEDThe transaction has been canceled.Yes
REFUNDINGA refund is in progress.No
REFUNDEDThe transaction has been refunded.Yes

Treat a payout as completed only when its status is COMPLETED. Keep tracking a transaction until it reaches a final status.

A final status can still change if a refund is made later: a COMPLETED transaction then moves to REFUNDING and REFUNDED.

Payment statuses​

Returned in paymentStatus by Get payment order.

StatusMeaningRecommended action
CREATEDThe invoice is created. Volet.com has not finished processing a payment for it.Keep the order pending.
PROCESSINGVolet.com is processing the payment.Keep the order pending.
COMPLETEDThe payment is completed, and the funds are credited to your account. Final status.Mark the order as paid and fulfill it.
FAILEDThe payment failed or its transaction was canceled. Final status.Do not fulfill the order.

paymentStatus has no value for refunds. A refund shows in transaction.status and invoice.invoiceStatus.

When the invoice expires, paymentStatus does not change to FAILED by itself: a customer can still send a payment after the expiration time.

Invoice statuses​

Returned in invoice.invoiceStatus by Get payment order. Use them to explain a problem payment, not to decide whether the order is paid.

StatusMeaning
NEWThe invoice is created, and no payment has been received yet.
RECEIVEDA blockchain transaction for the invoice is received. Checks can still be running, so the funds are not credited yet.
EXCHANGINGVolet.com is converting the received crypto to the receiver currency.
COMPLETEDThe invoice is processed, and the funds are credited to your account.
REFUND_CONFIRMATIONA refund of the payment is waiting for confirmation.
REFUND_REQUESTEDA refund is requested.
REFUNDEDThe payment is returned to the customer.
CLOSEDThe invoice is closed.

invoice.penalties lists how the received payment differs from the invoice. It is empty when the payment matches:

  • UNDERPAYMENT — the customer sent less than senderAmount.
  • OVERPAYMENT — the customer sent more than senderAmount. A small overpayment within the allowed tolerance is not flagged.
  • EXPIRED — the payment arrived after the invoice expired. Such a payment is not credited automatically.

invoice.externalStatus combines invoiceStatus and penalties into one value, for example UNDERPAYMENT_RECEIVED or EXPIRED_PAYMENT_REFUNDED. PAYMENT_RECEIVED does not mean that the funds are credited. Use externalStatus for display only.