com.bitpay.sdk.model.invoice.InvoiceStatus Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bitpay_sdk Show documentation
Show all versions of bitpay_sdk Show documentation
Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically
Secure RESTful API.
/*
* Copyright (c) 2019 BitPay.
* All rights reserved.
*/
package com.bitpay.sdk.model.invoice;
/**
* The type Invoice status.
*
* @see REST API Invoices
*/
public class InvoiceStatus {
/**
* An invoice starts in this state. When in this state and only in this state, payments broadcasted by purchasers
* be applied to the invoice (there is a 15 minute window for the purchaser to send a payment from
* their crypto wallet). If an invoice has received a partial payment,
* it will still reflect a status of new to the merchant. From a merchant system perspective,
* an invoice is either paid or not paid, partial payments are automatically refunded by BitPay to the consumer.
*/
public static final String New = "new";
/**
* As soon as payment is received it is evaluated against the invoice requested amount.
* If the amount paid is equal to or greater than the amount expected then the invoice is marked as being paid.
* To detect whether the invoice has been overpaid consult the invoice exception status (exceptionStatus parameter).
* The overpaid amount on an invoice is automatically refunded by BitPay to the consumer.
*/
public static final String Paid = "paid";
/**
* This status can be used by merchants in order to fulfill orders placed by the consumer.
* Merchants can configure the timing at which BitPay sets this specific invoice status,
* depending on the number of confirmation achieved by the consumer's transaction in the selected cryptocurrency.
* This can be configured during invoice creation using
* the "transactionSpeed" parameter (section Create an invoice),
* or at account level via a dashboard setting.
*/
public static final String Confirmed = "confirmed";
/**
* When an invoice has the status complete, it means that BitPay has credited the merchant account,
* in the currency indicated in the settlement settings. For instance, with invoices paid in Bitcoin (BTC),
* 6 confirmation blocks on the bitcoin network are required for an invoice to be complete,
* this takes on average 1 hour.
*/
public static final String Complete = "complete";
/**
* An invoice reaches the expired status if no payment was received and the 15 minute payment window has elapsed.
*/
public static final String Expired = "expired";
/**
* An invoice is considered invalid when it was paid,
* but the corresponding cryptocurrency transaction was not confirmed within 1 hour on the corresponding blockchain.
* It is possible that some transactions can take longer than 1 hour to be included in a block.
* If the transaction confirms after 1 hour, BitPay will update the invoice state from "invalid" to "complete"
* (6 confirmations for transactions on the bitcoin network for instance).
*/
public static final String Invalid = "invalid";
/**
* The constant Declined.
*/
public static final String Declined = "declined";
}