Skip to main content

ENUM descriptions

Overview​

This page describes common enum values used across Calypso API requests, responses, and webhooks.

For product-specific statuses, also check the relevant guide, because some flows include additional business rules and recommended merchant actions.

Invoice state​

ENUM valueDescription
PENDING_PAYMENTInvoice has been created and is waiting for payment.
MEM_POOL_FOUNDIncoming transaction to the invoice wallet was found in the blockchain mempool.
PAIDInvoice payment was received.
PENDING_INTERVENTIONInvoice requires merchant intervention, for example because of underpayment, overpayment, or payment from different sender addresses.
COMPLETEDFunds were transferred to the merchant account.
CANCELInvoice was canceled.
ARCHIVEDInvoice was archived by the merchant or by the system.
PENDING_COMPLIANCE_CHECKInvoice is being reviewed by compliance.
DECLINEDInvoice was declined due to compliance policy.
REVERSEDInvoice payment was reversed.

Invoice type​

ENUM valueDescription
SINGLEOne-time invoice with the amount set in cryptocurrency.
SINGLE_FIATOne-time invoice with the amount set in fiat currency and paid in cryptocurrency.
BOUNDOne-time invoice without a fixed amount, but with a configured minimum amount.
UNLIMITEDInvoice that can receive multiple payments in one cryptocurrency.
UNLIMITED_LINKEDInvoice that can receive multiple payments from one client using a payment widget.

Payment widget type​

ENUM valueDescription
SINGLE_FIATWidget that creates one-time invoices with the amount set in fiat currency.
UNLIMITED_LINKEDWidget that creates invoices for multiple cryptocurrency payments.

Payment widget state​

ENUM valueDescription
IN_PROGRESSPayment widget has been created and is active.
COMPLETEDInvoice created from the payment widget was paid.
ARCHIVEDPayment widget expired or was archived.

Payout state​

ENUM valueDescription
CREATION_IN_PROGRESSPayout creation has started.
PENDING_CONFIRMATIONPayout is waiting for confirmation from required process participants.
CONFIRMEDPayout was confirmed and is ready for processing.
IN_PROGRESSPayout transaction is being created, sent to the network, or waiting for network confirmation.
WAITING_COMPLETION_ERRORSPayout is waiting for completion after processing errors.
PARTIALPayout was partially completed.
COMPLETEDFunds were successfully credited to the destination wallet.
FAILEDPayout failed during validation or processing.
CANCELEDPayout was canceled by the merchant.

Payout withdrawal state​

ENUM valueDescription
DRAFTWithdrawal was created but processing has not started.
IN_PROGRESSWithdrawal is being processed.
COMPLETEDWithdrawal was completed successfully.
REPLACEDWithdrawal was replaced by another transaction.
FAILEDWithdrawal failed.
CANCELEDWithdrawal was canceled.

Withdrawal error state​

ENUM valueDescription
SUCCESSError was resolved.
NOT_ENOUGH_FUNDSAccount balance is not enough for the operation.
NOT_ENOUGH_FUNDS_FOR_COMMISSIONAccount balance is not enough to pay the commission.
NOT_ENOUGH_FUNDS_FOR_SERVICE_COMMISSIONAccount balance is not enough to pay the service commission.
EXCEEDING_LIMITOperation limit was exceeded.

Notification service types​

ENUM valueDescription
PAYOUTPayout events.
SETTLEMENT_PAYOUTSettlement payout events.
SETTLEMENT_ADAPTERSettlement adapter transfer events.
SETTLEMENT_WALLETSettlement wallet events.
WALLETAccount top-up and wallet events.
INVOICEInvoice events.
C2C_LIQUIDITYC2C liquidity exchange events.
CUSTOMER_PURSECustomer purse events.
CRYPTO_TO_CRYPTOCrypto-to-crypto order events.
CRYPTO_TO_FIATCrypto-to-fiat order events.
BUSINESS_WALLETBusiness wallet events.
SYSTEMSystem notification events.
LIQUIDITYLiquidity notification events.
RECURRENTRecurrent payment events.
PAYMENT_WIDGETPayment widget events.

Sort direction​

ENUM valueDescription
ASCSort results in ascending order.
DESCSort results in descending order.
DocumentLink
Currencies & BlockchainsCurrencies & Blockchains
Operation code typesOperation code types (OPCODE)