# ENUM descriptions

**Invoice state**

| ENUM value                 | Description                                                                                                                                                                                                                     |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| PENDING\_PAYMENT           | <p>• A new unpaid invoice.<br>• Client has transferred funds, but the funds has not yet been credited to the account.</p>                                                                                                       |
| MEM\_POOL\_FOUND           | Incoming transaction to invoice wallet is found in blockchain mempool.                                                                                                                                                          |
| PAID                       | Invoice is paid.                                                                                                                                                                                                                |
| PENDING\_INTERVENTION      | <p>• Intervention from the merchant is awaited.<br>• Client transferred insufficient amount.<br>• Client has transferred an amount exceeding an invoice amount.<br>• Funds were transferred from different client accounts.</p> |
| COMPLETED                  | Funds are transferred to merchant wallet.                                                                                                                                                                                       |
| ARCHIVED                   | Invoice is deleted by merchant.                                                                                                                                                                                                 |
| PENDING\_COMPLIANCE\_CHECK | Invoice is being reviewed by compliance                                                                                                                                                                                         |
| DECLINED                   | Invoice has been suspended due to compliance policy                                                                                                                                                                             |

**Invoice type**

| ENUM value        | Description                                                                                                     |
| ----------------- | --------------------------------------------------------------------------------------------------------------- |
| SINGLE            | allows to receive one payment in crypto-currency                                                                |
| SINGLE\_FIAT      | allows to receive one payment in crypto-currency but amount to pay is set in fiat currency                      |
| BOUND             | allows to receive payment in crypto-currency with any amount but not less than configured while creation        |
| UNLIMITED         | allows to receive unlimited amount of payments in crypto-currency                                               |
| UNLIMITED\_LINKED | allows to receive unlimited amount of payments in crypto-currency but only from one client using payment widget |

**Payment widget type**

| ENUM value        | Description                                                             |
| ----------------- | ----------------------------------------------------------------------- |
| SINGLE\_FIAT      | Creates SINGLE\_FIAT invoices for one payment in fiat currency          |
| UNLIMITED\_LINKED | Creates UNLIMITED\_LINKED invoices for many payments in crypto-currency |

**Payment widget state**

| ENUM value   | Description                                                   |
| ------------ | ------------------------------------------------------------- |
| IN\_PROGRESS | The payment widget has been created and is active             |
| COMPLETED    | The invoice created from payment widget has been payed        |
| ARCHIVED     | The payment widget has expired and was automatically archived |

**Payout state**

| ENUM value             | Description                                                                                                                                                                                                                                                     |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CREATION\_IN\_PROGRESS | Payout started creation (only for mass payouts)                                                                                                                                                                                                                 |
| PENDING\_CONFIRMATION  | A payout is created via UI and is awaiting confirmation from other process participants.                                                                                                                                                                        |
| CONFIRMED              | <p>• A payout is created via UI and confirmed by other process participants.<br>• A payout created via API is automatically created with this status.</p>                                                                                                       |
| IN\_PROGRESS           | <p>• Transaction for a payout is created and is awaiting to be sent to the network.<br>• Transaction for a payout is sent to the network to be sent to a block and is awaiting confirmation from nodes.</p>                                                     |
| COMPLETED              | Funds are successfully credited to destination wallet.                                                                                                                                                                                                          |
| FAILED                 | <p>An error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps:<br><br>1. Wait a while and create a new similar payout.<br>2. Contact our <a href="https://t.me/calypsosup">technical support</a>.</p> |
| CANCELED               | A payout has been canceled by merchant.                                                                                                                                                                                                                         |

**Payout withdrawal state**

| ENUM value   |
| ------------ |
| DRAFT        |
| IN\_PROGRESS |
| COMPLETED    |
| REPLACED     |
| FAILED       |
| CANCELED     |

**Withdrawal error state**

| ENUM value         | Description                               |
| ------------------ | ----------------------------------------- |
| SUCCESS            | The error was resolved                    |
| NO\_PERMISSION     | No permission for operation               |
| NOT\_ENOUGH\_FUNDS | Not enough funds for operation processing |
| EXCEEDING\_LIMIT   | Limits for operation was exceeded         |

**notificationServiceTypes**

| ENUM value |
| ---------- |
| PAYOUT     |
| INVOICE    |

**sort**

| ENUM value |
| ---------- |
| ASC        |
| DESC       |