> For the complete documentation index, see [llms.txt](https://docs.calypso.money/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.calypso.money/get-started-with-calypso-api/enum-descriptions.md). # ENUM descriptions **Invoice state** | ENUM value | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | PENDING\_PAYMENT |

• A new unpaid invoice.
• Client has transferred funds, but the funds has not yet been credited to the account.

| | MEM\_POOL\_FOUND | Incoming transaction to invoice wallet is found in blockchain mempool. | | PAID | Invoice is paid. | | PENDING\_INTERVENTION |

• Intervention from the merchant is awaited.
• Client transferred insufficient amount.
• Client has transferred an amount exceeding an invoice amount.
• Funds were transferred from different client accounts.

| | 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 |

• A payout is created via UI and confirmed by other process participants.
• A payout created via API is automatically created with this status.

| | IN\_PROGRESS |

• Transaction for a payout is created and is awaiting to be sent to the network.
• Transaction for a payout is sent to the network to be sent to a block and is awaiting confirmation from nodes.

| | COMPLETED | Funds are successfully credited to destination wallet. | | FAILED |

An error occurred when sending funds. There can be many reasons of the error. You may follow these remediation steps:

1. Wait a while and create a new similar payout.
2. Contact our technical support.

| | 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 | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.calypso.money/get-started-with-calypso-api/enum-descriptions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.