Status
Invoice status can have the following values:
"New": This is the initial state of an invoice, applicable across all payment methods including crypto currencies, cards, and APMs (e.g., Skrill, Neteller). For crypto currency payments, there is a default 20 minutes window for the buyer to send the payment from their wallet. If a partial payment is received within this window, the invoice will remain in the "New" state. For card and APM payments, this status reflects that the payment process has been initiated but not yet completed.
"Paid": This status indicates that the payment has been successfully received and evaluated against the invoice amount. If the total amount paid is equal to or greater than the expected amount, the invoice is marked as "Paid." For digital currency payments, overpayments can be identified by consulting the invoice exception status (error_status parameter). For card and APM transactions, "Paid" confirms that the payment has been fully processed, including both authorization and capture, but the funds may still be pending final settlement to the merchant’s account based on the payment method's settlement timeline.
"Confirmed": This status signifies that the payment has been validated and is ready for order fulfillment by the merchant. For digital currency payments, the status depends on the number of blockchain confirmations, configurable during invoice creation via the "confirm_speed" parameter or at the account level. For card and APM transactions, this status indicates that the payment has passed fraud and risk checks, ensuring its legitimacy.
"Complete": This status indicates that the payment process is fully finalized, and UniPayment has credited the merchant's account. For digital currency payments, this typically requires a predefined number of blockchain confirmations (e.g., 3 confirmations for Bitcoin, which takes approximately 1 hour). For card and APM transactions, this status reflects that the funds have been successfully settled and are available for the merchant.
"Expired": This status is applied when the payment window has elapsed without receiving a payment. For digital currency payments, the default window is 20 minutes. For card and APM transactions, this status indicates that the payment was not completed within the allowed timeframe or the session was abandoned by the user. The invoice is no longer valid and cannot be paid without generating a new one.
"Invalid": This status indicates that the payment was initiated and processed but encountered an exception during the settlement phase, rendering the transaction incomplete or unrecognized for final crediting.
For cryptocurrency payments:
The invoice is marked as "Invalid" if the transaction was broadcast but failed to meet the required number of blockchain confirmations within the expected timeframe. Network delays or insufficient fees might cause such failures. If the transaction is later confirmed, the status can be updated to "Complete."
For card payments:
This status applies when the payment was authorized and captured but encountered an issue during settlement. Common causes include fraud and risk checks or technical errors in the settlement process. The funds were not successfully credited to the merchant's account.
For APM payments:
"Invalid" reflects that the payment was successfully initiated but failed during settlement due to reasons such as account restrictions, provider errors, or compliance checks. The payment remains uncompleted from the provider's side.
ErrorStatus
Initially a string None, this parameter will indicate if the buyer sent too much ("PaidOver") or not enough funds ("PaidPartial") in the transaction to pay the UnPayment invoice.
Possible values are:
"None": default value unless an exception is triggered.
"PaidPartial": if the consumer did not send enough funds when paying the invoice.
"PaidOver": if the consumer sent too much funds when paying the invoice.
"PaidLater": if the consumer pay the invoice after invoice is expired.
"Marked": if the invoice is marked by operator.